Package com.oracle.bmc.emaildataplane.model

Class SubmitEmailDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.emaildataplane.model.SubmitEmailDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220926")
public final class SubmitEmailDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Details that are required by the sender to submit a request to send email.
Note: Objects should always be created or deserialized using the SubmitEmailDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SubmitEmailDetails.Builder, which maintain a set of all explicitly set fields called SubmitEmailDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubmitEmailDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SubmitEmailDetails(String messageId, Sender sender, Recipients recipients, String subject, String bodyHtml, String bodyText, List<EmailAddress> replyTo, Map<String,String> headerFields)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SubmitEmailDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBodyHtml()	HTML body content in UTF-8.
String	getBodyText()	Text body content.
Map<String,String>	getHeaderFields()	The header used by the customer for the email sent.
String	getMessageId()	The unique ID for the email’s Message-ID header used for service log correlation.
Recipients	getRecipients()
List<EmailAddress>	getReplyTo()	The email address for the recipient to reply to.
Sender	getSender()
String	getSubject()	A short summary of the content, which will appear in the recipient’s inbox.
int	hashCode()
SubmitEmailDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubmitEmailDetails

@Deprecated
@ConstructorProperties({"messageId","sender","recipients","subject","bodyHtml","bodyText","replyTo","headerFields"})
public SubmitEmailDetails(String messageId,
                          Sender sender,
                          Recipients recipients,
                          String subject,
                          String bodyHtml,
                          String bodyText,
                          List<EmailAddress> replyTo,
                          Map<String,String> headerFields)

Deprecated.

Method Detail

builder

public static SubmitEmailDetails.Builder builder()

Create a new builder.

toBuilder

public SubmitEmailDetails.Builder toBuilder()

getMessageId

public String getMessageId()

The unique ID for the email’s Message-ID header used for service log correlation.

The submission will return an error if the syntax is not a valid RFC 5322 Message-ID. This will be generated if not provided. Example: sdiofu234qwermls24fd@mail.example.com

Returns:

the value

getSender

public Sender getSender()

getRecipients

public Recipients getRecipients()

getSubject

public String getSubject()

A short summary of the content, which will appear in the recipient’s inbox.

UTF-8 supported RFC 2047.

Returns:

the value

getBodyHtml

public String getBodyHtml()

HTML body content in UTF-8.

NOTE: Even though bodytext and bodyhtml are both optional, at least one of them must be provided.

Returns:

the value

getBodyText

public String getBodyText()

Text body content.

NOTE: Even though bodytext and bodyhtml are both optional, at least one of them must be provided.

Returns:

the value

getReplyTo

public List<EmailAddress> getReplyTo()

The email address for the recipient to reply to.

If left blank, defaults to the sender address.

Returns:

the value

getHeaderFields

public Map<String,String> getHeaderFields()

The header used by the customer for the email sent.

Reserved headers are not allowed e.g “subject”, “from”, and “to” etc. Example: {“bar-key”: “value”}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel