Outbox

Get queued message

Gets a queued message 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/{queueId}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/outbox/{queueId}
  • Auth: HTTP bearer

Path parameters

queueIdstring required

Queue identifier for scheduled email

Example:d41f0423195f271f

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 queued message, including its delivery attempts and last error.

queueIdstring

Unique queue entry identifier

accountstring required

Unique identifier for the email account

source'smtp' | 'api' | 'test' | 'ui'

How this message entered the queue

messageIdstring

Message-ID header value

subjectstring nullable

Email subject line

gatewaystring nullable

Gateway ID used for delivery, or null when no gateway is set

proxystring nullable

Proxy URL used for delivery, or null when no proxy is set

localAddressstring nullable

Local IP address used for delivery, or null when not set

idempotencyKeystring nullable

Idempotency key provided when the message was submitted

useStructuredFormatboolean

Whether this message is sent to MS Graph as structured JSON instead of raw MIME

createdstring date-time

When this message was added to the queue

scheduledstring date-time

Scheduled delivery time

attemptsMadeinteger

Number of delivery attempts made

attemptsinteger

Maximum delivery attempts before marking as failed

Example response

{
  "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.