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

Class: Aws::Pinpoint::Types::EmailChannelResponse

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

Overview

Provides information about the status and settings of the email channel for an application.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The unique identifier for the application that the email channel applies to.

Returns:

  • (String)

    The unique identifier for the application that the email channel applies to.

#configuration_setString

The configuration set that\'s applied to email that\'s sent through the channel by using the Amazon Pinpoint Email API.

Returns:

  • (String)

    The configuration set that\'s applied to email that\'s sent through the channel by using the Amazon Pinpoint Email API.

#creation_dateString

The date and time, in ISO 8601 format, when the email channel was enabled.

Returns:

  • (String)

    The date and time, in ISO 8601 format, when the email channel was enabled.

#enabledBoolean

Specifies whether the email channel is enabled for the application.

Returns:

  • (Boolean)

    Specifies whether the email channel is enabled for the application.

#from_addressString

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

Returns:

  • (String)

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

#has_credentialBoolean

(Not used) This property is retained only for backward compatibility.

Returns:

  • (Boolean)

    (Not used) This property is retained only for backward compatibility.

#idString

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

Returns:

  • (String)

    (Deprecated) An identifier for the email channel.

#identityString

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you 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 use when you send email through the channel.

#is_archivedBoolean

Specifies whether the email channel is archived.

Returns:

  • (Boolean)

    Specifies whether the email channel is archived.

#last_modified_byString

The user who last modified the email channel.

Returns:

  • (String)

    The user who last modified the email channel.

#last_modified_dateString

The date and time, in ISO 8601 format, when the email channel was last modified.

Returns:

  • (String)

    The date and time, in ISO 8601 format, when the email channel was last modified.

#messages_per_secondInteger

The maximum number of emails that you can send through the channel each second.

Returns:

  • (Integer)

    The maximum number of emails that you can send through the channel each second.

#platformString

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

Returns:

  • (String)

    The type of messaging or notification platform for the channel.

#role_arnString

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

Returns:

  • (String)

    The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

#versionInteger

The current version of the email channel.

Returns:

  • (Integer)

    The current version of the email channel.