Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 3.04 KB

File metadata and controls

38 lines (29 loc) · 3.04 KB

SendMailAdv

Request body for POST /mail/advsend. Provides full control over all email headers and supports multiple recipients, CC, BCC, Reply-To, and file attachments. Address fields (from, to, replyto, cc, bcc) each accept either a plain RFC 822 string (e.g. \"Joe <joe@example.com>\" or a comma-separated list) or a structured array of {\"email\": \"...\", \"name\": \"...\"} objects. HTML detection is automatic based on whether body contains HTML tags.

Properties

Name Type Description Notes
subject str The subject line of the email.
body str The email body. If the string contains any HTML tags the message is automatically sent as `text/html`; otherwise it is sent as `text/plain`.
var_from EmailAddressTypes The sender address. Accepts a plain email string, an RFC 822 named string (`&quot;Name <email>&quot;`), or a `{&quot;email&quot;: &quot;...&quot;, &quot;name&quot;: &quot;...&quot;}` object.
to EmailAddressesTypes One or more destination addresses. Accepts a comma-separated RFC 822 string or an array of contact objects.
replyto EmailAddressesTypes Optional. One or more addresses to set as the `Reply-To` header. When recipients reply to the message their email client will address the reply to these addresses instead of `from`. [optional]
cc EmailAddressesTypes Optional. Carbon-copy recipients. These addresses are listed in the `Cc` header and are visible to all recipients. [optional]
bcc EmailAddressesTypes Optional. Blind-carbon-copy recipients. These addresses receive the message but are not listed in any visible header. [optional]
attachments List[MailAttachment] Optional list of file attachments. Each file must be base64-encoded. Include `filename` so recipients see a meaningful attachment name. [optional]
id int Optional numeric ID of the mail order to send through. If omitted the first active order on your account is used automatically. Valid IDs are returned by `GET /mail`. [optional]

Example

from openapi_client.models.send_mail_adv import SendMailAdv

# TODO update the JSON string below
json = "{}"
# create an instance of SendMailAdv from a JSON string
send_mail_adv_instance = SendMailAdv.from_json(json)
# print the JSON string representation of the object
print(SendMailAdv.to_json())

# convert the object into a dict
send_mail_adv_dict = send_mail_adv_instance.to_dict()
# create an instance of SendMailAdv from a dict
send_mail_adv_from_dict = SendMailAdv.from_dict(send_mail_adv_dict)

[Back to Model list] [Back to API list] [Back to README]