Class: Aws::Pinpoint::Types::EmailMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  body: "__string",
  feedback_forwarding_address: "__string",
  from_address: "__string",
  raw_email: {
    data: "data",
  },
  reply_to_addresses: ["__string"],
  simple_email: {
    html_part: {
      charset: "__string",
      data: "__string",
    },
    subject: {
      charset: "__string",
      data: "__string",
    },
    text_part: {
      charset: "__string",
      data: "__string",
    },
  },
  substitutions: {
    "__string" => ["__string"],
  },
}

Email Message.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The body of the email message.

Returns:

  • (String)


3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end

#feedback_forwarding_addressString

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

Returns:

  • (String)


3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end

#from_addressString

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

Returns:

  • (String)


3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end

#raw_emailTypes::RawEmail

An email represented as a raw MIME message.

Returns:



3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end

#reply_to_addressesArray<String>

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

Returns:

  • (Array<String>)


3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end

#simple_emailTypes::SimpleEmail

An email composed of a subject, a text part and a html part.

Returns:



3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end

#substitutionsHash<String,Array<String>>

Default message substitutions. Can be overridden by individual address substitutions.

Returns:

  • (Hash<String,Array<String>>)


3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-pinpoint/types.rb', line 3453

class EmailMessage < Struct.new(
  :body,
  :feedback_forwarding_address,
  :from_address,
  :raw_email,
  :reply_to_addresses,
  :simple_email,
  :substitutions)
  include Aws::Structure
end