This endpoint can be used to get deatils around a message identified with the Message Finder Search endpoint. A key capabilitiy is the ability to get an ID of an attachment for download.
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/gateway/message/get-message-detail
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,
Timestamp of the date that Mimecast received the message in ISO 8601 format.
processed
Date String
Timestamp of the date that Mimecast processed the message in ISO 8601 format.
status
String
Current archive state of the message. Possible values are ACTIVE or ARCHIVED.
hasHtmlBody
Boolean
Indicates if the message included an HTML version of the body.
hasTextBody
Boolean
Indicates if the message included a plain text version of the body.
isPassthrough
Boolean
Indicates if a Message Passthrough policy was applied to the message, preventing any modifications.
envelopeFrom
Email Address Object
An object contianing information about the envelope from address.
from
Email Address Object
An object containing information about the header from address.
to
Array of Email Address Objects
A list of objects containing information about the message recipients.
cc
Array of Email Address Objects
A list of objects containing information about the carbon-copied recipients.
headerDate
String
Value of the message's Date header.
headers
Array of Message Header Objects
An array containing information about each message header.
attachments
Array of Attachment Objects
An Array containing information about each message attachment.
messageBodyPreview
String
A brieft snipplet from the beginning on the message body content.
subjecisCcmt
Boolean
Indicated if the message was sent as a Mimecast Secure Message.
Email Address Oject
Field
Type
Description
emailAddress
String
Email address used to transmit the message, without display name.
displayableName
String
Display name prefixed to the email address. Will not be included if the address does not contain a display name.
Message Header Object
Field
Type
Description
name
String
Name of the header.
values
Array of Strings
An array containing strings for each header value matching the header name.
Attachment Object
Field
Type
Description
id
String
The Mimecast secure ID of the attachment, used to download with Get File endpoint.
filename
String
Attachment name, without extension.
size
Number
Size of the message in KB.
extension
String
Attachment extension value.
contentType
String
The content-type of the attachment.
contentId
String
The content identifier of the attachment type.
sha256
String
The SHA256 file hash value for the attachment.
md5
String
The MD5 file hash value, if available.
bodyType
Number
Value identifying if the attachment is included in the body (inline attachment).
scanDate
Date String
Timestamp of the file scan by Attachment Protection, if applicable, in ISO 8601 format.
verdict
String
Scan result of the attachment, if processed by Attachment Protection. Possible values are SAFE or MALICIOUS.
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/gateway/message/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":[
{
"context": "String",
"viewType": "String",
"mailbox": "String",
"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/gateway/message/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"
# 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': [
{
"context": "String",
"viewType": "String",
"mailbox": "String",
"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/gateway/message/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"": [
{
""context"": ""String"",
""viewType"": ""String"",
""mailbox"": ""String"",
""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();
}