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

Class: Aws::SES::Types::SendEmailRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass SendEmailRequest data as a hash:

{
  source: "Address", # required
  destination: { # required
    to_addresses: ["Address"],
    cc_addresses: ["Address"],
    bcc_addresses: ["Address"],
  },
  message: { # required
    subject: { # required
      data: "MessageData", # required
      charset: "Charset",
    },
    body: { # required
      text: {
        data: "MessageData", # required
        charset: "Charset",
      },
      html: {
        data: "MessageData", # required
        charset: "Charset",
      },
    },
  },
  reply_to_addresses: ["Address"],
  return_path: "Address",
  source_arn: "AmazonResourceName",
  return_path_arn: "AmazonResourceName",
  tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_nameString

The name of the configuration set to use when you send an email using SendEmail.

Returns:

  • (String)


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#destinationTypes::Destination

The destination for this email, composed of To:, CC:, and BCC: fields.

Returns:



4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#messageTypes::Message

The message to be sent.

Returns:



4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#reply_to_addressesArray<String>

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Returns:

  • (Array<String>)


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#return_pathString

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Returns:

  • (String)


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#return_path_arnString

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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

Returns:

  • (String)


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#sourceString

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Returns:

  • (String)


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#source_arnString

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 send for the email address specified in the Source 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 send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

Returns:

  • (String)


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#tagsArray<Types::MessageTag>

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

Returns:



4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4320

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end