MessageInformation

Note

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

This is an object value, with the following properties:

• data - optional nullable string. If want_body was set in the original request, holds the message body

• due - optional nullable string (date-time).

• meta - required object. The message metadata

• num_attempts - optional nullable integer (u-int16).

• recipient - required array of string (email). The envelope-to address. May be either an individual string or an array of strings for multi-recipient messages.

• scheduling - optional object.

• sender - required string. The envelope sender

Examples

{
  "data": "From: user@example.com\nSubject: Hello\n\nHello there",
  "due": "1990-12-31T23:59:60Z",
  "meta": {},
  "num_attempts": 42,
  "recipient": "recipient@example.com",
  "scheduling": {},
  "sender": "sender@sender.example.com"
}