Class GetEmailIdentityResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetEmailIdentityResponse.Builder,
GetEmailIdentityResponse>
Details about an email identity.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The configuration set used by default when sending from this identity.final DkimAttributes
An object that contains information about the DKIM attributes for the identity.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
The feedback forwarding configuration for the identity.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Policies property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final IdentityType
The email identity type.final String
The email identity type.final MailFromAttributes
An object that contains information about the Mail-From attributes for the email identity.policies()
A map of policy names to policies.static Class
<? extends GetEmailIdentityResponse.Builder> tags()
An array of objects that define the tags (keys and values) that are associated with the email identity.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VerificationInfo
An object that contains additional information about the verification status for the identity.final VerificationStatus
The verification status of the identity.final String
The verification status of the identity.final Boolean
Specifies whether or not the identity is verified.Methods inherited from class software.amazon.awssdk.services.sesv2.model.SesV2Response
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identityType
The email identity type. Note: the
MANAGED_DOMAIN
identity type is not supported.If the service returns an enum value that is not available in the current SDK version,
identityType
will returnIdentityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityTypeAsString()
.- Returns:
- The email identity type. Note: the
MANAGED_DOMAIN
identity type is not supported. - See Also:
-
identityTypeAsString
The email identity type. Note: the
MANAGED_DOMAIN
identity type is not supported.If the service returns an enum value that is not available in the current SDK version,
identityType
will returnIdentityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityTypeAsString()
.- Returns:
- The email identity type. Note: the
MANAGED_DOMAIN
identity type is not supported. - See Also:
-
feedbackForwardingStatus
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 theReturn-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:
- 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 theReturn-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).
-
verifiedForSendingStatus
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:
- 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.
-
dkimAttributes
An object that contains information about the DKIM attributes for the identity.
- Returns:
- An object that contains information about the DKIM attributes for the identity.
-
mailFromAttributes
An object that contains information about the Mail-From attributes for the email identity.
- Returns:
- An object that contains information about the Mail-From attributes for the email identity.
-
hasPolicies
public final boolean hasPolicies()For responses, this returns true if the service returned a value for the Policies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
policies
A map of policy names to policies.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPolicies()
method.- Returns:
- A map of policy names to policies.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
An array of objects that define the tags (keys and values) that are associated with the email identity.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- An array of objects that define the tags (keys and values) that are associated with the email identity.
-
configurationSetName
The configuration set used by default when sending from this identity.
- Returns:
- The configuration set used by default when sending from this identity.
-
verificationStatus
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.
If the service returns an enum value that is not available in the current SDK version,
verificationStatus
will returnVerificationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverificationStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
verificationStatusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
verificationStatus
will returnVerificationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverificationStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
verificationInfo
An object that contains additional information about the verification status for the identity.
- Returns:
- An object that contains additional information about the verification status for the identity.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetEmailIdentityResponse.Builder,
GetEmailIdentityResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-