Class ReceiptAction

java.lang.Object
software.amazon.awssdk.services.ses.model.ReceiptAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReceiptAction.Builder,ReceiptAction>
@Generated("software.amazon.awssdk:codegen") public final class ReceiptAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReceiptAction.Builder,ReceiptAction>

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

See Also:

  • Method Details

    • s3Action

      public final S3Action s3Action()

      Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

      Returns:
      Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

    • bounceAction

      public final BounceAction bounceAction()

      Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

      Returns:
      Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    • workmailAction

      public final WorkmailAction workmailAction()

      Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

      Returns:
      Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

    • lambdaAction

      public final LambdaAction lambdaAction()

      Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.

      Returns:
      Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.

    • stopAction

      public final StopAction stopAction()

      Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

      Returns:
      Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

    • addHeaderAction

      public final AddHeaderAction addHeaderAction()

      Adds a header to the received email.

      Returns:
      Adds a header to the received email.

    • snsAction

      public final SNSAction snsAction()

      Publishes the email content within a notification to Amazon SNS.

      Returns:
      Publishes the email content within a notification to Amazon SNS.

    • toBuilder

      public ReceiptAction.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ReceiptAction.Builder,ReceiptAction>
      Returns:
      a builder for type T

    • builder

      public static ReceiptAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReceiptAction.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.