Class ReceiptAction
- java.lang.Object
-
- com.amazonaws.services.simpleemail.model.ReceiptAction
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ReceiptAction extends Object implements Serializable, Cloneable
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ReceiptAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReceiptAction
clone()
boolean
equals(Object obj)
AddHeaderAction
getAddHeaderAction()
Adds a header to the received email.BounceAction
getBounceAction()
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).LambdaAction
getLambdaAction()
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.S3Action
getS3Action()
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.SNSAction
getSNSAction()
Publishes the email content within a notification to Amazon SNS.StopAction
getStopAction()
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.WorkmailAction
getWorkmailAction()
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.int
hashCode()
void
setAddHeaderAction(AddHeaderAction addHeaderAction)
Adds a header to the received email.void
setBounceAction(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).void
setLambdaAction(LambdaAction lambdaAction)
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.void
setS3Action(S3Action s3Action)
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.void
setSNSAction(SNSAction sNSAction)
Publishes the email content within a notification to Amazon SNS.void
setStopAction(StopAction stopAction)
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.void
setWorkmailAction(WorkmailAction workmailAction)
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.String
toString()
Returns a string representation of this object; useful for testing and debugging.ReceiptAction
withAddHeaderAction(AddHeaderAction addHeaderAction)
Adds a header to the received email.ReceiptAction
withBounceAction(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).ReceiptAction
withLambdaAction(LambdaAction lambdaAction)
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.ReceiptAction
withS3Action(S3Action s3Action)
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.ReceiptAction
withSNSAction(SNSAction sNSAction)
Publishes the email content within a notification to Amazon SNS.ReceiptAction
withStopAction(StopAction stopAction)
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.ReceiptAction
withWorkmailAction(WorkmailAction workmailAction)
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
-
-
-
Method Detail
-
setS3Action
public void setS3Action(S3Action s3Action)
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- Parameters:
s3Action
- Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
-
getS3Action
public S3Action getS3Action()
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.
-
withS3Action
public ReceiptAction withS3Action(S3Action s3Action)
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- Parameters:
s3Action
- Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBounceAction
public void setBounceAction(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).
- Parameters:
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).
-
getBounceAction
public BounceAction getBounceAction()
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).
-
withBounceAction
public ReceiptAction withBounceAction(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).
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkmailAction
public void setWorkmailAction(WorkmailAction workmailAction)
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- Parameters:
workmailAction
- Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
-
getWorkmailAction
public WorkmailAction getWorkmailAction()
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- Returns:
- Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
-
withWorkmailAction
public ReceiptAction withWorkmailAction(WorkmailAction workmailAction)
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- Parameters:
workmailAction
- Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLambdaAction
public void setLambdaAction(LambdaAction lambdaAction)
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- Parameters:
lambdaAction
- Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
-
getLambdaAction
public LambdaAction getLambdaAction()
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- Returns:
- Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
-
withLambdaAction
public ReceiptAction withLambdaAction(LambdaAction lambdaAction)
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- Parameters:
lambdaAction
- Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStopAction
public void setStopAction(StopAction stopAction)
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- Parameters:
stopAction
- Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
-
getStopAction
public StopAction getStopAction()
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.
-
withStopAction
public ReceiptAction withStopAction(StopAction stopAction)
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- Parameters:
stopAction
- Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAddHeaderAction
public void setAddHeaderAction(AddHeaderAction addHeaderAction)
Adds a header to the received email.
- Parameters:
addHeaderAction
- Adds a header to the received email.
-
getAddHeaderAction
public AddHeaderAction getAddHeaderAction()
Adds a header to the received email.
- Returns:
- Adds a header to the received email.
-
withAddHeaderAction
public ReceiptAction withAddHeaderAction(AddHeaderAction addHeaderAction)
Adds a header to the received email.
- Parameters:
addHeaderAction
- Adds a header to the received email.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSNSAction
public void setSNSAction(SNSAction sNSAction)
Publishes the email content within a notification to Amazon SNS.
- Parameters:
sNSAction
- Publishes the email content within a notification to Amazon SNS.
-
getSNSAction
public SNSAction getSNSAction()
Publishes the email content within a notification to Amazon SNS.
- Returns:
- Publishes the email content within a notification to Amazon SNS.
-
withSNSAction
public ReceiptAction withSNSAction(SNSAction sNSAction)
Publishes the email content within a notification to Amazon SNS.
- Parameters:
sNSAction
- Publishes the email content within a notification to Amazon SNS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ReceiptAction clone()
-
-