com.amazonaws.services.simpleemail.model.MessageDsn Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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;
/**
 * 
 * Message-related information to include in the Delivery Status Notification
 * (DSN) when an email that Amazon SES receives on your behalf bounces.
 * 
 * 
 * For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
 * 
 */
public class MessageDsn implements Serializable, Cloneable {
    /**
     * 
     * The reporting MTA that attempted to deliver the message, formatted as
     * specified in RFC 3464 (
     * mta-name-type; mta-name). The default value is
     * dns; inbound-smtp.[region].amazonaws.com.
     * 
     */
    private String reportingMta;
    /**
     * 
     * When the message was received by the reporting mail transfer agent (MTA),
     * in RFC 822 date-time
     * format.
     * 
     */
    private java.util.Date arrivalDate;
    /**
     * 
     * Additional X-headers to include in the DSN.
     * 
     */
    private com.amazonaws.internal.SdkInternalList extensionFields;
    /**
     * 
     * The reporting MTA that attempted to deliver the message, formatted as
     * specified in RFC 3464 (
     * mta-name-type; mta-name). The default value is
     * dns; inbound-smtp.[region].amazonaws.com.
     * 
     * 
     * @param reportingMta
     *        The reporting MTA that attempted to deliver the message, formatted
     *        as specified in RFC
     *        3464 (mta-name-type; mta-name). The default value
     *        is dns; inbound-smtp.[region].amazonaws.com.
     */
    public void setReportingMta(String reportingMta) {
        this.reportingMta = reportingMta;
    }
    /**
     * 
     * The reporting MTA that attempted to deliver the message, formatted as
     * specified in RFC 3464 (
     * mta-name-type; mta-name). The default value is
     * dns; inbound-smtp.[region].amazonaws.com.
     * 
     * 
     * @return The reporting MTA that attempted to deliver the message,
     *         formatted as specified in RFC 3464 (
     *         mta-name-type; mta-name). The default value is
     *         dns; inbound-smtp.[region].amazonaws.com.
     */
    public String getReportingMta() {
        return this.reportingMta;
    }
    /**
     * 
     * The reporting MTA that attempted to deliver the message, formatted as
     * specified in RFC 3464 (
     * mta-name-type; mta-name). The default value is
     * dns; inbound-smtp.[region].amazonaws.com.
     * 
     * 
     * @param reportingMta
     *        The reporting MTA that attempted to deliver the message, formatted
     *        as specified in RFC
     *        3464 (mta-name-type; mta-name). The default value
     *        is dns; inbound-smtp.[region].amazonaws.com.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public MessageDsn withReportingMta(String reportingMta) {
        setReportingMta(reportingMta);
        return this;
    }
    /**
     * 
     * When the message was received by the reporting mail transfer agent (MTA),
     * in RFC 822 date-time
     * format.
     * 
     * 
     * @param arrivalDate
     *        When the message was received by the reporting mail transfer agent
     *        (MTA), in RFC
     *        822 date-time format.
     */
    public void setArrivalDate(java.util.Date arrivalDate) {
        this.arrivalDate = arrivalDate;
    }
    /**
     * 
     * When the message was received by the reporting mail transfer agent (MTA),
     * in RFC 822 date-time
     * format.
     * 
     * 
     * @return When the message was received by the reporting mail transfer
     *         agent (MTA), in RFC 822 date-time
     *         format.
     */
    public java.util.Date getArrivalDate() {
        return this.arrivalDate;
    }
    /**
     * 
     * When the message was received by the reporting mail transfer agent (MTA),
     * in RFC 822 date-time
     * format.
     * 
     * 
     * @param arrivalDate
     *        When the message was received by the reporting mail transfer agent
     *        (MTA), in RFC
     *        822 date-time format.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public MessageDsn withArrivalDate(java.util.Date arrivalDate) {
        setArrivalDate(arrivalDate);
        return this;
    }
    /**
     * 
     * Additional X-headers to include in the DSN.
     * 
     * 
     * @return Additional X-headers to include in the DSN.
     */
    public java.util.List getExtensionFields() {
        if (extensionFields == null) {
            extensionFields = new com.amazonaws.internal.SdkInternalList();
        }
        return extensionFields;
    }
    /**
     * 
     * Additional X-headers to include in the DSN.
     * 
     * 
     * @param extensionFields
     *        Additional X-headers to include in the DSN.
     */
    public void setExtensionFields(
            java.util.Collection extensionFields) {
        if (extensionFields == null) {
            this.extensionFields = null;
            return;
        }
        this.extensionFields = new com.amazonaws.internal.SdkInternalList(
                extensionFields);
    }
    /**
     * 
     * Additional X-headers to include in the DSN.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setExtensionFields(java.util.Collection)} or
     * {@link #withExtensionFields(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param extensionFields
     *        Additional X-headers to include in the DSN.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public MessageDsn withExtensionFields(ExtensionField... extensionFields) {
        if (this.extensionFields == null) {
            setExtensionFields(new com.amazonaws.internal.SdkInternalList(
                    extensionFields.length));
        }
        for (ExtensionField ele : extensionFields) {
            this.extensionFields.add(ele);
        }
        return this;
    }
    /**
     * 
     * Additional X-headers to include in the DSN.
     * 
     * 
     * @param extensionFields
     *        Additional X-headers to include in the DSN.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public MessageDsn withExtensionFields(
            java.util.Collection extensionFields) {
        setExtensionFields(extensionFields);
        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 (getReportingMta() != null)
            sb.append("ReportingMta: " + getReportingMta() + ",");
        if (getArrivalDate() != null)
            sb.append("ArrivalDate: " + getArrivalDate() + ",");
        if (getExtensionFields() != null)
            sb.append("ExtensionFields: " + getExtensionFields());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof MessageDsn == false)
            return false;
        MessageDsn other = (MessageDsn) obj;
        if (other.getReportingMta() == null ^ this.getReportingMta() == null)
            return false;
        if (other.getReportingMta() != null
                && other.getReportingMta().equals(this.getReportingMta()) == false)
            return false;
        if (other.getArrivalDate() == null ^ this.getArrivalDate() == null)
            return false;
        if (other.getArrivalDate() != null
                && other.getArrivalDate().equals(this.getArrivalDate()) == false)
            return false;
        if (other.getExtensionFields() == null
                ^ this.getExtensionFields() == null)
            return false;
        if (other.getExtensionFields() != null
                && other.getExtensionFields().equals(this.getExtensionFields()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getReportingMta() == null) ? 0 : getReportingMta()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getArrivalDate() == null) ? 0 : getArrivalDate().hashCode());
        hashCode = prime
                * hashCode
                + ((getExtensionFields() == null) ? 0 : getExtensionFields()
                        .hashCode());
        return hashCode;
    }
    @Override
    public MessageDsn clone() {
        try {
            return (MessageDsn) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}