Get Rejection Logs


This endpoint can be used to find rejected messages and the reasons for their rejection.


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


To use this endpoint you send a POST request to:

  • /api/gateway/get-rejections

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.

A randomly generated GUID, for example,

x-mc-app-id The Application ID provided with your Registered API Application.

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

  "meta": {
    "pagination": {
      "pageSize": 25,
      "pageToken": "String"
  "data": [
      "mailbox": "user@domain.tld",
      "start": "2015-11-16T14:49:18+00:00",
      "searchBy": {
        "fieldName": "from",
        "value": "sender@domain.tld"
      "admin": "true",
      "end": "2015-11-25T14:49:18+00:00"
Field Type Required Description
pagination Object Optional An object defining paging options for the request.
Paginiation Object
Field Type Required Description
pageSize Number Optional The number of results to request.
pageToken String Optional The value of the 'next' or 'previous' fields from an earlier request.
Field Type Required Description
mailbox String Optional Get rejections for a given user. If admin is set to true and no mailbox is provided, will return rejections for all users. Otherwise if no mailbox is provided, then will return rejections for the authenticated account.
start Date String Optional The start date of results to return in ISO 8601 format. Default value is start of the current day.
searchBy Filter Object Optional Accepts search filter field and value to apply when searching.
admin Boolean Optional Specifies if the request is for an admin or user-level. If set to true, the request will return messages for all users. Default value is false.
end Date String Optional The end date of results to return in ISO 8601 format. Default value is the current date.
Filter Object
Field Type Required Description
fieldName String Optional The field to be filtered on. Possible values are all, from, to, type, info, remoteIp
value String Optional The value of which the filter will be applied


  "fail": [],
  "meta": {
    "status": 200,
    "pagination": {
      "pageSize": 25,
      "next": "String",
      "previous": "String"
  "data": [
      "rejections": [
          "created": "2015-11-25T14:49:18+00:00",
          "remoteEhlo": "",
          "detectionLevel": "relaxed",
          "ipAddress": "",
          "description": "Manual Header Rejection",
          "type": "13017",
          "toAddress": "recipient@domain.tld",
          "toAddressPreCheck": "recipient@domain.tld",
          "manageRecipient": false,
          "spamScore": "29",
          "fromAddress": "sender@domain.tld",
          "id": "eNpVj21LhEAUhf_LfN2VnRl1RpclCN...",
          "toAddressPostCheck": "",
          "info": "Malware detected by AV Scan policy: Exploit.DDE-CmdCalc.Gen",
          "remoteName": "mta123.domain.tld"
Field Type Description
status Number The function level status of the request.
pagination Object An object containing paging information.
Pagination Object
Field Type Description
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.
Field Type Description
rejections Array of Rejection Objects An array of rejected message objects sorted by descending timestamp
Field Type Description
created Date String Timestamp of the message rejection in ISO 8601 format
remoteEhlo String The sending server's EHLO greeting
detectionLevel String Spam detection level. Possible values are: not_initiated, relaxed, moderate, aggressive, cluster, whitelisted_cluster or outbound
ipAddress String Remote IP address of the sending platform
description String Message rejection type description
type Number Internal Mimecast rejection identifier
toAddress String Intended recipient email address
toAddressPreCheck String Recipient address prior to message processing
manageRecipient Boolean Indicates if the rejection is due to a managed sender entry
spamScore Number Numerical spam score. High-confidence spam with a score above 28 will trigger a rejection
fromAddress String Sender address
id String Mimecast secure ID of the rejected message
toAddressPostCheck String Recipient address after message processing, which may return empty based on the rejection type
info String Additional detail around the message rejection
remoteName String Sending server greeting identifier

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/get-rejections
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": {
      "pageSize": 25,
      "pageToken": "String"
  "data": [
      "mailbox": "user@domain.tld",
      "start": "2015-11-16T14:49:18+00:00",
      "searchBy": {
        "fieldName": "from",
        "value": "sender@domain.tld"
      "admin": "true",
      "end": "2015-11-25T14:49:18+00:00"
import base64
import hashlib
import hmac
import uuid
import datetime
import requests

# Setup required variables
base_url = ""
uri = "/api/gateway/get-rejections"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET 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 =, 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 = {
  'meta': {
    'pagination': {
      'pageSize': 25,
      'pageToken': 'String'
  'data': [
      'mailbox': 'user@domain.tld',
      'start': '2015-11-16T14:49:18+00:00',
      'searchBy': {
        'fieldName': 'from',
        'value': 'sender@domain.tld'
      'admin': 'true',
      'end': '2015-11-25T14:49:18+00:00'

r =, headers=headers, data=str(payload))

static void Main(string[] args)
            //Setup required variables
            string baseUrl = "";
            string uri = "/api/gateway/get-rejections";
            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 = @"{
  ""meta"": {
    ""pagination"": {
      ""pageSize"": 25,
      ""pageToken"": ""String""
  ""data"": [
      ""mailbox"": ""user@domain.tld"",
      ""start"": ""2015-11-16T14:49:18+00:00"",
      ""searchBy"": {
        ""fieldName"": ""from"",
        ""value"": ""sender@domain.tld""
      ""admin"": ""true"",
      ""end"": ""2015-11-25T14:49:18+00:00""

            byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);

            System.IO.Stream stream = request.GetRequestStream();
            stream.Write(payload, 0, payload.Length);

            //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;
#Setup required variables
$baseUrl = ""
$uri = "/api/gateway/get-rejections"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET 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"": ""String""
  ""data"": [
      ""mailbox"": ""user@domain.tld"",
      ""start"": ""2015-11-16T14:49:18+00:00"",
      ""searchBy"": {
        ""fieldName"": ""from"",
        ""value"": ""sender@domain.tld""
      ""admin"": ""true"",
      ""end"": ""2015-11-25T14:49:18+00:00""

#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url

#Print the response
public static void main(String[] args) throws,, {

        //set up variables for request
        String baseUrl = "";
        String uri = "/api/gateway/get-rejections";
        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 obj = new;

        // 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");
        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);
        String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));

        // create request object con = ( obj.openConnection();

        //set request type to POST

        //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" +
"  \"meta\": {\n" +
"    \"pagination\": {\n" +
"      \"pageSize\": 25,\n" +
"      \"pageToken\": \"String\"\n" +
"    }\n" +
"  },\n" +
"  \"data\": [\n" +
"    {\n" +
"      \"mailbox\": \"user@domain.tld\",\n" +
"      \"start\": \"2015-11-16T14:49:18+00:00\",\n" +
"      \"searchBy\": {\n" +
"        \"fieldName\": \"from\",\n" +
"        \"value\": \"sender@domain.tld\"\n" +
"      },\n" +
"      \"admin\": \"true\",\n" +
"      \"end\": \"2015-11-25T14:49:18+00:00\"\n" +
"    }\n" +
"  ]\n" +
"}"; os = con.getOutputStream();

        //process response in = new
        String inputLine;
        StringBuffer response = new StringBuffer();

        while ((inputLine = in.readLine()) != null) {

        //return result
Back to Top