Class: Aws::SESV2::Types::GetEmailIdentityResponse

Inherits:

Struct

• Object
• Struct
• Aws::SESV2::Types::GetEmailIdentityResponse

Defined in:

gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

Overview

Details about an email identity.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration_set_name ⇒ String

  The configuration set used by default when sending from this identity.

• #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.

• #policies ⇒ Hash<String,String>

  A map of policy names to policies.

• #tags ⇒ Array<Types::Tag>

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

• #verification_info ⇒ Types::VerificationInfo

  An object that contains additional information about the verification status for the identity.

• #verification_status ⇒ String

  The verification status of the identity.

• #verified_for_sending_status ⇒ Boolean

  Specifies whether or not the identity is verified.

Instance Attribute Details

#configuration_set_name ⇒ String

The configuration set used by default when sending from this identity.

Returns:

• (String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#dkim_attributes ⇒ Types::DkimAttributes

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

Returns:

• (Types::DkimAttributes)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#feedback_forwarding_status ⇒ Boolean

The feedback forwarding configuration for the identity.

If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

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 (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Returns:

• (Boolean)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#identity_type ⇒ String

The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

Returns:

• (String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  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 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#policies ⇒ Hash<String,String>

A map of policy names to policies.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  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 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#verification_info ⇒ Types::VerificationInfo

An object that contains additional information about the verification status for the identity.

Returns:

• (Types::VerificationInfo)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#verification_status ⇒ String

The verification status of the identity. The status can be one of the following:

• PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity.

• SUCCESS – The verification process completed successfully.

• FAILED – The verification process failed.

• TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification status of the identity.

• NOT_STARTED – The verification process hasn't been initiated for the identity.

Returns:

• (String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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

#verified_for_sending_status ⇒ Boolean

Specifies whether or not the identity is verified. 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)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3410

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