Skip to content

Content

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.

The message content. Can either be a fully formed MIME message, or a json object describing the MIME structure that should be created.

Can be one of the following shapes of data:

Option 1

A complete MIME message string

This is a string value.

Option 2

Describe the MIME structure to be created

This is an object value, with the following properties:

  • amp_html_body - optional nullable string. If set, will be used to create a text/x-amp-html part

  • attachments - optional array of Attachment. Optional list of attachments

  • from - optional nullable FromHeader.

  • headers - optional object. Optional map of headers to include in the message. This is a map of header name to header value

  • html_body - optional nullable string. If set, will be used to create a text/html part

  • reply_to - optional nullable FromHeader.

  • subject - optional nullable string. Set the Subject: header

  • text_body - optional nullable string. If set, will be used to create a text/plain part

Examples

"From: user@example.com\nSubject: Hello\n\nHello there"

{
  "amp_html_body": "string",
  "attachments": [
    {
      "base64": false,
      "content_id": "string",
      "content_type": "string",
      "data": "string",
      "file_name": "string"
    }
  ],
  "from": {
    "email": "sales@sender-example.com",
    "name": "Sales"
  },
  "headers": {
    "X-Tenant": "MyTenant"
  },
  "html_body": "string",
  "reply_to": {
    "email": "sales@sender-example.com",
    "name": "Sales"
  },
  "subject": "string",
  "text_body": "string"
}