com.amazonaws.services.simpleemail.model.RawMessage Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses 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;
/**
*
* Represents the raw data of the message.
*
*/
public class RawMessage implements Serializable, Cloneable {
/**
*
* The raw data of the message. The client must ensure that the message
* format complies with Internet email standards regarding email header
* fields, MIME types, MIME encoding, and base64 encoding (if necessary).
*
*
* The To:, CC:, and BCC: headers in the raw message can contain a group
* list.
*
*
* If you are using SendRawEmail with sending authorization,
* you can include X-headers in the raw message to specify the "Source,"
* "From," and "Return-Path" addresses. For more information, see the
* documentation for SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they are
* removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*
*/
private java.nio.ByteBuffer data;
/**
* Default constructor for RawMessage object. Callers should use the setter
* or fluent setter (with...) methods to initialize the object after
* creating it.
*/
public RawMessage() {
}
/**
* Constructs a new RawMessage object. Callers should use the setter or
* fluent setter (with...) methods to initialize any additional object
* members.
*
* @param data
* The raw data of the message. The client must ensure that the
* message format complies with Internet email standards regarding
* email header fields, MIME types, MIME encoding, and base64
* encoding (if necessary).
*
* The To:, CC:, and BCC: headers in the raw message can contain a
* group list.
*
*
* If you are using SendRawEmail with sending
* authorization, you can include X-headers in the raw message to
* specify the "Source," "From," and "Return-Path" addresses. For
* more information, see the documentation for
* SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they
* are removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*/
public RawMessage(java.nio.ByteBuffer data) {
setData(data);
}
/**
*
* The raw data of the message. The client must ensure that the message
* format complies with Internet email standards regarding email header
* fields, MIME types, MIME encoding, and base64 encoding (if necessary).
*
*
* The To:, CC:, and BCC: headers in the raw message can contain a group
* list.
*
*
* If you are using SendRawEmail with sending authorization,
* you can include X-headers in the raw message to specify the "Source,"
* "From," and "Return-Path" addresses. For more information, see the
* documentation for SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they are
* removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*
*
* AWS SDK for Java performs a Base64 encoding on this field before sending
* this request to AWS service by default. Users of the SDK should not
* perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the
* content or position of the byte buffer will be seen by all objects that
* have a reference to this object. It is recommended to call
* ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or
* reading from the buffer. This behavior will be changed in a future major
* version of the SDK.
*
*
* @param data
* The raw data of the message. The client must ensure that the
* message format complies with Internet email standards regarding
* email header fields, MIME types, MIME encoding, and base64
* encoding (if necessary).
*
* The To:, CC:, and BCC: headers in the raw message can contain a
* group list.
*
*
* If you are using SendRawEmail with sending
* authorization, you can include X-headers in the raw message to
* specify the "Source," "From," and "Return-Path" addresses. For
* more information, see the documentation for
* SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they
* are removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*/
public void setData(java.nio.ByteBuffer data) {
this.data = data;
}
/**
*
* The raw data of the message. The client must ensure that the message
* format complies with Internet email standards regarding email header
* fields, MIME types, MIME encoding, and base64 encoding (if necessary).
*
*
* The To:, CC:, and BCC: headers in the raw message can contain a group
* list.
*
*
* If you are using SendRawEmail with sending authorization,
* you can include X-headers in the raw message to specify the "Source,"
* "From," and "Return-Path" addresses. For more information, see the
* documentation for SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they are
* removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods
* changes their {@code position}. We recommend using
* {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view
* of the buffer with an independent {@code position}, and calling
* {@code get} methods on this rather than directly on the returned
* {@code ByteBuffer}. Doing so will ensure that anyone else using the
* {@code ByteBuffer} will not be affected by changes to the {@code position}
* .
*
*
* @return The raw data of the message. The client must ensure that the
* message format complies with Internet email standards regarding
* email header fields, MIME types, MIME encoding, and base64
* encoding (if necessary).
*
* The To:, CC:, and BCC: headers in the raw message can contain a
* group list.
*
*
* If you are using SendRawEmail with sending
* authorization, you can include X-headers in the raw message to
* specify the "Source," "From," and "Return-Path" addresses. For
* more information, see the documentation for
* SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because
* they are removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*/
public java.nio.ByteBuffer getData() {
return this.data;
}
/**
*
* The raw data of the message. The client must ensure that the message
* format complies with Internet email standards regarding email header
* fields, MIME types, MIME encoding, and base64 encoding (if necessary).
*
*
* The To:, CC:, and BCC: headers in the raw message can contain a group
* list.
*
*
* If you are using SendRawEmail with sending authorization,
* you can include X-headers in the raw message to specify the "Source,"
* "From," and "Return-Path" addresses. For more information, see the
* documentation for SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they are
* removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
*
*
* @param data
* The raw data of the message. The client must ensure that the
* message format complies with Internet email standards regarding
* email header fields, MIME types, MIME encoding, and base64
* encoding (if necessary).
*
* The To:, CC:, and BCC: headers in the raw message can contain a
* group list.
*
*
* If you are using SendRawEmail with sending
* authorization, you can include X-headers in the raw message to
* specify the "Source," "From," and "Return-Path" addresses. For
* more information, see the documentation for
* SendRawEmail.
*
*
*
* Do not include these X-headers in the DKIM signature, because they
* are removed by Amazon SES before sending the email.
*
*
*
* For more information, go to the Amazon SES Developer Guide.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public RawMessage withData(java.nio.ByteBuffer data) {
setData(data);
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 (getData() != null)
sb.append("Data: " + getData());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RawMessage == false)
return false;
RawMessage other = (RawMessage) obj;
if (other.getData() == null ^ this.getData() == null)
return false;
if (other.getData() != null
&& other.getData().equals(this.getData()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getData() == null) ? 0 : getData().hashCode());
return hashCode;
}
@Override
public RawMessage clone() {
try {
return (RawMessage) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}