Get Message Detail

Returns meta data about a message in the Mimecast archive.

Pre-requisites

  • In order to successfully use this endpoint to load any archived message the logged in user must be a Mimecast administrator with at least the Archive | Search Content View permission.
  • To use this endpoint to load messages sent or received by the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required.

URI

To use this endpoint you send a POST request to:

  • /api/archive/get-message-detail

Request Headers

The following request headers must be included in your request:

FieldDescription
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
FieldTypeRequiredDescription
id String Required The Mimecast ID of the message to return. This value is returned from a message listing endpoint, for example /api/archive/get-message-list or /api/archive/search.

Response

{
    "fail": [],
    "meta": {
        "status": 200
    },
    "data": [
        {
            "status": "Active",
            "smash": "d2dbc6ce043b3cc4a3e2fbe2803fedd7baf8e50f",
            "mimeMessageId": "<Mimecast.53.e9dcd51fac96b75.155a26494b0@uk-2.mimecast.com>",
            "hasHtmlBody": true,
            "attachments": [
                {
                    "contentType": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
                    "extension": "pptx",
                    "contentId": "",
                    "filename": "a file.pptx",
                    "bodyType": 5,
                    "sha256": "3ab4ab35d6f2a86705797d74a187d569fe1f5054ba852...",
                    "id": "eNpVUNFOxCAQ_BdetSewpeVOY6w...",
                    "size": 103775
                },...
            ],
            "received": "2016-06-30T17:39:09+0000",
            "replyTo": {
                "displayableName": "a string", 
                 "emailAddress": "auser@mimecast.com"
            }, 
            "cc": [{
                "displayableName": "a string",
                "emailAddress": "auser@mimecast.com"
               }],
            "from": {
                "displayableName": "a string",
                "emailAddress": "auser@mimecast.com"
            },
            "isPassthrough": false,
            "envelopeFrom": {
                "displayableName": "a string",
                "emailAddress": "auser@mimecast.com"
            },
            "headers": [
                {
                    "values": [
                        "A value" ],
                    "name": "A Header Name"
                },...
            ],
            "to": [
                {
                     "displayableName": "a string",
                     "emailAddress": "auser@mimecast.com"
                }
            ],
            "processed": "2016-06-30T17:39:08+0000",
            "hasTextBody": false,
            "headerDate": "Thu, 30 Jun 2016 18:39:08 +0100",
            "messageBodyPreview": "Hi Mimecast!",
            "subject": "a subject",
            "id": "eNpNj21LwzAUhf9Lv7rVvDRp...",
            "size": 647
        }
    ]
}
meta object
FieldTypeDescription
status Number The function level status of the request.
data array

An array containing a Mimecast message object.

FieldTypeDescription
status String The status of the message, either Active (recently received and not fully indexed yet) or Archived (fully indexed).
smash String A Mimecast proprietary calculated value uniquely identifying the message. Use this value to deduplicate message lists.
mimeMessageId String The internet message id of the message.
hasHtmlBody Boolean If the message has an HTML body part.
attachments Array

An array of objects containing information about message attachments. Each object contains the following fields:

  • contentType
  • extension
  • contentId
  • filename
  • bodyType
  • sha256
  • id
  • size
received Date string The received date of the message in ISO 8601 format.
replyTo Object The value of the Reply-To header.
cc Array An array of objects for each CC recipient of the message. Each object contains a displayableName and emailAddress field.
from Object

An object for the sender of the message as defined in the message header. The object contains a displayableName and emailAddress field.

envelopeFrom Object An object for the sender of the message as defined in the message envelope. The object contains a displayableName and emailAddress field.
isPassthrough Boolean If the message was subject to a message passthrough gateway policy.
headers Array An array of objects containing message header values. Each object has name and values fields.
to Object

An object for each recipient of the message. Each object contains a displayableName and emailAddress field.

processed Date string The date the message was processed by Mimecast in ISO 8601 format.
hasTextBody Boolean If the message has a plain text body part.
headerDate Date string The date of the message as defined in the message headers.
messageBodyPreview String A preview of the message body.
subject String The message subject.
id String Mimecast message ID, use this to retrieve messages.
size Number The message size.
fail array

When a request is successful the fail array will be empty.

FieldTypeDescription
errors Array of error objects An array of error objects describing the error returned from the API.

errors object

FieldTypeDescription
message String The error message.
code String The Mimecast code associated with the error.
retryable Boolean If the error is retryable

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/archive/get-message-detail
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/archive/get-message-detail"
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/archive/get-message-detail";
            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/archive/get-message-detail"
$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 = "{
                 ""meta"": {
                     ""pagination"": {
                         ""pageSize"": 25,
                         ""pageToken"": ""ENTER PAGE TOKEN HERE OR REMOVE FIELD""
                     }
                 },
                 ""data"": [
                     {
                         ""oldestFirst"": False,
                         ""from"": ""2016-10-01T14:49:18+0000"",
                         ""route"": ""all"",
                         ""to"": ""2017-10-13T23:59:59+0000"",
                         ""scanResult"": ""all""
                     }
                 ]
                }"

#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/archive/get-message-detail";
        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());
    }