Archive Search

Returns a list of messages matching the requested search criteria.

Pre-requisites

  • In order to successfully use this endpoint to search across a customers entire archive, the logged in user must be a Mimecast administrator with at least the Archive | Search | Read permission.
  • To use this endpoint to search for messages 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/search

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

{
  "meta": {
      "pagination": {
          "pageToken": 'String'
      }
  },
  "data":[
    {
      "admin": Boolean,
      "query": "String"
    }
  ]
}
meta
FieldTypeRequiredDescription
pagination Object Optional An object defining paging options for the request.
Paginiation Object
FieldTypeRequiredDescription
pageToken String Optional The value of the 'next' or 'previous' fields from an earlier request.
data
FieldTypeRequiredDescription
admin Boolean Optional Defines if the search is an administrative search or an end user user search. Defaults to false.
query String Required The query string for the search. Please see the Building Search Queries guide for more information on building search queries.

Response

{
 "fail": [], 
 "meta": {
	"status": Number, 
	"pagination": {
		"pageSize": Number, 
		"recordStart": Number, 
		"next": "String"
  	}
 }, 
 "data": [
	{
		"status": "String", 
		"smash": "String", 
		"displayto": "String", 
		"receiveddate": "Date String", 
		"attachmentcount": Number, 
		"displayfrom": "String", 
		"size": Number, 
		"id": "String", 
		"subject": "String"
	},...
 ]
}
meta object
FieldTypeDescription
status Number The function level status of the request.
pagination Object An object containing paging information.
Pagination object
FieldTypeDescription
pageSize Number The number of results requested.
next String 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
FieldTypeDescription
status String The status of the message.
smash string A Mimecast proprietary calculated field identifying the message.
displayto String The display name of the recipient of the email.
receiveddate Date String The date the message was received.
displayfrom String The display name of the sender of the email.
attachmentcount Number The number of attachments on the message.
size Number The size of the message in bytes.
id String The Mimecast ID of the message.
subject String The subject of the email.
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/search
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'
      }
  },
  "data":[
    {
      "admin": False,
      "query": "XML query 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/search"
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 = {
    "meta": {
        "pagination": {
            "pageToken": 'ENTER PAGE TOKEN HERE OR REMOVE THE FIELD'
        }
    },
    "data":[
        {
            'admin': True,
            'query': '<?xml version=\"1.0\"?>\n'
                     '<xmlquery trace=\"iql,muse\">\n'
                     '<metadata query-type=\"emailarchive\" archive=\"true\" active=\"false\" page-size=\"5\" startrow=\"0\">\n'
                     '<mailboxes>\n'
                     '<mailbox include-aliases=\"true\">ADD EMAIL ADDRESS OF MAILBOX TO FILTER ON HERE</mailbox>\n'
                     '</mailboxes>\n'
                     '<smartfolders/>\n'
                     '<return-fields>\n'
                     '<return-field>attachmentcount</return-field>\n'
                     '<return-field>status</return-field>\n'
                     '<return-field>subject</return-field>\n'
                     '<return-field>size</return-field>\n'
                     '<return-field>receiveddate</return-field>\n'
                     '<return-field>displayfrom</return-field>\n'
                     '<return-field>id</return-field>\n'
                     '<return-field>displayto</return-field>\n'
                     '<return-field>smash</return-field>\n'
                     '</return-fields>\n'
                     '</metadata>\n'
                     '<muse>\n'
                     '<text>ADD SEARCH TEXT</text>\n'
                     '<date select=\"last_year\"/>\n'
                     '</muse>\n'
                     '</xmlquery>'
        }
    ]
}

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/search";
            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"":[
                        {
                            ""admin"": True,
                            ""query"": ""<?xml version=\""1.0\""?>
                                        <xmlquery trace=\""iql,muse\"">
                                        <metadata query-type=\""emailarchive\"" archive=\""true\"" active=\""false\"" page-size=\""5\"" startrow=\""0\"">
                                        <mailboxes>
                                        <mailbox include-aliases=\""true\"">ADD EMAIL ADDRESS OF MAILBOX TO FILTER ON HERE</mailbox>
                                        </mailboxes>
                                        <smartfolders/>
                                        <return-fields>
                                        <return-field>attachmentcount</return-field>
                                        <return-field>status</return-field>
                                        <return-field>subject</return-field>
                                        <return-field>size</return-field>
                                        <return-field>receiveddate</return-field>
                                        <return-field>displayfrom</return-field>
                                        <return-field>id</return-field>
                                        <return-field>displayto</return-field>
                                        <return-field>smash</return-field>
                                        </return-fields>
                                        </metadata>
                                        <muse>
                                        <text>ADD SEARCH TEXT HERE</text>
                                        <date select=\""last_year\""/>
                                        </muse>
                                        </xmlquery>""
                        }
                    ]
                }";

            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/search"
$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"":[
                        {
                            ""admin"": True,
                            ""query"": ""<?xml version=\""1.0\""?>
                                        <xmlquery trace=\""iql,muse\"">
                                        <metadata query-type=\""emailarchive\"" archive=\""true\"" active=\""false\"" page-size=\""5\"" startrow=\""0\"">
                                        <mailboxes>
                                        <mailbox include-aliases=\""true\"">ADD EMAIL ADDRESS OF MAILBOX TO FILTER ON HERE</mailbox>
                                        </mailboxes>
                                        <smartfolders/>
                                        <return-fields>
                                        <return-field>attachmentcount</return-field>
                                        <return-field>status</return-field>
                                        <return-field>subject</return-field>
                                        <return-field>size</return-field>
                                        <return-field>receiveddate</return-field>
                                        <return-field>displayfrom</return-field>
                                        <return-field>id</return-field>
                                        <return-field>displayto</return-field>
                                        <return-field>smash</return-field>
                                        </return-fields>
                                        </metadata>
                                        <muse>
                                        <text>ADD SEARCH TEXT HERE</text>
                                        <date select=\""last_year\""/>
                                        </muse>
                                        </xmlquery>""
                        }
                    ]
                }"

#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/search";
        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" +
                "            \"admin\": True,\n" +
                "            \"query\": \"<?xml version=\\\"1.0\\\"?>\n" +
                "                     <xmlquery trace=\\\"iql,muse\\\">\n" +
                "                     <metadata query-type=\\\"emailarchive\\\" archive=\\\"true\\\" active=\\\"false\\\" page-size=\\\"5\\\" startrow=\\\"0\\\">\n" +
                "                     <mailboxes>\n" +
                "                     <mailbox include-aliases=\\\"true\\\">ADD EMAIL ADDRESS OF MAILBOX TO FILTER ON HERE</mailbox>\n" +
                "                     </mailboxes>\n" +
                "                     <smartfolders/>\n" +
                "                     <return-fields>\n" +
                "                     <return-field>attachmentcount</return-field>\n" +
                "                     <return-field>status</return-field>\n" +
                "                     <return-field>subject</return-field>\n" +
                "                     <return-field>size</return-field>\n" +
                "                     <return-field>receiveddate</return-field>\n" +
                "                     <return-field>displayfrom</return-field>\n" +
                "                     <return-field>id</return-field>\n" +
                "                     <return-field>displayto</return-field>\n" +
                "                     <return-field>smash</return-field>\n" +
                "                     </return-fields>\n" +
                "                     </metadata>\n" +
                "                     <muse>\n" +
                "                     <text>ADD SEARCH TEXT HERE</text>\n" +
                "                     <date select=\\\"last_year\\\"/>\n" +
                "                     </muse>\n" +
                "                     </xmlquery>\"\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());
    }