/* * Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.simpleemail.model; import java.io.Serializable; /** *

* When included in a receipt rule, this action rejects the received email by * returning a bounce response to the sender and, optionally, publishes a * notification to Amazon Simple Notification Service (Amazon SNS). *

* For information about sending a bounce message in response to a received * email, see the Amazon SES Developer Guide. *

*/ public class BounceAction implements Serializable { /** *

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the * bounce action is taken. An example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon * SNS Developer Guide. *

*/ private String topicArn; /** *

* The SMTP reply code, as defined by RFC 5321. *

*/ private String smtpReplyCode; /** *

* The SMTP enhanced status code, as defined by RFC 3463. *

*/ private String statusCode; /** *

* Human-readable text to include in the bounce message. *

*/ private String message; /** *

* The email address of the sender of the bounced email. This is the address * from which the bounce message will be sent. *

*/ private String sender; /** *

* * @return

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify * when the bounce action is taken. An example of an Amazon SNS * topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon SNS Developer Guide. *

*/ public String getTopicArn() { return topicArn; } /** *

* * @param topicArn

* The Amazon Resource Name (ARN) of the Amazon SNS topic to * notify when the bounce action is taken. An example of an * Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For * more information about Amazon SNS topics, see the Amazon SNS Developer Guide. *

*/ public void setTopicArn(String topicArn) { this.topicArn = topicArn; } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param topicArn

* @return A reference to this updated object so that method calls can be * chained together. */ public BounceAction withTopicArn(String topicArn) { this.topicArn = topicArn; return this; } /** *

* The SMTP reply code, as defined by RFC 5321. *

* * @return

* The SMTP reply code, as defined by RFC 5321. *

*/ public String getSmtpReplyCode() { return smtpReplyCode; } /** *

* The SMTP reply code, as defined by RFC 5321. *

* * @param smtpReplyCode

* The SMTP reply code, as defined by RFC 5321. *

*/ public void setSmtpReplyCode(String smtpReplyCode) { this.smtpReplyCode = smtpReplyCode; } /** *

* The SMTP reply code, as defined by RFC 5321. *

* Returns a reference to this object so that method calls can be chained * together. * * @param smtpReplyCode

* The SMTP reply code, as defined by RFC 5321. *

* @return A reference to this updated object so that method calls can be * chained together. */ public BounceAction withSmtpReplyCode(String smtpReplyCode) { this.smtpReplyCode = smtpReplyCode; return this; } /** *

* The SMTP enhanced status code, as defined by RFC 3463. *

* * @return

* The SMTP enhanced status code, as defined by RFC 3463. *

*/ public String getStatusCode() { return statusCode; } /** *

* The SMTP enhanced status code, as defined by RFC 3463. *

* * @param statusCode

* The SMTP enhanced status code, as defined by RFC 3463. *

*/ public void setStatusCode(String statusCode) { this.statusCode = statusCode; } /** *

* The SMTP enhanced status code, as defined by RFC 3463. *

* Returns a reference to this object so that method calls can be chained * together. * * @param statusCode

* The SMTP enhanced status code, as defined by RFC 3463. *

* @return A reference to this updated object so that method calls can be * chained together. */ public BounceAction withStatusCode(String statusCode) { this.statusCode = statusCode; return this; } /** *

* Human-readable text to include in the bounce message. *

* * @return

* Human-readable text to include in the bounce message. *

*/ public String getMessage() { return message; } /** *

* Human-readable text to include in the bounce message. *

* * @param message

* Human-readable text to include in the bounce message. *

*/ public void setMessage(String message) { this.message = message; } /** *

* Human-readable text to include in the bounce message. *

* Returns a reference to this object so that method calls can be chained * together. * * @param message

* Human-readable text to include in the bounce message. *

* @return A reference to this updated object so that method calls can be * chained together. */ public BounceAction withMessage(String message) { this.message = message; return this; } /** *

* The email address of the sender of the bounced email. This is the address * from which the bounce message will be sent. *

* * @return

* The email address of the sender of the bounced email. This is the * address from which the bounce message will be sent. *

*/ public String getSender() { return sender; } /** *

* The email address of the sender of the bounced email. This is the address * from which the bounce message will be sent. *

* * @param sender

* The email address of the sender of the bounced email. This is * the address from which the bounce message will be sent. *

*/ public void setSender(String sender) { this.sender = sender; } /** *

* The email address of the sender of the bounced email. This is the address * from which the bounce message will be sent. *

* Returns a reference to this object so that method calls can be chained * together. * * @param sender

* The email address of the sender of the bounced email. This is * the address from which the bounce message will be sent. *

* @return A reference to this updated object so that method calls can be * chained together. */ public BounceAction withSender(String sender) { this.sender = sender; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTopicArn() != null) sb.append("TopicArn: " + getTopicArn() + ","); if (getSmtpReplyCode() != null) sb.append("SmtpReplyCode: " + getSmtpReplyCode() + ","); if (getStatusCode() != null) sb.append("StatusCode: " + getStatusCode() + ","); if (getMessage() != null) sb.append("Message: " + getMessage() + ","); if (getSender() != null) sb.append("Sender: " + getSender()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTopicArn() == null) ? 0 : getTopicArn().hashCode()); hashCode = prime * hashCode + ((getSmtpReplyCode() == null) ? 0 : getSmtpReplyCode().hashCode()); hashCode = prime * hashCode + ((getStatusCode() == null) ? 0 : getStatusCode().hashCode()); hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode()); hashCode = prime * hashCode + ((getSender() == null) ? 0 : getSender().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof BounceAction == false) return false; BounceAction other = (BounceAction) obj; if (other.getTopicArn() == null ^ this.getTopicArn() == null) return false; if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false) return false; if (other.getSmtpReplyCode() == null ^ this.getSmtpReplyCode() == null) return false; if (other.getSmtpReplyCode() != null && other.getSmtpReplyCode().equals(this.getSmtpReplyCode()) == false) return false; if (other.getStatusCode() == null ^ this.getStatusCode() == null) return false; if (other.getStatusCode() != null && other.getStatusCode().equals(this.getStatusCode()) == false) return false; if (other.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false) return false; if (other.getSender() == null ^ this.getSender() == null) return false; if (other.getSender() != null && other.getSender().equals(this.getSender()) == false) return false; return true; } }