Interface EmailChannelResponse.Builder

    • Method Detail

      • applicationId

        EmailChannelResponse.Builder applicationId​(String applicationId)

        The unique identifier for the application that the email channel applies to.

        Parameters:
        applicationId - The unique identifier for the application that the email channel applies to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • creationDate

        EmailChannelResponse.Builder creationDate​(String creationDate)

        The date and time, in ISO 8601 format, when the email channel was enabled.

        Parameters:
        creationDate - The date and time, in ISO 8601 format, when the email channel was enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • enabled

        EmailChannelResponse.Builder enabled​(Boolean enabled)

        Specifies whether the email channel is enabled for the application.

        Parameters:
        enabled - Specifies whether the email channel is enabled for the application.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • fromAddress

        EmailChannelResponse.Builder fromAddress​(String fromAddress)

        The verified email address that email is sent from when you send email through the channel.

        Parameters:
        fromAddress - The verified email address that email is sent from when you send email through the channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • hasCredential

        EmailChannelResponse.Builder hasCredential​(Boolean hasCredential)

        (Not used) This property is retained only for backward compatibility.

        Parameters:
        hasCredential - (Not used) This property is retained only for backward compatibility.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • id

        EmailChannelResponse.Builder id​(String id)

        (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

        Parameters:
        id - (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • identity

        EmailChannelResponse.Builder identity​(String identity)

        The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

        Parameters:
        identity -

        The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isArchived

        EmailChannelResponse.Builder isArchived​(Boolean isArchived)

        Specifies whether the email channel is archived.

        Parameters:
        isArchived - Specifies whether the email channel is archived.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastModifiedBy

        EmailChannelResponse.Builder lastModifiedBy​(String lastModifiedBy)

        The user who last modified the email channel.

        Parameters:
        lastModifiedBy - The user who last modified the email channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastModifiedDate

        EmailChannelResponse.Builder lastModifiedDate​(String lastModifiedDate)

        The date and time, in ISO 8601 format, when the email channel was last modified.

        Parameters:
        lastModifiedDate - The date and time, in ISO 8601 format, when the email channel was last modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • messagesPerSecond

        EmailChannelResponse.Builder messagesPerSecond​(Integer messagesPerSecond)

        The maximum number of emails that can be sent through the channel each second.

        Parameters:
        messagesPerSecond - The maximum number of emails that can be sent through the channel each second.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • platform

        EmailChannelResponse.Builder platform​(String platform)

        The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

        Parameters:
        platform - The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • roleArn

        EmailChannelResponse.Builder roleArn​(String roleArn)

        The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

        Parameters:
        roleArn -

        The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • orchestrationSendingRoleArn

        EmailChannelResponse.Builder orchestrationSendingRoleArn​(String orchestrationSendingRoleArn)

        The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

        Parameters:
        orchestrationSendingRoleArn - The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • version

        EmailChannelResponse.Builder version​(Integer version)

        The current version of the email channel.

        Parameters:
        version - The current version of the email channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.