Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint-email ]

send-email

Description

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.
  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-email
[--from-email-address <value>]
--destination <value>
[--reply-to-addresses <value>]
[--feedback-forwarding-email-address <value>]
--content <value>
[--email-tags <value>]
[--configuration-set-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--from-email-address (string)

The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

--destination (structure)

An object that contains the recipients of the email message.

Shorthand Syntax:

ToAddresses=string,string,CcAddresses=string,string,BccAddresses=string,string

JSON Syntax:

{
  "ToAddresses": ["string", ...],
  "CcAddresses": ["string", ...],
  "BccAddresses": ["string", ...]
}

--reply-to-addresses (list)

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Syntax:

"string" "string" ...

--feedback-forwarding-email-address (string)

The address that Amazon Pinpoint should send bounce and complaint notifications to.

--content (structure)

An object that contains the body of the message. You can send either a Simple message or a Raw message.

JSON Syntax:

{
  "Simple": {
    "Subject": {
      "Data": "string",
      "Charset": "string"
    },
    "Body": {
      "Text": {
        "Data": "string",
        "Charset": "string"
      },
      "Html": {
        "Data": "string",
        "Charset": "string"
      }
    }
  },
  "Raw": {
    "Data": blob
  },
  "Template": {
    "TemplateArn": "string",
    "TemplateData": "string"
  }
}

--email-tags (list)

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--configuration-set-name (string)

The name of the configuration set that you want to use when sending the email.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

MessageId -> (string)

A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.

Note

It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.