You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SESV2::Types::SendEmailRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SendEmailRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  from_email_address: "EmailAddress",
  from_email_address_identity_arn: "AmazonResourceName",
  destination: {
    to_addresses: ["EmailAddress"],
    cc_addresses: ["EmailAddress"],
    bcc_addresses: ["EmailAddress"],
  },
  reply_to_addresses: ["EmailAddress"],
  feedback_forwarding_email_address: "EmailAddress",
  feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
  content: { # required
    simple: {
      subject: { # required
        data: "MessageData", # required
        charset: "Charset",
      },
      body: { # required
        text: {
          data: "MessageData", # required
          charset: "Charset",
        },
        html: {
          data: "MessageData", # required
          charset: "Charset",
        },
      },
    },
    raw: {
      data: "data", # required
    },
    template: {
      template_name: "EmailTemplateName",
      template_arn: "AmazonResourceName",
      template_data: "EmailTemplateData",
    },
  },
  email_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
  list_management_options: {
    contact_list_name: "ContactListName", # required
    topic_name: "TopicName",
  },
}

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_name ⇒ String

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

Returns:

  • (String) —

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

#content ⇒ Types::EmailContent

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

Returns:

#destination ⇒ Types::Destination

An object that contains the recipients of the email message.

Returns:

#email_tags ⇒ Array<Types::MessageTag>

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.

Returns:

  • (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation.

#feedback_forwarding_email_address ⇒ String

The address that you want bounce and complaint notifications to be sent to.

Returns:

  • (String) —

    The address that you want bounce and complaint notifications to be sent to.

#feedback_forwarding_email_address_identity_arn ⇒ String

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

  • (String) —

    This parameter is used only for sending authorization.

#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.

Returns:

  • (String) —

    The email address that you want to use as the \"From\" address for the email.

#from_email_address_identity_arn ⇒ String

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

Returns:

  • (String) —

    This parameter is used only for sending authorization.

#list_management_options ⇒ Types::ListManagementOptions

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

Returns:

  • (Types::ListManagementOptions) —

    An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

#reply_to_addresses ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The \"Reply-to\" email addresses for the message.