Class EmailContent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EmailContent.Builder,
EmailContent>
An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EmailContent.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final RawMessage
raw()
The raw email message.static Class
<? extends EmailContent.Builder> final Message
simple()
The simple email message.final Template
template()
The template to use for the email message.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
simple
The simple email message. The message consists of a subject and a message body.
- Returns:
- The simple email message. The message consists of a subject and a message body.
-
raw
The raw email message. The message has to meet the following criteria:
-
The message has to contain a header and a body, separated by one blank line.
-
All of the required header fields must be present in the message.
-
Each part of a multipart MIME message must be formatted properly.
-
If you include attachments, they must be in a file format that Amazon Pinpoint supports.
-
The entire message must be Base64 encoded.
-
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
-
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
- Returns:
- The raw email message. The message has to meet the following criteria:
-
The message has to contain a header and a body, separated by one blank line.
-
All of the required header fields must be present in the message.
-
Each part of a multipart MIME message must be formatted properly.
-
If you include attachments, they must be in a file format that Amazon Pinpoint supports.
-
The entire message must be Base64 encoded.
-
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
-
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
-
-
-
template
The template to use for the email message.
- Returns:
- The template to use for the email message.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EmailContent.Builder,
EmailContent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
-
sdkFields
-