com.amazonaws.services.simpleemail.model.ReceiptRule Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses Show documentation
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
/**
*
* 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.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ReceiptRule implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
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 bounces emails that
* are not received over TLS. The default is Optional.
*
*/
private String tlsPolicy;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList recipients;
/**
*
* 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 com.amazonaws.internal.SdkInternalList actions;
/**
*
* 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 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.
*
*
*
*
* @param 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.
*
*
*/
public void setName(String name) {
this.name = 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.
*
*
*
*
* @return 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.
*
*
*/
public String getName() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReceiptRule withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
* @return If true, the receipt rule is active. The default value is false.
*/
public Boolean getEnabled() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReceiptRule withEnabled(Boolean enabled) {
setEnabled(enabled);
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 this.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 bounces emails that
* are not received over TLS. The default is 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 bounces
* 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 bounces emails that
* are not received over TLS. The default is 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 bounces
* emails that are not received over TLS. The default is Optional.
* @see TlsPolicy
*/
public String getTlsPolicy() {
return this.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.
*
*
* @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 bounces
* emails that are not received over TLS. The default is Optional.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TlsPolicy
*/
public ReceiptRule withTlsPolicy(String tlsPolicy) {
setTlsPolicy(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 bounces emails that
* are not received over TLS. The default is 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 bounces
* emails that are not received over TLS. The default is Optional.
* @see TlsPolicy
*/
public void setTlsPolicy(TlsPolicy tlsPolicy) {
withTlsPolicy(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.
*
*
* @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 bounces
* emails that are not received over TLS. The default is Optional.
* @return Returns a reference to this 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 matches all recipients on all verified domains.
*
*
* @return 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.
*/
public java.util.List getRecipients() {
if (recipients == null) {
recipients = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setRecipients(java.util.Collection recipients) {
if (recipients == null) {
this.recipients = null;
return;
}
this.recipients = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRecipients(java.util.Collection)} or {@link #withRecipients(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReceiptRule withRecipients(String... recipients) {
if (this.recipients == null) {
setRecipients(new com.amazonaws.internal.SdkInternalList(recipients.length));
}
for (String ele : recipients) {
this.recipients.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this 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() {
if (actions == null) {
actions = new com.amazonaws.internal.SdkInternalList();
}
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 com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public ReceiptRule withActions(ReceiptAction... actions) {
if (this.actions == null) {
setActions(new com.amazonaws.internal.SdkInternalList(actions.length));
}
for (ReceiptAction ele : actions) {
this.actions.add(ele);
}
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.
*
*
* @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 Returns a reference to this 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.
*
*
* @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.
*
*
* @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 this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReceiptRule withScanEnabled(Boolean scanEnabled) {
setScanEnabled(scanEnabled);
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 this.scanEnabled;
}
/**
* 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.
*
* @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: ").append(getName()).append(",");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getTlsPolicy() != null)
sb.append("TlsPolicy: ").append(getTlsPolicy()).append(",");
if (getRecipients() != null)
sb.append("Recipients: ").append(getRecipients()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions()).append(",");
if (getScanEnabled() != null)
sb.append("ScanEnabled: ").append(getScanEnabled());
sb.append("}");
return sb.toString();
}
@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;
}
@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 ReceiptRule clone() {
try {
return (ReceiptRule) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}