SubmitEmailDetails

class oci.email_data_plane.models.SubmitEmailDetails(**kwargs)

Bases: object

Details that are required by the sender to submit a request to send email.

Methods:

__init__(**kwargs)

Initializes a new SubmitEmailDetails object with values from keyword arguments.

Attributes:

body_html

Gets the body_html of this SubmitEmailDetails.

body_text

Gets the body_text of this SubmitEmailDetails.

header_fields

Gets the header_fields of this SubmitEmailDetails.

message_id

Gets the message_id of this SubmitEmailDetails.

recipients

[Required] Gets the recipients of this SubmitEmailDetails.

reply_to

Gets the reply_to of this SubmitEmailDetails.

sender

[Required] Gets the sender of this SubmitEmailDetails.

subject

[Required] Gets the subject of this SubmitEmailDetails.

__init__(**kwargs)

Initializes a new SubmitEmailDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • message_id (str) – The value to assign to the message_id property of this SubmitEmailDetails.

  • sender (oci.email_data_plane.models.Sender) – The value to assign to the sender property of this SubmitEmailDetails.

  • recipients (oci.email_data_plane.models.Recipients) – The value to assign to the recipients property of this SubmitEmailDetails.

  • subject (str) – The value to assign to the subject property of this SubmitEmailDetails.

  • body_html (str) – The value to assign to the body_html property of this SubmitEmailDetails.

  • body_text (str) – The value to assign to the body_text property of this SubmitEmailDetails.

  • reply_to (list[oci.email_data_plane.models.EmailAddress]) – The value to assign to the reply_to property of this SubmitEmailDetails.

  • header_fields (dict(str, str)) – The value to assign to the header_fields property of this SubmitEmailDetails.

property body_html

Gets the body_html of this SubmitEmailDetails. 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 body_html of this SubmitEmailDetails.

Return type

str

property body_text

Gets the body_text of this SubmitEmailDetails. Text body content. NOTE: Even though bodytext and bodyhtml are both optional, at least one of them must be provided.

Returns

The body_text of this SubmitEmailDetails.

Return type

str

property header_fields

Gets the header_fields of this SubmitEmailDetails. 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 header_fields of this SubmitEmailDetails.

Return type

dict(str, str)

property message_id

Gets the message_id of this SubmitEmailDetails. 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 message_id of this SubmitEmailDetails.

Return type

str

property recipients

[Required] Gets the recipients of this SubmitEmailDetails.

Returns

The recipients of this SubmitEmailDetails.

Return type

oci.email_data_plane.models.Recipients

property reply_to

Gets the reply_to of this SubmitEmailDetails. The email address for the recipient to reply to. If left blank, defaults to the sender address.

Returns

The reply_to of this SubmitEmailDetails.

Return type

list[oci.email_data_plane.models.EmailAddress]

property sender

[Required] Gets the sender of this SubmitEmailDetails.

Returns

The sender of this SubmitEmailDetails.

Return type

oci.email_data_plane.models.Sender

property subject

[Required] Gets the subject of this SubmitEmailDetails. A short summary of the content, which will appear in the recipient’s inbox. UTF-8 supported RFC 2047.

Returns

The subject of this SubmitEmailDetails.

Return type

str