Class: Aws::PinpointEmail::Types::SendEmailRequest

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

Overview

Note:

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

{
  from_email_address: "EmailAddress",
  destination: { # required
    to_addresses: ["EmailAddress"],
    cc_addresses: ["EmailAddress"],
    bcc_addresses: ["EmailAddress"],
  },
  reply_to_addresses: ["EmailAddress"],
  feedback_forwarding_email_address: "EmailAddress",
  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_arn: "TemplateArn",
      template_data: "TemplateData",
    },
  },
  email_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
}

A request to send an email message.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_nameString

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

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#contentTypes::EmailContent

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

Returns:



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#destinationTypes::Destination

An object that contains the recipients of the email message.

Returns:



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#email_tagsArray<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:



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_email_addressString

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

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#from_email_addressString

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)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#reply_to_addressesArray<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>)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3412

class SendEmailRequest < Struct.new(
  :from_email_address,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :content,
  :email_tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end