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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb

Overview

Details about an email identity.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dkim_attributesTypes::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.



2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2000

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_statusBoolean

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)


2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2000

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_typeString

The email identity type.

Returns:

  • (String)


2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2000

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_attributesTypes::MailFromAttributes

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



2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2000

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

#tagsArray<Types::Tag>

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

Returns:



2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2000

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_statusBoolean

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.

Returns:

  • (Boolean)


2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 2000

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