Mimecast

Get Message Info

Description

This API endpoint can be used to retrieve detailed information about a specific message.

Pre-requisites

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

URI

To use this endpoint you send a POST request to:

  • /api/message-finder/get-message-info

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 Required The Mimecast ID of the message to load. This is returned by the /api/message-finder/search endpoint.

Response

{
 "fail": [], 
 "meta": {
  "status": 200
 }, 
 "data": [
  {
   "status": "String", 
   "retentionInfo": {
    "currentPurgeDate": "Date String", 
    "originalPurgeDate": "String", 
    "retentionAdjustmentDays": -1, 
    "fbrExpireCheck": [], 
    "fbrStamps": [], 
    "audits": [], 
    "litigationHoldInfo": [], 
    "smartTags": [], 
    "purgeBasedOn": "String"
   }, 
   "recipientInfo": {
    "messageInfo": {
     "attachments": [], 
     "cc": [
      "String"
     ], 
     "htmlBody": "String", 
     "transmissionInfo": "String", 
     "fromHeader": "String", 
     "subject": "String", 
     "textBody": "String", 
     "to": [
      "String"
     ], 
     "processed": "Date String", 
     "fromEnvelope": "String", 
     "sent": "Date String"
    }, 
    "recipientMetaInfo": {
     "remoteServerGreeting": "String", 
     "encryptionInfo": "String", 
     "receiptAcknowledgement": "String", 
     "receiptEvent": "String", 
     "transmissionEnd": "Date String", 
     "spamEvent": "String", 
     "messageExpiresIn": 3650, 
     "processingServer": "String", 
     "binaryEmailSize": 100, 
     "transmissionSize": 100, 
     "remoteHost": "String", 
     "transmissionStart": "Date String", 
     "remoteIp": "String", 
     "components": [
      {
       "mimeType": "String", 
       "type": "String", 
       "name": "String", 
       "extension": "String", 
       "size": 100
      }
     ]
    }
   }, 
   "deliveredMessage": {
    "user@domain.com": {
     "messageInfo": {
      "attachments": [], 
      "cc": [
       "String"
      ], 
      "htmlBody": "String", 
      "transmissionInfo": "String", 
      "fromHeader": "String", 
      "subject": "String", 
      "route": "String", 
      "textBody": "String", 
      "to": [
       "String"
      ], 
      "processed": "Date String", 
      "fromEnvelope": "String", 
      "sent": "String"
     }, 
     "policyInfo": [
      {
       "policyName": "String", 
       "policyType": "String", 
       "inherited": false
      }
     ], 
     "deliveryMetaInfo": {
      "remoteServerGreeting": "String", 
      "encryptionInfo": "String", 
      "receiptAcknowledgement": "String", 
      "emailAddress": "String", 
      "messageExpiresIn": 3650, 
      "processingServer": "String", 
      "transmissionSize": 100, 
      "remoteHost": "String", 
      "transmissionStart": "Date String", 
      "remoteIp": "String", 
      "components": [
       {
        "mimeType": "text/plain", 
        "type": "Email Primary Body Plain Text", 
        "name": "body.txt", 
        "extension": "txt", 
        "size": 4075
       }
      ], 
      "transmissionEnd": "Date String", 
      "deliveryEvent": "String"
     }
    }
   }, 
   "spamInfo": {
    "spamScore": 0,
    "detectionLevel": "moderate",
    "spamProcessingDetail": {
    "rbl": {
      "allow": true,
      "info": "String"
    },
    "greyEmail": true,
    "spf": {
      "allow": true,
      "info": "String"
    },
    "dkim": {
      "allow": true,
      "info": "String"
    },
    "dmarc": {
      "allow": true,
      "info": "String"
    },
    "permittedSender": {
      "allow": true,
      "info": "String"
    },
    "managedSender": {
      "allow": true,
      "info": "String"
    },
    "symbolGroups": [
      {
        "name": "String",
        "description": "String"
      }
    ],
    "verdict": {
      "decision": "String",
      "description": "String",
      "risk": "negligible",
      "categories": [
        {
          "name": "String",
          "risk": "String",
          "subcategories": [
            {
              "name": "String",
              "risk": "String",
              "augmentations": [
                {
                  "name": "String",
                  "risk": "String"
                }
              ]
            }
          ]
        }
      ]
    }
   }
   "id": "String"
  }
 ]
}
meta object
Field Type Description
status Number The function level status of the request.
data
Field Type Description
status String The message status.
retentionInfo Retention Info Object An object describing the retention information applied to the message.
recipientInfo Recipient Info Object An object describing the recipient information applied to the message.
deliveredMessage Delivered Message Object If rewriting of this URL in emails is disabled.
spamInfo spamInfo Object An object describing the spam scoring information of the message.
id String The Mimecast ID of the message.
Retention Info Object
Field Type Description
retentionAdjustmentDays Number The number of days that a retention adjustment has been applied to the message.
litigationHoldInfo Array An array containing objects describing the expiry, description and Mimecast ID of any litigation hold policies applied to the message.
currentPurgeDate Date String The date that the message is scheduled to be purged from Mimecast.
purgeBasedOn String Describes what the message purge date is based on.
fbrExpireCheck Array An array of date strings describing when Granular Retention policies were checked, if applicable.
audits Array An array of objects describing the date, type, and information about any audits carried out on the message.
originalPurgeDate Date String The message's original purge date.
smartTags Array An array of smart tag objects that the message is assigned to.
fbrStamps Array An array of objects describing the email address, folder, recipient visibility, expiry, purge, and policy fields applied to the message as a result of a Granular retention policy action, if applicable.
Recipient Info Object
Field Type Description
messageInfo Message Info Object An object describing recipient message information.
recipientMetaInfo Message Meta-data Object An object describing the message meta-data
Delivered Message Object
Field Type Description
messageInfo Message Info Object An object describing recipient message information.
recipientMetaInfo Message Meta-data Object An object describing the message meta-data
spamInfo Object
Field Type Description
spamScore Number The spam score of the recieved message
detectionLevel String The spam scanning level applied to the message
spamProcessingDetail spamProcessingDetail Object An object containing the detailed spam scanning information
spamProcessingDetail Object
Field Type Description
greyEmail Boolean Identifies if message was found to be greymail or bulk
rbl infoObject An object containing information about RBL results of the message
spf infoObject An object containing information about SPF results of the message
dkim infoObject An object containing information about DKIM results of the message
dmarc infoObject An object containing information about DMARC results of the message
permittedSender infoObject An object to determine if the from address matched a Permitted Sender entry
managedSender infoObject An object to determine if the from address matched a Managed Sender entry
verdict spamVerdict Object An object containing category and risk info for the spam verdict
spamVerdict Object
Field Type Description
descision String Displays 'spam' if the message was considered to be spam
description String Any description for the reason for the message to be considered spam
risk String A risk rating of the message
categories Array of categories Objects An array containing categories that applied to the message
categories Object
Field Type Description
name String Name of the category
risk String A risk rating of the category
subcategories Array of subcategories Objects An array containing sub-categories that applied to the message
subcategories Object
Field Type Description
name String Name of the sub-category
risk String A risk rating of the sub-category
augmentations Array of augmentations Objects An array containing augmentations that applied to the sub-category
augmentations Object
Field Type Description
name String Name of the augmentation
risk String A risk rating of the augmentation

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/message-finder/get-message-info
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":[
    {
        "id": "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/message-finder/get-message-info"
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"

# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(secret_key.decode("base64"), ':'.join([hdr_date, request_id, uri, app_key]),
                  digestmod=hashlib.sha1).digest()

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

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

payload = {
        'data': [
            {
                'id': '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/message-finder/get-message-info";
            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"": [
                        {
                            ""id"": ""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/message-finder/get-message-info"
$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"": [
                        {
                            ""id"": ""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/message-finder/get-message-info";
        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" +
        "         \"id\": \"String\"\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());
    }