Package software.amazon.awssdk.services.sesv2.model

Class GetEmailIdentityResponse

    • Method Detail

      • identityType

        public final IdentityType 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 return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().

        Returns:
        The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
        See Also:
        IdentityType

      • identityTypeAsString

        public final String 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 return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().

        Returns:
        The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
        See Also:
        IdentityType

      • feedbackForwardingStatus

        public final 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).

        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).

      • verifiedForSendingStatus

        public final 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.

        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

        public final DkimAttributes 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

        public final MailFromAttributes 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 the isEmpty() 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

        public final Map<String,​String> 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 the isEmpty() 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

        public final List<Tag> 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

        public final String 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

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, verificationStatus will return VerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationStatusAsString().

        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

      • verificationStatusAsString

        public final String 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 return VerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationStatusAsString().

        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

      • verificationInfo

        public final VerificationInfo 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.

      • toString

        public final 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