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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EmailMessage

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  The body of the email message.

• #feedback_forwarding_address ⇒ String

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

• #from_address ⇒ String

  The verified email address to send the email message from.

• #raw_email ⇒ Types::RawEmail

  The email message, represented as a raw MIME message.

• #reply_to_addresses ⇒ Array<String>

  The reply-to email address(es) for the email message.

• #simple_email ⇒ Types::SimpleEmail

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

• #substitutions ⇒ Hash<String,Array<String>>

  The default message variables to use in the email message.

Instance Attribute Details

#body ⇒ String

The body of the email message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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_address ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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

#from_address ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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

#raw_email ⇒ Types::RawEmail

The email message, represented as a raw MIME message.

Returns:

• (Types::RawEmail)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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_addresses ⇒ Array<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>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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

#simple_email ⇒ Types::SimpleEmail

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

Returns:

• (Types::SimpleEmail)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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

#substitutions ⇒ Hash<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>>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4319

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