Interface GetEmailIdentityResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>, SdkBuilder<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>, SdkPojo, SdkResponse.Builder, SesV2Response.Builder
Enclosing class:
GetEmailIdentityResponse

public static interface GetEmailIdentityResponse.Builder extends SesV2Response.Builder, SdkPojo, CopyableBuilder<GetEmailIdentityResponse.Builder,GetEmailIdentityResponse>
  • Method Details

    • 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

      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:
    • 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.
    • dkimAttributes

      default GetEmailIdentityResponse.Builder dkimAttributes(Consumer<DkimAttributes.Builder> dkimAttributes)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dkimAttributes(DkimAttributes).

      Parameters:
      dkimAttributes - a consumer that will call methods on DkimAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • mailFromAttributes

      default GetEmailIdentityResponse.Builder mailFromAttributes(Consumer<MailFromAttributes.Builder> mailFromAttributes)

      An object that contains information about the Mail-From attributes for the email identity.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mailFromAttributes(MailFromAttributes).

      Parameters:
      mailFromAttributes - a consumer that will call methods on MailFromAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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

      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

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

      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:
    • 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

      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:
    • 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.
    • verificationInfo

      default GetEmailIdentityResponse.Builder verificationInfo(Consumer<VerificationInfo.Builder> verificationInfo)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationInfo(VerificationInfo).

      Parameters:
      verificationInfo - a consumer that will call methods on VerificationInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: