/* * 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; /** *

* Receipt rules enable you to specify which actions Amazon SES should take when * it receives mail on behalf of one or more email addresses or domains that you * own. *

*

* Each receipt rule defines a set of email addresses or domains that it applies * to. If the email addresses or domains match at least one recipient address of * the message, Amazon SES executes all of the receipt rule's actions on the * message. *

*

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

*/ public class ReceiptRule implements Serializable { /** *

* The name of the receipt rule. The name must: *

* */ private String name; /** *

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

*/ private Boolean enabled; /** *

* 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 will * bounce emails that are not received over TLS. The default is * Optional. *

*

* Constraints:
* Allowed Values: Require, Optional */ private String tlsPolicy; /** *

* The recipient domains and email addresses that the receipt rule applies * to. If this field is not specified, this rule will match all recipients * under all verified domains. *

*/ private java.util.List recipients = new java.util.ArrayList(); /** *

* 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. *

*/ private java.util.List actions = new java.util.ArrayList(); /** *

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

*/ private Boolean scanEnabled; /** *

* The name of the receipt rule. The name must: *

*
    *
  • *

    * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), * underscores (_), or dashes (-). *

    *
    • *
  • *

    * Start and end with a letter or number. *

    *
    • *
  • *

    * Contain less than 64 characters. *

    *
    • *
* * @return

* The name of the receipt rule. The name must: *

*
    *
  • *

    * This value can only contain ASCII letters (a-z, A-Z), numbers * (0-9), underscores (_), or dashes (-). *

    *
    • *
  • *

    * Start and end with a letter or number. *

    *
    • *
  • *

    * Contain less than 64 characters. *

    *
    • *
*/ public String getName() { return name; } /** *

* The name of the receipt rule. The name must: *

*
    *
  • *

    * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), * underscores (_), or dashes (-). *

    *
    • *
  • *

    * Start and end with a letter or number. *

    *
    • *
  • *

    * Contain less than 64 characters. *

    *
    • *
* * @param name

* The name of the receipt rule. The name must: *

*
    *
  • *

    * This value can only contain ASCII letters (a-z, A-Z), numbers * (0-9), underscores (_), or dashes (-). *

    *
    • *
  • *

    * Start and end with a letter or number. *

    *
    • *
  • *

    * Contain less than 64 characters. *

    *
    • *
*/ public void setName(String name) { this.name = name; } /** *

* The name of the receipt rule. The name must: *

*
    *
  • *

    * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), * underscores (_), or dashes (-). *

    *
    • *
  • *

    * Start and end with a letter or number. *

    *
    • *
  • *

    * Contain less than 64 characters. *

    *
    • *
*

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

* The name of the receipt rule. The name must: *

*
    *
  • *

    * This value can only contain ASCII letters (a-z, A-Z), numbers * (0-9), underscores (_), or dashes (-). *

    *
    • *
  • *

    * Start and end with a letter or number. *

    *
    • *
  • *

    * Contain less than 64 characters. *

    *
    • *
* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withName(String name) { this.name = name; return this; } /** *

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

* * @return

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

*/ public Boolean isEnabled() { return enabled; } /** *

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

* * @return

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

*/ public Boolean getEnabled() { return enabled; } /** *

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

* * @param enabled

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

*/ public void setEnabled(Boolean enabled) { this.enabled = enabled; } /** *

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

*

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

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

* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withEnabled(Boolean enabled) { this.enabled = enabled; return this; } /** *

* 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 will * bounce emails that are not received over TLS. The default is * Optional. *

*

* Constraints:
* Allowed Values: Require, Optional * * @return

* 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 will bounce emails that are not received over TLS. The * default is Optional. *

* @see TlsPolicy */ public String getTlsPolicy() { return 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 will * bounce emails that are not received over TLS. The default is * Optional. *

*

* Constraints:
* Allowed Values: Require, Optional * * @param 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 will bounce emails that are * not received over TLS. The default is Optional. *

* @see TlsPolicy */ public void setTlsPolicy(String tlsPolicy) { this.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 will * bounce emails that are not received over TLS. The default is * Optional. *

*

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

* Constraints:
* Allowed Values: Require, Optional * * @param 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 will bounce emails that are * not received over TLS. The default is Optional. *

* @return A reference to this updated object so that method calls can be * chained together. * @see TlsPolicy */ public ReceiptRule withTlsPolicy(String tlsPolicy) { this.tlsPolicy = tlsPolicy; return this; } /** *

* 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 will * bounce emails that are not received over TLS. The default is * Optional. *

*

* Constraints:
* Allowed Values: Require, Optional * * @param 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 will bounce emails that are * not received over TLS. The default is Optional. *

* @see TlsPolicy */ public void setTlsPolicy(TlsPolicy tlsPolicy) { this.tlsPolicy = tlsPolicy.toString(); } /** *

* 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 will * bounce emails that are not received over TLS. The default is * Optional. *

*

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

* Constraints:
* Allowed Values: Require, Optional * * @param 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 will bounce emails that are * not received over TLS. The default is Optional. *

* @return A reference to this updated object so that method calls can be * chained together. * @see TlsPolicy */ public ReceiptRule withTlsPolicy(TlsPolicy tlsPolicy) { this.tlsPolicy = tlsPolicy.toString(); return this; } /** *

* The recipient domains and email addresses that the receipt rule applies * to. If this field is not specified, this rule will match all recipients * under all verified domains. *

* * @return

* The recipient domains and email addresses that the receipt rule * applies to. If this field is not specified, this rule will match * all recipients under all verified domains. *

*/ public java.util.List getRecipients() { return recipients; } /** *

* The recipient domains and email addresses that the receipt rule applies * to. If this field is not specified, this rule will match all recipients * under all verified domains. *

* * @param recipients

* The recipient domains and email addresses that the receipt * rule applies to. If this field is not specified, this rule * will match all recipients under all verified domains. *

*/ public void setRecipients(java.util.Collection recipients) { if (recipients == null) { this.recipients = null; return; } this.recipients = new java.util.ArrayList(recipients); } /** *

* The recipient domains and email addresses that the receipt rule applies * to. If this field is not specified, this rule will match all recipients * under all verified domains. *

*

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

* The recipient domains and email addresses that the receipt * rule applies to. If this field is not specified, this rule * will match all recipients under all verified domains. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withRecipients(String... recipients) { if (getRecipients() == null) { this.recipients = new java.util.ArrayList(recipients.length); } for (String value : recipients) { this.recipients.add(value); } return this; } /** *

* The recipient domains and email addresses that the receipt rule applies * to. If this field is not specified, this rule will match all recipients * under all verified domains. *

*

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

* The recipient domains and email addresses that the receipt * rule applies to. If this field is not specified, this rule * will match all recipients under all verified domains. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withRecipients(java.util.Collection recipients) { setRecipients(recipients); return this; } /** *

* 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. *

* * @return

* 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. *

*/ public java.util.List getActions() { return 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. *

* * @param 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. *

*/ public void setActions(java.util.Collection actions) { if (actions == null) { this.actions = null; return; } this.actions = new java.util.ArrayList(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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withActions(ReceiptAction... actions) { if (getActions() == null) { this.actions = new java.util.ArrayList(actions.length); } for (ReceiptAction value : actions) { this.actions.add(value); } return this; } /** *

* 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withActions(java.util.Collection actions) { setActions(actions); return this; } /** *

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

* * @return

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

*/ public Boolean isScanEnabled() { return scanEnabled; } /** *

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

* * @return

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

*/ public Boolean getScanEnabled() { return scanEnabled; } /** *

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

* * @param scanEnabled

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

*/ public void setScanEnabled(Boolean scanEnabled) { this.scanEnabled = scanEnabled; } /** *

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

*

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

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

* @return A reference to this updated object so that method calls can be * chained together. */ public ReceiptRule withScanEnabled(Boolean scanEnabled) { this.scanEnabled = scanEnabled; 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 (getName() != null) sb.append("Name: " + getName() + ","); if (getEnabled() != null) sb.append("Enabled: " + getEnabled() + ","); if (getTlsPolicy() != null) sb.append("TlsPolicy: " + getTlsPolicy() + ","); if (getRecipients() != null) sb.append("Recipients: " + getRecipients() + ","); if (getActions() != null) sb.append("Actions: " + getActions() + ","); if (getScanEnabled() != null) sb.append("ScanEnabled: " + getScanEnabled()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode()); hashCode = prime * hashCode + ((getTlsPolicy() == null) ? 0 : getTlsPolicy().hashCode()); hashCode = prime * hashCode + ((getRecipients() == null) ? 0 : getRecipients().hashCode()); hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode()); hashCode = prime * hashCode + ((getScanEnabled() == null) ? 0 : getScanEnabled().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ReceiptRule == false) return false; ReceiptRule other = (ReceiptRule) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getEnabled() == null ^ this.getEnabled() == null) return false; if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false) return false; if (other.getTlsPolicy() == null ^ this.getTlsPolicy() == null) return false; if (other.getTlsPolicy() != null && other.getTlsPolicy().equals(this.getTlsPolicy()) == false) return false; if (other.getRecipients() == null ^ this.getRecipients() == null) return false; if (other.getRecipients() != null && other.getRecipients().equals(this.getRecipients()) == false) return false; if (other.getActions() == null ^ this.getActions() == null) return false; if (other.getActions() != null && other.getActions().equals(this.getActions()) == false) return false; if (other.getScanEnabled() == null ^ this.getScanEnabled() == null) return false; if (other.getScanEnabled() != null && other.getScanEnabled().equals(this.getScanEnabled()) == false) return false; return true; } }