This API endpoint can be used to get information about held messages, including the reason, hold level, sender and recipients. The ID can be used to act on a message using the Release Message or Reject Message API endpoints.
Pre-requisites
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Account | Dashboard | Read permission.
URI
To use this endpont you send a POST request to:
/api/gateway/get-hold-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,
Level of results to return. If false, only results for the currenlty authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false.
searchBy
Object
Optional
Object data used to filter results
start
Date String
Optional
The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000
end
Date String
Optional
The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000
filterBy
Array
Optional
Filter options to narrow results
searchBy
Field
Type
Required
Description
Wert
String
Optional
The text used to filter results
fieldName
String
Optional
Message fields to filter based on. Possible values are: all, subject, sender, recipient, reason_code
filterBy
Field
Type
Required
Description
route
String
Optional
Specify the route of emails to return. Possible values are: all, internal, outbound, inbound, external
heldGroup
String
Optional
Specify the level of hold placed on messages to return. Possible values are: administrator, moderator, user, cluster
attachments
Boolean
Optional
Specify if results should be held attachments (e.g. Attachment Management holds)
The level of a message hold. Possible values are: administrator, moderator, user
heldSince
Date String
The date that the message was held
messageInfo
String
The name of the definition that held a message
policyInfo
String
The name of the policy that held a message
size
Number
The size of the message in bytes
id
String
The Mimecast secure ID of a message
status
String
The current held status of a message
fromEnv
Object
An EmailAddress object containing the envelope from information
fromHdr
Object
An EmailAddress object containing the header from information
to
Array
An array of EmailAddress recipeint objects
received
Date String
The date that the message was received by Mimecast
subject
String
The mesasge subject
senderIP
String
The IP address that delivered the message to Mimecast
attachments
Boolean
Returns true if the message contains attachments; otherwise returns false
route
String
The route of the held message. Possible values are: inbound, outbound, internal, external
sent
Date String
The date that the mesage was sent
EmailAddress
Field
Type
Description
emailAddress
String
An email address
displayableName
String
A display name, if available
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.
Diese Website verwendet Cookies, um Ihnen das bestmögliche Nutzererlebnis zu bieten und um die Performance der Website zu überwachen und zu verbessern. Wir haben eine neue Cookie-Richtlinie veröffentlicht, die erklärt, was Cookies sind und welche Arten von Cookies auf dieser Website verwendet werden. Klicken Sie hier für weitere Informationen. Falls Sie Cookies deaktivieren möchten, besuchen Sie bitte die Informationsseite für Cookies. Dort erfahren Sie detailliert, wie Sie am besten vorgehen. Wenn Sie diese Website weiter verwenden, stimmen Sie der Nutzung von Cookies zu, es sei denn, Sie haben Cookies deaktiviert.