Mimecast

Create Address Alteration Policy

Description

This API endpoint can be used to create new Address Alteration policy to apply an alteration defintion based on sender and recipient values.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Gateway | Policies | Edit permission.

URI

To use this endpont you send a POST request to:

  • /api/policy/address-alteration/create-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": [
  {
   "policy": [
    {
     "fromEternal": "true", 
     "comment": "String", 
     "enforced": "true", 
     "description": "String", 
     "fromDate": "Date String", 
     "bidirectional": "false", 
     "toEternal": "true", 
     "fromPart": "String", 
     "toDate": "Date String", 
     "from": {
      "attribute": {
       "name": "String", 
       "value": "String", 
       "id": "String"
      }, 
      "type": "String", 
      "emailAddress": "String", 
      "groupId": "String", 
      "emailDomain": "String"
     }, 
     "enabled": "false", 
     "to": {
      "attribute": {
       "name": "String", 
       "value": "String", 
       "id": "String"
      }, 
      "type": "String", 
      "emailAddress": "String", 
      "groupId": "String", 
      "emailDomain": "String"
     }, 
     "override": "False", 
     "conditions": {
      "sourceIPs": [
       "String"
      ]
     }
    }
   ], 
   "addressAlterationSetId": "String"
  }
 ]
}
data
Field Type Required Description
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 Optioneel Determines if the policy should be enforced. Default value is false.
bidirectional String Optioneel If true, will also apply the policy in reverse email flow of the definied by this policy. Default value is false.
toDate Date String Optioneel 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 Optioneel The description for the policy, which will also be stored with any applied message in the archive for future reference
toEternal Boolean Optioneel If set to true, the policy will have no end date applied. Default value is true.
enabled Boolean Optioneel If set to true, the policy will apply to an messages within the policy scope. Default value is true.
fromDate Date String Optioneel 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 Optioneel 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 Optioneel If set to true, the policy will apply as soon as it is created and enabled. Default value is true.
from Policy Target Object Optioneel Scope of application based on the sender address. If not specified, the default will apply to everyone.
comment String Optioneel A comment about the policy
to Policy Target Object Optioneel Scope of application based on the recipient address. If not specified, the default will apply to everyone.
override Boolean Optioneel 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 Optioneel Conditions of the sending platform to determine if the policy should be considered
Policy Target Object
Field Type Required Description
emailAddress String Optioneel The email address to apply the policy based on, when type is set to individual_email_address
emailDomain String Optioneel The email domain to apply the policy based on, when type is set to email_domain
groupId String Optioneel 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 Optioneel The address object attribute to apply this policy based on, when type is set to address_attribute_value
type String Optioneel 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 Optioneel The name of the user address attribute to compare value
id String Optioneel The Mimecast secure id of the user address attribute
value String Optioneel The value to which the user address attribute should equal
Policy Conditions Object
Field Type Required Description
sourceIPs Array of Strings Optioneel 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.

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/create-policy
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json


{
  "data":[
    {
        "addressAlterationSetId": "String",
            "policy": [
                {
                "enforced": "true",
                "bidirectional": "false",
                "toDate": "Date String",
                "description": "String",
                "toEternal": "true",
                "enabled": "false",
                "fromDate": "Date String",
                "fromPart": "String",
                "fromEternal": "true",
                "from": {
                    "emailAddress": "String",
                    "emailDomain": "String",
                    "groupId": "String",
                    "attribute": {
                        "name": "String",
                        "id": "String",
                        "value": "String"
                    },
                    "type": "String"
                },
                "comment": "String",
                "to": {
                    "emailAddress": "String",
                    "emailDomain": "String",
                    "groupId": "String",
                    "attribute": {
                        "name": "String",
                        "id": "String",
                        "value": "String"
                    },
                    "type": "String"
                },
                "override": "False",
                "conditions": {
                    "sourceIPs": [
                        "String"
                    ]
                }
            }
        ]
    }
  ]
}
import base64
import hashlib
import hmac
import uuid
import datetime
import requests

# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/policy/address-alteration/create-policy"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"
app_id = "YOUR APPLICATION ID"
app_key = "YOUR APPLICATION KEY"

# Generate request header values
request_id = str(uuid.uuid4())
hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"

# DataToSign is used in hmac_sha1
dataToSign = ':'.join([hdr_date, request_id, uri, app_key])

# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(base64.b64decode(secret_key), dataToSign.encode(), digestmod=hashlib.sha1).digest()

# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.b64encode(hmac_sha1).rstrip()

# Create request headers
headers = {
    'Authorization': 'MC ' + access_key + ':' + sig.decode(),
    'x-mc-app-id': app_id,
    'x-mc-date': hdr_date,
    'x-mc-req-id': request_id,
    'Content-Type': 'application/json'
}

payload = {
        'data': [
            {
                "addressAlterationSetId": "String",
                "policy": [
                    {
                        "enforced": "true",
                        "bidirectional": "false",
                        "toDate": "Date String",
                        "description": "String",
                        "toEternal": "true",
                        "enabled": "false",
                        "fromDate": "Date String",
                        "fromPart": "String",
                        "fromEternal": "true",
                        "from": {
                            "emailAddress": "String",
                            "emailDomain": "String",
                            "groupId": "String",
                            "attribute": {
                                "name": "String",
                                "id": "String",
                                "value": "String"
                            },
                            "type": "String"
                        },
                        "comment": "String",
                        "to": {
                            "emailAddress": "String",
                            "emailDomain": "String",
                            "groupId": "String",
                            "attribute": {
                                "name": "String",
                                "id": "String",
                                "value": "String"
                            },
                            "type": "String"
                        },
                        "override": "False",
                        "conditions": {
                            "sourceIPs": [
                                "String"
                            ]
                        }
                    }
                ]
            }
        ]
    }

r = requests.post(url=url, headers=headers, data=str(payload))

print(r.text)
static void Main(string[] args)
        {
            //Setup required variables
            string baseUrl = "https://xx-api.mimecast.com";
            string uri = "/api/policy/address-alteration/create-policy";
            string accessKey = "YOUR ACCESS KEY";
            string secretKey = "YOUR SECRET KEY";
            string appId = "YOUR APPLICATION ID";
            string appKey = "YOUR APPLICATION KEY";

            //Generate request header values
            string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
            string requestId = System.Guid.NewGuid().ToString();

            //Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
            System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));

            //Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
            byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));

            //Build the signature to be included in the Authorization header in your request
            string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);

            //Build Request
            System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
            request.Method = "POST";
            request.ContentType = "application/json";

            //Add Headers
            request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
            request.Headers.Add("x-mc-date", hdrDate);
            request.Headers.Add("x-mc-req-id", requestId);
            request.Headers.Add("x-mc-app-id", appId);

            //Add request body
            //Create and write data to stream
            string postData = @"{
                    ""data"": [
                        ""addressAlterationSetId"": ""String"",
                        ""policy"": [
                            {
                                ""enforced"": ""true"",
                                ""bidirectional"": ""false"",
                                ""toDate"": ""Date String"",
                                ""description"": ""String"",
                                ""toEternal"": ""true"",
                                ""enabled"": ""false"",
                                ""fromDate"": ""Date String"",
                                ""fromPart"": ""String"",
                                ""fromEternal"": ""true"",
                                ""from"": {
                                    ""emailAddress"": ""String"",
                                    ""emailDomain"": ""String"",
                                    ""groupId"": ""String"",
                                    ""attribute"": {
                                        ""name"": ""String"",
                                        ""id"": ""String"",
                                        ""value"": ""String""
                                    },
                                    ""type"": ""String""
                                },
                                ""comment"": ""String"",
                                ""to"": {
                                    ""emailAddress"": ""String"",
                                    ""emailDomain"": ""String"",
                                    ""groupId"": ""String"",
                                    ""attribute"": {
                                        ""name"": ""String"",
                                        ""id"": ""String"",
                                        ""value"": ""String""
                                    },
                                    ""type"": ""String""
                                },
                                ""override"": ""False"",
                                ""conditions"": {
                                    ""sourceIPs"": [
                                        ""String""
                                    ]
                                }
                            }
                        ]
                    ]
                }";

            byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);

            System.IO.Stream stream = request.GetRequestStream();
            stream.Write(payload, 0, payload.Length);
            stream.Close();

            //Send Request
            System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();

            //Output response to console
            System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
            string responseBody = "";
            string temp = null;
            while ((temp = reader.ReadLine()) != null)
            {
                responseBody += temp;
            };
            System.Console.WriteLine(responseBody);
            System.Console.ReadLine();
        }
#Setup required variables
$baseUrl = "https://xx-api.mimecast.com"
$uri = "/api/policy/address-alteration/create-policy"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"
$appId = "YOUR APPLICATION ID"
$appKey = "YOUR APPLICATION KEY"

#Generate request header values
$hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
$requestId = [guid]::NewGuid().guid

#Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
$sha = New-Object System.Security.Cryptography.HMACSHA1
$sha.key = [Convert]::FromBase64String($secretKey)
$sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
$sig = [Convert]::ToBase64String($sig)

#Create Headers
$headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
                "x-mc-date" = $hdrDate;
                "x-mc-app-id" = $appId;
                "x-mc-req-id" = $requestId;
                "Content-Type" = "application/json"}

#Create post body
$postBody = "{
                    ""data"": [
                        {
                            ""addressAlterationSetId"": ""String"",
                            ""policy"": [
                                {
                                    ""enforced"": ""true"",
                                    ""bidirectional"": ""false"",
                                    ""toDate"": ""Date String"",
                                    ""description"": ""String"",
                                    ""toEternal"": ""true"",
                                    ""enabled"": ""false"",
                                    ""fromDate"": ""Date String"",
                                    ""fromPart"": ""String"",
                                    ""fromEternal"": ""true"",
                                    ""from"": {
                                        ""emailAddress"": ""String"",
                                        ""emailDomain"": ""String"",
                                        ""groupId"": ""String"",
                                        ""attribute"": {
                                            ""name"": ""String"",
                                            ""id"": ""String"",
                                            ""value"": ""String""
                                        },
                                        ""type"": ""String""
                                    },
                                    ""comment"": ""String"",
                                    ""to"": {
                                        ""emailAddress"": ""String"",
                                        ""emailDomain"": ""String"",
                                        ""groupId"": ""String"",
                                        ""attribute"": {
                                            ""name"": ""String"",
                                            ""id"": ""String"",
                                            ""value"": ""String""
                                        },
                                        ""type"": ""String""
                                    },
                                    ""override"": ""False"",
                                    ""conditions"": {
                                        ""sourceIPs"": [
                                            ""String""
                                        ]
                                    }
                                }
                            ]
                        }
                    ]
                }"

#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url

#Print the response
$response
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {

        //set up variables for request
        String baseUrl = "https://xx-api.mimecast.com";
        String uri = "/api/policy/address-alteration/create-policy";
        String url = "https://" + baseUrl + uri;
        String accessKey = "YOUR ACCESS KEY";
        String secretKey = "YOUR SECRET KEY";
        String appId = "YOUR APPLICATION ID";
        String appKey = "YOUR APPLICATION KEY";

        //create URL object
        java.net.URL obj = new java.net.URL(url);

        // set guid for x-mc-req-id header
        String guid = java.util.UUID.randomUUID().toString();

        // set date for x-mc-date header
        java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
        sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
        String date = sdf.format(new java.util.Date());

        //create signature for the Authorization header
        String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
        String hmacSHA1 = "HmacSHA1";
        javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
        javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
        mac.init(signingKey);
        String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));

        // create request object
        javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();

        //set request type to POST
        con.setRequestMethod("POST");
        con.setDoOutput(true);

        //add reuqest headers
        con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
        con.setRequestProperty("x-mc-req-id", guid);
        con.setRequestProperty("x-mc-app-id", appId);
        con.setRequestProperty("x-mc-date", date);
        con.setRequestProperty("Content-Type", "application/json");
        con.setRequestProperty("Accept", "application/json");

        //Add post body to the request
        String postBody = "{\n" +
        " \"data\": [\n" +
        "     {\n" +
        "         \"addressAlterationSetId\": \"String\",\n" +
        "             \"policy\": [\n" +
        "                 {\n" +
        "                     \"enforced\": \"true\",\n" +
        "                     \"bidirectional\": \"false\",\n" +
        "                     \"toDate\": \"Date String\",\n" +
        "                     \"description\": \"String\",\n" +
        "                     \"toEternal\": \"true\",\n" +
        "                     \"enabled\": \"false\",\n" +
        "                     \"fromDate\": \"Date String\",\n" +
        "                     \"fromPart\": \"String\",\n" +
        "                     \"fromEternal\": \"true\",\n" +
        "                     \"from\": {\n" +
        "                         \"emailAddress\": \"String\",\n" +
        "                         \"emailDomain\": \"String\",\n" +
        "                         \"groupId\": \"String\",\n" +
        "                         \"attribute\": {\n" +
        "                             \"name\": \"String\",\n" +
        "                             \"id\": \"String\",\n" +
        "                             \"value\": \"String\"\n" +
        "                         },\n" +
        "                         \"type\": \"String\"\n" +
        "                     },\n" +
        "                     \"comment\": \"String\",\n" +
        "                     \"to\": {\n" +
        "                         \"emailAddress\": \"String\",\n" +
        "                         \"emailDomain\": \"String\",\n" +
        "                         \"groupId\": \"String\",\n" +
        "                         \"attribute\": {\n" +
        "                             \"name\": \"String\",\n" +
        "                             \"id\": \"String\",\n" +
        "                             \"value\": \"String\"\n" +
        "                         },\n" +
        "                         \"type\": \"String\"\n" +
        "                     },\n" +
        "                     \"override\": \"False\",\n" +
        "                     \"conditions\": {\n" +
        "                         \"sourceIPs\": [\n" +
        "                             \"String\"\n" +
        "                         ]\n" +
        "                     }\n" +
        "                 }\n" +
        "             ]\n" +
        "     }\n" +
        " ]\n" +
        "}";
        java.io.OutputStream os = con.getOutputStream();
        os.write(postBody.getBytes("UTF-8"));
        os.close();

        //process response
        java.io.BufferedReader in = new java.io.BufferedReader(
                new java.io.InputStreamReader(con.getInputStream()));
        String inputLine;
        StringBuffer response = new StringBuffer();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        //return result
        java.lang.System.out.println(response.toString());
    }