GetEmailIdentityResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.simpleemailv2.model

Class GetEmailIdentityResult

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.simpleemailv2.model.GetEmailIdentityResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetEmailIdentityResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Details about an email identity.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetEmailIdentityResult ()

Constructors
Constructor and Description
`GetEmailIdentityResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`GetEmailIdentityResult`	`addPoliciesEntry (String key, String value)` Add a single Policies entry
`GetEmailIdentityResult`	`clearPoliciesEntries ()` Removes all the entries added into Policies.
`GetEmailIdentityResult`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getConfigurationSetName ()` The configuration set used by default when sending from this identity.
`DkimAttributes`	`getDkimAttributes ()` An object that contains information about the DKIM attributes for the identity.
`Boolean`	`getFeedbackForwardingStatus ()` The feedback forwarding configuration for the identity.
`String`	`getIdentityType ()` The email identity type.
`MailFromAttributes`	`getMailFromAttributes ()` An object that contains information about the Mail-From attributes for the email identity.
`Map<String,String>`	`getPolicies ()` A map of policy names to policies.
`List<Tag>`	`getTags ()` An array of objects that define the tags (keys and values) that are associated with the email identity.
`VerificationInfo`	`getVerificationInfo ()` An object that contains additional information about the verification status for the identity.
`String`	`getVerificationStatus ()` The verification status of the identity.
`Boolean`	`getVerifiedForSendingStatus ()` Specifies whether or not the identity is verified.
`int`	`hashCode ()`
`Boolean`	`isFeedbackForwardingStatus ()` The feedback forwarding configuration for the identity.
`Boolean`	`isVerifiedForSendingStatus ()` Specifies whether or not the identity is verified.
`void`	`setConfigurationSetName (String configurationSetName)` The configuration set used by default when sending from this identity.
`void`	`setDkimAttributes (DkimAttributes dkimAttributes)` An object that contains information about the DKIM attributes for the identity.
`void`	`setFeedbackForwardingStatus (Boolean feedbackForwardingStatus)` The feedback forwarding configuration for the identity.
`void`	`setIdentityType (String identityType)` The email identity type.
`void`	`setMailFromAttributes (MailFromAttributes mailFromAttributes)` An object that contains information about the Mail-From attributes for the email identity.
`void`	`setPolicies (Map<String,String> policies)` A map of policy names to policies.
`void`	`setTags (Collection<Tag> tags)` An array of objects that define the tags (keys and values) that are associated with the email identity.
`void`	`setVerificationInfo (VerificationInfo verificationInfo)` An object that contains additional information about the verification status for the identity.
`void`	`setVerificationStatus (String verificationStatus)` The verification status of the identity.
`void`	`setVerifiedForSendingStatus (Boolean verifiedForSendingStatus)` Specifies whether or not the identity is verified.
`String`	`toString ()` Returns a string representation of this object.
`GetEmailIdentityResult`	`withConfigurationSetName (String configurationSetName)` The configuration set used by default when sending from this identity.
`GetEmailIdentityResult`	`withDkimAttributes (DkimAttributes dkimAttributes)` An object that contains information about the DKIM attributes for the identity.
`GetEmailIdentityResult`	`withFeedbackForwardingStatus (Boolean feedbackForwardingStatus)` The feedback forwarding configuration for the identity.
`GetEmailIdentityResult`	`withIdentityType (IdentityType identityType)` The email identity type.
`GetEmailIdentityResult`	`withIdentityType (String identityType)` The email identity type.
`GetEmailIdentityResult`	`withMailFromAttributes (MailFromAttributes mailFromAttributes)` An object that contains information about the Mail-From attributes for the email identity.
`GetEmailIdentityResult`	`withPolicies (Map<String,String> policies)` A map of policy names to policies.
`GetEmailIdentityResult`	`withTags (Collection<Tag> tags)` An array of objects that define the tags (keys and values) that are associated with the email identity.
`GetEmailIdentityResult`	`withTags (Tag... tags)` An array of objects that define the tags (keys and values) that are associated with the email identity.
`GetEmailIdentityResult`	`withVerificationInfo (VerificationInfo verificationInfo)` An object that contains additional information about the verification status for the identity.
`GetEmailIdentityResult`	`withVerificationStatus (String verificationStatus)` The verification status of the identity.
`GetEmailIdentityResult`	`withVerificationStatus (VerificationStatus verificationStatus)` The verification status of the identity.
`GetEmailIdentityResult`	`withVerifiedForSendingStatus (Boolean verifiedForSendingStatus)` Specifies whether or not the identity is verified.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetEmailIdentityResult
```
public GetEmailIdentityResult()
```
- Method Detail
  - setIdentityType
```
public void setIdentityType(String identityType)
```
    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    Parameters:
    
    identityType - The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    See Also:
    
    IdentityType
  - getIdentityType
```
public String getIdentityType()
```
    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    Returns:
    
    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    See Also:
    
    IdentityType
  - withIdentityType
```
public GetEmailIdentityResult withIdentityType(String identityType)
```
    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    Parameters:
    
    identityType - The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityType
  - withIdentityType
```
public GetEmailIdentityResult withIdentityType(IdentityType identityType)
```
    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    Parameters:
    
    identityType - The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityType
  - setFeedbackForwardingStatus
```
public void setFeedbackForwardingStatus(Boolean 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 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).
    
    Parameters:
    
    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 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).
  - getFeedbackForwardingStatus
```
public Boolean getFeedbackForwardingStatus()
```
    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:
    
    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).
  - withFeedbackForwardingStatus
```
public GetEmailIdentityResult withFeedbackForwardingStatus(Boolean 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 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).
    
    Parameters:
    
    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 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFeedbackForwardingStatus
```
public Boolean isFeedbackForwardingStatus()
```
    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:
    
    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).
  - setVerifiedForSendingStatus
```
public void setVerifiedForSendingStatus(Boolean 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.
    
    Parameters:
    
    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.
  - getVerifiedForSendingStatus
```
public Boolean getVerifiedForSendingStatus()
```
    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.
  - withVerifiedForSendingStatus
```
public GetEmailIdentityResult withVerifiedForSendingStatus(Boolean 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isVerifiedForSendingStatus
```
public Boolean isVerifiedForSendingStatus()
```
    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.
  - setDkimAttributes
```
public void setDkimAttributes(DkimAttributes dkimAttributes)
```
    An object that contains information about the DKIM attributes for the identity.
    
    Parameters:
    
    dkimAttributes - An object that contains information about the DKIM attributes for the identity.
  - getDkimAttributes
```
public DkimAttributes getDkimAttributes()
```
    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.
  - withDkimAttributes
```
public GetEmailIdentityResult withDkimAttributes(DkimAttributes dkimAttributes)
```
    An object that contains information about the DKIM attributes for the identity.
    
    Parameters:
    
    dkimAttributes - An object that contains information about the DKIM attributes for the identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMailFromAttributes
```
public void setMailFromAttributes(MailFromAttributes mailFromAttributes)
```
    An object that contains information about the Mail-From attributes for the email identity.
    
    Parameters:
    
    mailFromAttributes - An object that contains information about the Mail-From attributes for the email identity.
  - getMailFromAttributes
```
public MailFromAttributes getMailFromAttributes()
```
    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.
  - withMailFromAttributes
```
public GetEmailIdentityResult withMailFromAttributes(MailFromAttributes mailFromAttributes)
```
    An object that contains information about the Mail-From attributes for the email identity.
    
    Parameters:
    
    mailFromAttributes - An object that contains information about the Mail-From attributes for the email identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPolicies
```
public Map<String,String> getPolicies()
```
    A map of policy names to policies.
    
    Returns:
    
    A map of policy names to policies.
  - setPolicies
```
public void setPolicies(Map<String,String> policies)
```
    A map of policy names to policies.
    
    Parameters:
    
    policies - A map of policy names to policies.
  - withPolicies
```
public GetEmailIdentityResult withPolicies(Map<String,String> policies)
```
    A map of policy names to policies.
    
    Parameters:
    
    policies - A map of policy names to policies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addPoliciesEntry
```
public GetEmailIdentityResult addPoliciesEntry(String key,
 String value)
```
    Add a single Policies entry
    
    See Also:
    
    withPolicies(java.util.Map<java.lang.String, java.lang.String>)
  - clearPoliciesEntries
```
public GetEmailIdentityResult clearPoliciesEntries()
```
    Removes all the entries added into Policies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    An array of objects that define the tags (keys and values) that are associated with the email identity.
    
    Returns:
    
    An array of objects that define the tags (keys and values) that are associated with the email identity.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    An array of objects that define the tags (keys and values) that are associated with the email identity.
    
    Parameters:
    
    tags - An array of objects that define the tags (keys and values) that are associated with the email identity.
  - withTags
```
public GetEmailIdentityResult withTags(Tag... tags)
```
    An array of objects that define the tags (keys and values) that are associated with the email identity.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - An array of objects that define the tags (keys and values) that are associated with the email identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public GetEmailIdentityResult withTags(Collection<Tag> tags)
```
    An array of objects that define the tags (keys and values) that are associated with the email identity.
    
    Parameters:
    
    tags - An array of objects that define the tags (keys and values) that are associated with the email identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfigurationSetName
```
public void setConfigurationSetName(String configurationSetName)
```
    The configuration set used by default when sending from this identity.
    
    Parameters:
    
    configurationSetName - The configuration set used by default when sending from this identity.
  - getConfigurationSetName
```
public String getConfigurationSetName()
```
    The configuration set used by default when sending from this identity.
    
    Returns:
    
    The configuration set used by default when sending from this identity.
  - withConfigurationSetName
```
public GetEmailIdentityResult withConfigurationSetName(String configurationSetName)
```
    The configuration set used by default when sending from this identity.
    
    Parameters:
    
    configurationSetName - The configuration set used by default when sending from this identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVerificationStatus
```
public void setVerificationStatus(String 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.
    Parameters:
    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.
    See Also:
    
    VerificationStatus
  - getVerificationStatus
```
public String getVerificationStatus()
```
    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:
    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:
    
    VerificationStatus
  - withVerificationStatus
```
public GetEmailIdentityResult withVerificationStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerificationStatus
  - withVerificationStatus
```
public GetEmailIdentityResult withVerificationStatus(VerificationStatus 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerificationStatus
  - setVerificationInfo
```
public void setVerificationInfo(VerificationInfo verificationInfo)
```
    An object that contains additional information about the verification status for the identity.
    
    Parameters:
    
    verificationInfo - An object that contains additional information about the verification status for the identity.
  - getVerificationInfo
```
public VerificationInfo getVerificationInfo()
```
    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.
  - withVerificationInfo
```
public GetEmailIdentityResult withVerificationInfo(VerificationInfo verificationInfo)
```
    An object that contains additional information about the verification status for the identity.
    
    Parameters:
    
    verificationInfo - An object that contains additional information about the verification status for the identity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetEmailIdentityResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class GetEmailIdentityResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetEmailIdentityResult

Method Detail

setIdentityType

getIdentityType

withIdentityType

withIdentityType

setFeedbackForwardingStatus

getFeedbackForwardingStatus

withFeedbackForwardingStatus

isFeedbackForwardingStatus

setVerifiedForSendingStatus

getVerifiedForSendingStatus

withVerifiedForSendingStatus

isVerifiedForSendingStatus

setDkimAttributes

getDkimAttributes

withDkimAttributes

setMailFromAttributes

getMailFromAttributes

withMailFromAttributes

getPolicies

setPolicies

withPolicies

addPoliciesEntry

clearPoliciesEntries

getTags

setTags

withTags

withTags

setConfigurationSetName

getConfigurationSetName

withConfigurationSetName

setVerificationStatus

getVerificationStatus

withVerificationStatus

withVerificationStatus

setVerificationInfo

getVerificationInfo

withVerificationInfo

toString

equals

hashCode

clone