AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EmailMessage as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The body of the email message.

Returns:

  • (String)

    The body of the email message.

#feedback_forwarding_addressString

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

Returns:

  • (String)

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

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

    The verified email address to send the email message from.

#raw_emailTypes::RawEmail

The email message, represented as a raw MIME message.

Returns:

  • (Types::RawEmail)

    The email message, represented as a raw MIME message.

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

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

#simple_emailTypes::SimpleEmail

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

Returns:

  • (Types::SimpleEmail)

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

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

    The default message variables to use in the email message.