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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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"],
  },
}

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The body of the email message.

Returns:

  • (String)


6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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

#feedback_forwarding_addressString

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

Returns:

  • (String)


6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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

#from_addressString

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

Returns:

  • (String)


6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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

#raw_emailTypes::RawEmail

The email message, represented as a raw MIME message.

Returns:



6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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

#reply_to_addressesArray<String>

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

Returns:

  • (Array<String>)


6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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

#simple_emailTypes::SimpleEmail

The email message, composed of a subject, a text part, and an HTML part.

Returns:



6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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

#substitutionsHash<String,Array<String>>

The default message variables to use in the email message. You can override the default variables with individual address variables.

Returns:

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


6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6232

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