This API endpoint can be used to find an existing Address Alteration policy.
Pre-requisites
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Gateway | Policies | Read permission.
URI
To use this endpoint you send a POST request to:
/api/policy/address-alteration/get-policy
Request Headers
The following request headers must be included in your request:
Field
Description
Authorization
Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id
A randomly generated GUID, for example,
8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id
The Application ID provided with your Registered API Application.
x-mc-date
The current date and time in the following format, for example,
Tue, 24 Nov 2015 12:50:11 UTC
Request Body
{
"data": [
{
"id": "String"
}
]
}
data
Field
Type
Required
Description
id
String
Optional
The Mimecast secure id of the policy. If the id field is omitted, all policies will be returned.
Response
{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"policy": [
{
"fromEternal": "true",
"toDate": "Date String",
"enforced": "false",
"from": {
"attribute": {
"name": "String",
"value": "String",
"id": "String"
},
"type": "String",
"emailAddress": "String",
"groupId": "String",
"emailDomain": "String"
},
"description": "String",
"enabled": "false",
"fromValue": "String",
"lastUpdated": "Date String",
"createTime": "Date String",
"fromType": "String",
"to": {
"attribute": {
"name": "String",
"value": "String",
"id": "String"
},
"type": "String",
"emailAddress": "String",
"groupId": "String",
"emailDomain": "String"
},
"fromDate": "Date String",
"override": "false",
"bidirectional": "false",
"toValue": "String",
"toEternal": "true",
"conditions": {
"sourceIPs": [
"String"
]
},
"toType": "String",
"fromPart": "String"
}
],
"addressAlterationSetId": "String",
"id": "String"
}
]
}
meta object
Field
Type
Description
status
Number
The function level status of the request.
meta
Field
Type
Description
status
Number
The function level status of the request.
data
Field
Type
Description
addressAlterationSetId
String
The Mimecast secure id of the Address Alteration Set (folder) that will be applied by this policy
id
String
The Mimecast secure id of the Address Alteration Set (folder) that will be applied by this policy
policy
Policy Details Object
An object of conditions that determine when to apply the alteration set
Policy Details Object
Field
Type
Description
enforced
Boolean
Is the policy enforced
bidirectional
String
Should the policy also apply in reverse email flow of the definied by this policy
toDate
Date String
The end date that the policy should cease to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
description
String
The description for the policy (name)
toEternal
Boolean
Should the policy continue to apply, regardless of the current date and time
enabled
Boolean
Should the policy be considered for emails processing through Mimecast
fromDate
Date String
The start date that the policy should begin to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
fromPart
String
Should the sender address be considered based on the envelope, header or either address
fromEternal
Boolean
Should the policy start to apply, regardless of the current date and time
fromType
String
The component of the sender address object that this policy should be scoped
fromValue
String
The value that the sender address will be compared against
from
Policy Target Object
Scope of application based on the sender address
toType
String
The component of the recipient address object that this policy should be scoped
toValue
String
The value that the recipient address will be compared against
to
Policy Target Object
Scope of application based on the recipient address
override
Boolean
Should the policy be considered for application, and apply if conditions met, prior to other policies of the same type
conditions
Policy Conditions Object
Conditions of the sending platform to determine if the policy should be considered
createTime
Date String
The creation timestamp of the policy in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
lastUpdate
String
The most recent modification timestamp of the policy in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
Policy Target Object
Field
Type
Description
emailAddress
String
The email address to apply the policy based on
emailDomain
String
The email domain to apply the policy based on
groupId
String
The Mimecast secure id of a group (Directory or Profile group) to apply the policy based on
attribute
Attribute Object
The address object attribute to apply this policy based on
type
String
The component of the address object that this policy should be scoped
Attribute Object
Field
Type
Description
name
String
The name of the user address attribute to compare value
id
String
The Mimecast secure id of the user address attribute
value
String
The value to which the user address attribute should equal
Policy Conditions Object
Field
Type
Description
sourceIPs
Array of Strings
An array of sender IP ranges in CIDR notation that this policy will be considered based on
Sample Code
Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE. Please see the Global Base URL's page to find the correct base URL to use for your account.
POST {base_url}/api/policy/address-alteration/get-policy
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}