Amazon SES · Schema

EmailMessage

Schema for an Amazon SES email message object defining the content structure including simple, raw, and template-based email formats.

EmailEmail DeliverabilityEmail ServiceMarketing EmailNotificationsSMTPTransactional Email

Properties

Name Type Description
Simple object The simple email message with subject and body content.
Raw object The raw email message in MIME format.
Template object The template-based email message.
FromEmailAddress string The email address to use as the From address for the message.
Destination object The recipients of the email message.
ReplyToAddresses array The reply-to email addresses for the message.
ConfigurationSetName string The name of the configuration set to use when sending the email.
View JSON Schema on GitHub

JSON Schema

amazon-ses-emailmessage-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://aws.amazon.com/ses/schemas/emailmessage",
  "title": "EmailMessage",
  "description": "Schema for an Amazon SES email message object defining the content structure including simple, raw, and template-based email formats.",
  "type": "object",
  "properties": {
    "Simple": {
      "type": "object",
      "description": "The simple email message with subject and body content.",
      "properties": {
        "Subject": {
          "type": "object",
          "description": "The subject line of the email.",
          "properties": {
            "Data": {
              "type": "string",
              "description": "The content of the message subject."
            },
            "Charset": {
              "type": "string",
              "description": "The character set for the subject content.",
              "default": "UTF-8"
            }
          },
          "required": ["Data"]
        },
        "Body": {
          "type": "object",
          "description": "The body of the email message.",
          "properties": {
            "Text": {
              "type": "object",
              "description": "The plain text body of the email.",
              "properties": {
                "Data": {
                  "type": "string",
                  "description": "The text content of the body."
                },
                "Charset": {
                  "type": "string",
                  "description": "The character set for the text content.",
                  "default": "UTF-8"
                }
              },
              "required": ["Data"]
            },
            "Html": {
              "type": "object",
              "description": "The HTML body of the email.",
              "properties": {
                "Data": {
                  "type": "string",
                  "description": "The HTML content of the body."
                },
                "Charset": {
                  "type": "string",
                  "description": "The character set for the HTML content.",
                  "default": "UTF-8"
                }
              },
              "required": ["Data"]
            }
          }
        }
      },
      "required": ["Subject", "Body"]
    },
    "Raw": {
      "type": "object",
      "description": "The raw email message in MIME format.",
      "properties": {
        "Data": {
          "type": "string",
          "format": "byte",
          "description": "The raw email message encoded in base64. The message must conform to MIME format."
        }
      },
      "required": ["Data"]
    },
    "Template": {
      "type": "object",
      "description": "The template-based email message.",
      "properties": {
        "TemplateName": {
          "type": "string",
          "description": "The name of the email template to use."
        },
        "TemplateArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the template."
        },
        "TemplateData": {
          "type": "string",
          "description": "A JSON string of replacement values for template variables."
        }
      }
    },
    "FromEmailAddress": {
      "type": "string",
      "format": "email",
      "description": "The email address to use as the From address for the message."
    },
    "Destination": {
      "type": "object",
      "description": "The recipients of the email message.",
      "properties": {
        "ToAddresses": {
          "type": "array",
          "description": "An array of email addresses for the To field.",
          "items": {
            "type": "string",
            "format": "email"
          }
        },
        "CcAddresses": {
          "type": "array",
          "description": "An array of email addresses for the CC field.",
          "items": {
            "type": "string",
            "format": "email"
          }
        },
        "BccAddresses": {
          "type": "array",
          "description": "An array of email addresses for the BCC field.",
          "items": {
            "type": "string",
            "format": "email"
          }
        }
      }
    },
    "ReplyToAddresses": {
      "type": "array",
      "description": "The reply-to email addresses for the message.",
      "items": {
        "type": "string",
        "format": "email"
      }
    },
    "ConfigurationSetName": {
      "type": "string",
      "description": "The name of the configuration set to use when sending the email."
    }
  }
}