Class: Aws::PinpointEmail::Types::GetEmailIdentityResponse

Inherits:

Struct

• Object
• Struct
• Aws::PinpointEmail::Types::GetEmailIdentityResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointemail/types.rb

Overview

Details about an email identity.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dkim_attributes ⇒ Types::DkimAttributes

  An object that contains information about the DKIM attributes for the identity.

• #feedback_forwarding_status ⇒ Boolean

  The feedback forwarding configuration for the identity.

• #identity_type ⇒ String

  The email identity type.

• #mail_from_attributes ⇒ Types::MailFromAttributes

  An object that contains information about the Mail-From attributes for the email identity.

• #tags ⇒ Array<Types::Tag>

  An array of objects that define the tags (keys and values) that are associated with the email identity.

• #verified_for_sending_status ⇒ Boolean

  Specifies whether or not the identity is verified.

Instance Attribute Details

#dkim_attributes ⇒ Types::DkimAttributes

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

Returns:

• (Types::DkimAttributes)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1652

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_status ⇒ Boolean

The feedback forwarding configuration for the identity.

If the value is ‘true`, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to ‘false`, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1652

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#identity_type ⇒ String

The email identity type.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1652

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#mail_from_attributes ⇒ Types::MailFromAttributes

An object that contains information about the Mail-From attributes for the email identity.

Returns:

• (Types::MailFromAttributes)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1652

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An array of objects that define the tags (keys and values) that are associated with the email identity.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1652

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#verified_for_sending_status ⇒ Boolean

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the [Amazon Pinpoint User Guide].

[1]: docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1652

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end