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

Class: Aws::Pinpoint::Types::EmailChannelRequest

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

Overview

Note:

When passing EmailChannelRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  configuration_set: "__string",
  enabled: false,
  from_address: "__string", # required
  identity: "__string", # required
  role_arn: "__string",
}

Specifies the status and settings of the email channel for an application.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set ⇒ String

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

Returns:

  • (String) —

    The [Amazon SES configuration set][1] that you want to apply to messages that you send through the channel.

#enabled ⇒ Boolean

Specifies whether to enable the email channel for the application.

Returns:

  • (Boolean) —

    Specifies whether to enable the email channel for the application.

#from_address ⇒ String

The verified email address that you want to send email from when you send email through the channel.

Returns:

  • (String) —

    The verified email address that you want to send email from when you send email through the channel.

#identity ⇒ String

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

#role_arn ⇒ String

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

Returns:

  • (String) —

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.