Inbound & Outbound Queues

Description

This endpoint can be used to get the count of the inbound and outbound email queues at specified times.

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 endpoint you send a POST request to:

  • /api/email/get-email-queues

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

{
"data": [
{
"start": "2015-11-16T14:49:18+0000",
"end": "2015-11-16T14:49:18+0000"
}
]
}
data
Field Type Required Description
start Date String Required The earliest date of message queues.
end Date String Required The most recent date of message queues.

Response

{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"outboundEmailQueue": 0,
"inboundEmailQueue": 0
}
]
}
meta object
Field Type Description
status Number The function level status of the request.
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
inboundEmailQueue Number The number of inbound messages currently queued.
outboundEmailQueue Number The number of outbound messages currently queued.

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/email/get-email-queues
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
{
"data":[
{
"start": "2015-11-16T14:49:18+0000",
"end": "2015-11-16T14:49:18+0000"
}
]
}
Back to Top