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

Interface GetEmailIdentityResponse.Builder

    • Method Detail

      • identityType

        GetEmailIdentityResponse.Builder identityType​(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, IdentityType

      • identityType

        GetEmailIdentityResponse.Builder identityType​(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, IdentityType

      • feedbackForwardingStatus

        GetEmailIdentityResponse.Builder feedbackForwardingStatus​(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.

      • verifiedForSendingStatus

        GetEmailIdentityResponse.Builder verifiedForSendingStatus​(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.

      • dkimAttributes

        GetEmailIdentityResponse.Builder dkimAttributes​(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.

      • mailFromAttributes

        GetEmailIdentityResponse.Builder mailFromAttributes​(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.

      • policies

        GetEmailIdentityResponse.Builder policies​(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.

      • tags

        GetEmailIdentityResponse.Builder tags​(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.

      • tags

        GetEmailIdentityResponse.Builder tags​(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.

      • tags

        GetEmailIdentityResponse.Builder tags​(Consumer<Tag.Builder>... tags)

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

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • configurationSetName

        GetEmailIdentityResponse.Builder configurationSetName​(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.

      • verificationStatus

        GetEmailIdentityResponse.Builder verificationStatus​(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, VerificationStatus

      • verificationStatus

        GetEmailIdentityResponse.Builder verificationStatus​(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, VerificationStatus

      • verificationInfo

        GetEmailIdentityResponse.Builder verificationInfo​(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.