Message

Retrieve message text

Retrieves message text

get/v1/account/{account}/text/{text}

Request

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

Path parameters

accountstring required

Unique identifier for the email account

Example:user123
textstring required

Message text ID

Example:AAAAAQAACnAcdfaaN

Query parameters

maxBytesinteger

Max length of text content

Example:5242880
textType'html' | 'plain' | '*'

Which text content to return, use * for all. By default all contents are returned.

Example:*
webSafeHtmlboolean

If true, then returns a single sanitized HTML rendering of the body instead of the raw text parts

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 message text content in the requested formats.

plainstring

Plaintext content. Not returned when webSafeHtml was requested

htmlstring

HTML content

webSafeboolean

Whether the HTML content has been processed into a web-safe version (set when webSafeHtml was requested)

hasMoreboolean

Whether the returned text was capped by maxBytes. On an IMAP account the cap also decides how much is downloaded; on a Gmail API or MS Graph account the provider returns the whole text in one response and the cap decides how much of it is passed on

Example response

{
  "plain": "Hello world",
  "html": "<p>Hello world</p>",
  "webSafe": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.