The Mimecast secure id of the Address Alteration policy to be modified
addressAlterationSetId
String
Required
The Mimecast secure id of the Address Alteration Set (folder) that will be applied by this policy
policy
Policy Details Object
Required
An object of conditions that determine when to apply the alteration set
Policy Details Object
Field
Type
Required
Description
enforced
Boolean
Optional
Determines if the policy should be enforced. Default value is false.
bidirectional
String
Optional
If true, will also apply the policy in reverse email flow of the defined by this policy. Default value is false.
toDate
Date String
Optional
The end date that the policy should cease to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). If defined, this will override the toEternal value to false.
description
String
Optional
The description for the policy, which will also be stored with any applied message in the archive for future reference
toEternal
Boolean
Optional
If set to true, the policy will have no end date applied. Default value is true.
enabled
Boolean
Optional
If set to true, the policy will apply to an messages within the policy scope. Default value is true.
fromDate
Date String
Optional
The start date that the policy should begin to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). If defined, this will override the fromEternal value to false.
fromPart
String
Optional
Specifies that the from address should be considered based on the envelope, header or either address. Possible values are: envelope_from, header_from or both. Default value is envelope_from.
fromEternal
Boolean
Optional
If set to true, the policy will apply as soon as it is created and enabled. Default value is true.
from
Policy Target Object
Optional
Scope of application based on the sender address. If not specified, the default will apply to everyone.
comment
String
Optional
A comment about the policy
to
Policy Target Object
Optional
Scope of application based on the recipient address. If not specified, the default will apply to everyone.
override
Boolean
Optional
If set to true, this policy will be considered for application prior to other policies of the same type. If the override is enabled and this policy scope applies it policy will be applied, and any other policies of this type will be ignored. Default value is false.
conditions
Policy Conditions Object
Optional
Conditions of the sending platform to determine if the policy should be considered
Policy Target Object
Field
Type
Required
Description
emailAddress
String
Optional
The email address to apply the policy based on, when type is set to individual_email_address
emailDomain
String
Optional
The email domain to apply the policy based on, when type is set to email_domain
groupId
String
Optional
The Mimecast secure id of a group (Directory or Profile group) to apply the policy based on, when type is set to profile_group
attribute
Attribute Object
Optional
The address object attribute to apply this policy based on, when type is set to address_attribute_value
type
String
Optional
The component of the address object that this policy should be scoped. Possible values are: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address or free_mail_domains. Default value is everyone.
Attribute Object
Field
Type
Required
Description
name
String
Optional
The name of the user address attribute to compare value
id
String
Optional
The Mimecast secure id of the user address attribute
value
String
Optional
The value to which the user address attribute should equal
Policy Conditions Object
Field
Type
Required
Description
sourceIPs
Array of Strings
Optional
An array of sender IP ranges in CIDR notation that this policy will be considered based on. If no IP ranges are provided, this policy will be considered when recived from any IP address.
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.