In order to successfully use this endpoint to request message lists for any user, the logged in user must be a Mimecast administrator with at least the Archive | Search | Read permission.
To use this endpoint to request message lists for 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-list
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
{
"meta": {
"pagination": {
"pageToken": 'String'
}
},
"data":[
{
"view": "String",
"mailbox": "String",
"start": "Date String",
"end": "String",
"includeDelegates": Boolean,
"includeAliases": Boolean
}
]
}
meta
Field
Type
Required
Description
pagination
Object
Optional
An object defining paging options for the request.
Paginiation Object
Field
Type
Required
Description
pageToken
String
Optional
The value of the 'next' or 'previous' fields from an earlier request.
data
Field
Type
Required
Description
view
String
Required
The message list type, must be one of: INBOX or SENT
mailbox
String
Optional
The email address to return the message list for. If excluded, then messages for the logged in user are returned.
start
Date String
Optional
The start date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the last calendar month.
end
Date String
Optional
The end date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the end of the current day.
includeDelegates
Boolean
Optional
Include messages for addresses that the mailbox has delegate permissions to. Default false.
includeAliases
Boolean
Optional
Include messages for alias addresses of the mailbox. Default true.
A pageToken value that can be used to request the next page of results. Only returned if there are more results to return.
previous
String
A pageToken value that can be used to request the previous page of results. Only returned if there is a previous page.
data array
Field
Type
Description
status
String
The status of the message.
received
Date String
The date the message was received.
from
Object
An object containing the emailAddress and displayableName of the sender of the email.
smash
string
A Mimecast proprietary calculated field identifying the message.
read
Boolean
Read / Unread flag, only applicable to Secure Messages
attachmentCount
Number
The number of attachments on the message.
ccm
Boolean
If the message was sent using Secure Messaging.
to
Object
An object containing the emailAddress and displayableName of the recipient of the email.
recalled
Boolean
If the message was recalled, only applicable to Secure Messages.
subject
String
The subject of the email.
expired
Boolean
If the message has expired in the archive.
id
String
The Mimecast ID of the message.
size
Number
The size of the message in bytes.
fail array
When a request is successful the fail array will be empty.
Field
Type
Description
errors
Array of error objects
An array of error objects describing the error returned from the API.
errors object
Field
Type
Description
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-list
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
{
"meta": {
"pagination": {
"pageToken": 'ENTER PAGE TOKEN HERE OR REMOVE THE FIELD'