Outbox
List queued messages
Lists messages in the Outbox. Credentials are masked: stored passwords, the credentials in any proxy or webhook URL, and the values of custom webhook headers all read back as "******". A masked value is not the stored one - leave the field out of an update rather than writing it back, otherwise the mask replaces the credential.
get/v1/outbox
Request
- Base URL: https://your-emailengine-host
- URL: https://your-emailengine-host/v1/outbox
- Auth: HTTP bearer
Query parameters
pageinteger
Page number (zero indexed, so use 0 for first page)
pageSizeinteger
How many entries per page
Example:20
Headers
x-ee-timeoutinteger
Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect
Example:30000
Response
Returns the messages currently queued for delivery.
Example response
{
"total": 120,
"pages": 24,
"messages": [
{
"queueId": "1869c5692565f756b33",
"account": "user123",
"source": "smtp",
"messageId": "<test123@example.com>",
"envelope": {
"from": "sender@example.com",
"to": [
"recipient@example.com"
]
},
"subject": "What a wonderful message",
"gateway": "example",
"proxy": "socks5://proxy.example.com:1080",
"localAddress": "198.51.100.24",
"idempotencyKey": "submit-12345",
"created": "2021-02-17T13:43:18.860Z",
"scheduled": "2021-02-17T13:43:18.860Z",
"nextAttempt": "2021-02-17T13:43:18.860Z",
"attemptsMade": 3,
"attempts": 3,
"progress": {
"status": "queued",
"response": "250 Message Accepted",
"messageId": "<test123@example.com>",
"originalMessageId": "<test123@example.com>",
"error": {
"message": "Authentication failed",
"code": "EAUTH",
"statusCode": 502
},
"networkRouting": {
"localAddress": "198.51.100.24",
"name": "relay.example.com"
}
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.