Package software.amazon.awssdk.services.ses.model

Interface ReceiptRule.Builder

    • Method Detail

      • name

        ReceiptRule.Builder name​(String name)

        The name of the receipt rule. The name must meet the following requirements:

        • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).

        • Start and end with a letter or number.

        • Contain 64 characters or fewer.

        Parameters:
        name - The name of the receipt rule. The name must meet the following requirements:

        • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).

        • Start and end with a letter or number.

        • Contain 64 characters or fewer.

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

      • enabled

        ReceiptRule.Builder enabled​(Boolean enabled)

        If true, the receipt rule is active. The default value is false.

        Parameters:
        enabled - If true, the receipt rule is active. The default value is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tlsPolicy

        ReceiptRule.Builder tlsPolicy​(String tlsPolicy)

        Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.

        Parameters:
        tlsPolicy - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TlsPolicy, TlsPolicy

      • tlsPolicy

        ReceiptRule.Builder tlsPolicy​(TlsPolicy tlsPolicy)

        Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.

        Parameters:
        tlsPolicy - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TlsPolicy, TlsPolicy

      • recipients

        ReceiptRule.Builder recipients​(Collection<String> recipients)

        The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.

        Parameters:
        recipients - The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recipients

        ReceiptRule.Builder recipients​(String... recipients)

        The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.

        Parameters:
        recipients - The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actions

        ReceiptRule.Builder actions​(Collection<ReceiptAction> actions)

        An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

        Parameters:
        actions - An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actions

        ReceiptRule.Builder actions​(ReceiptAction... actions)

        An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

        Parameters:
        actions - An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actions

        ReceiptRule.Builder actions​(Consumer<ReceiptAction.Builder>... actions)

        An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

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

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

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

      • scanEnabled

        ReceiptRule.Builder scanEnabled​(Boolean scanEnabled)

        If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

        Parameters:
        scanEnabled - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.