This endpoint can be used to find rejected messages and the reasons for their rejection.
Pre-requisites
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Monitoring | Rejections | Read permission.
URI
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.
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,
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.
Data
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
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
Field
Type
Description
rejections
Array of Rejection Objects
An array of rejected message objects sorted by descending timestamp
Rejections
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.