Module mailslurp_client.models.send_email_options
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Expand source code
# coding: utf-8
"""
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository # noqa: E501
The version of the OpenAPI document: 6.5.2
Contact: contact@mailslurp.dev
Generated by: https://openapi-generator.tech
"""
import pprint
import re # noqa: F401
import six
from mailslurp_client.configuration import Configuration
class SendEmailOptions(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
"""
Attributes:
openapi_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
openapi_types = {
'to_contacts': 'list[str]',
'to_group': 'str',
'to': 'list[str]',
'_from': 'str',
'cc': 'list[str]',
'bcc': 'list[str]',
'subject': 'str',
'reply_to': 'str',
'custom_headers': 'dict(str, str)',
'body': 'str',
'html': 'bool',
'is_html': 'bool',
'charset': 'str',
'attachments': 'list[str]',
'template_variables': 'dict(str, object)',
'template': 'str',
'send_strategy': 'str',
'use_inbox_name': 'bool',
'add_tracking_pixel': 'bool',
'filter_bounced_recipients': 'bool',
'validate_email_addresses': 'str',
'ignore_empty_recipients': 'bool',
'is_x_amp_html': 'bool',
'body_parts': 'list[SendEmailBodyPart]'
}
attribute_map = {
'to_contacts': 'toContacts',
'to_group': 'toGroup',
'to': 'to',
'_from': 'from',
'cc': 'cc',
'bcc': 'bcc',
'subject': 'subject',
'reply_to': 'replyTo',
'custom_headers': 'customHeaders',
'body': 'body',
'html': 'html',
'is_html': 'isHTML',
'charset': 'charset',
'attachments': 'attachments',
'template_variables': 'templateVariables',
'template': 'template',
'send_strategy': 'sendStrategy',
'use_inbox_name': 'useInboxName',
'add_tracking_pixel': 'addTrackingPixel',
'filter_bounced_recipients': 'filterBouncedRecipients',
'validate_email_addresses': 'validateEmailAddresses',
'ignore_empty_recipients': 'ignoreEmptyRecipients',
'is_x_amp_html': 'isXAmpHtml',
'body_parts': 'bodyParts'
}
def __init__(self, to_contacts=None, to_group=None, to=None, _from=None, cc=None, bcc=None, subject=None, reply_to=None, custom_headers=None, body=None, html=None, is_html=None, charset=None, attachments=None, template_variables=None, template=None, send_strategy=None, use_inbox_name=None, add_tracking_pixel=None, filter_bounced_recipients=None, validate_email_addresses=None, ignore_empty_recipients=None, is_x_amp_html=None, body_parts=None, local_vars_configuration=None): # noqa: E501
"""SendEmailOptions - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
self._to_contacts = None
self._to_group = None
self._to = None
self.__from = None
self._cc = None
self._bcc = None
self._subject = None
self._reply_to = None
self._custom_headers = None
self._body = None
self._html = None
self._is_html = None
self._charset = None
self._attachments = None
self._template_variables = None
self._template = None
self._send_strategy = None
self._use_inbox_name = None
self._add_tracking_pixel = None
self._filter_bounced_recipients = None
self._validate_email_addresses = None
self._ignore_empty_recipients = None
self._is_x_amp_html = None
self._body_parts = None
self.discriminator = None
self.to_contacts = to_contacts
self.to_group = to_group
self.to = to
self._from = _from
self.cc = cc
self.bcc = bcc
self.subject = subject
self.reply_to = reply_to
self.custom_headers = custom_headers
self.body = body
self.html = html
self.is_html = is_html
self.charset = charset
self.attachments = attachments
self.template_variables = template_variables
self.template = template
self.send_strategy = send_strategy
self.use_inbox_name = use_inbox_name
self.add_tracking_pixel = add_tracking_pixel
self.filter_bounced_recipients = filter_bounced_recipients
self.validate_email_addresses = validate_email_addresses
self.ignore_empty_recipients = ignore_empty_recipients
self.is_x_amp_html = is_x_amp_html
self.body_parts = body_parts
@property
def to_contacts(self):
"""Gets the to_contacts of this SendEmailOptions. # noqa: E501
Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. # noqa: E501
:return: The to_contacts of this SendEmailOptions. # noqa: E501
:rtype: list[str]
"""
return self._to_contacts
@to_contacts.setter
def to_contacts(self, to_contacts):
"""Sets the to_contacts of this SendEmailOptions.
Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. # noqa: E501
:param to_contacts: The to_contacts of this SendEmailOptions. # noqa: E501
:type: list[str]
"""
self._to_contacts = to_contacts
@property
def to_group(self):
"""Gets the to_group of this SendEmailOptions. # noqa: E501
Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients # noqa: E501
:return: The to_group of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._to_group
@to_group.setter
def to_group(self, to_group):
"""Sets the to_group of this SendEmailOptions.
Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients # noqa: E501
:param to_group: The to_group of this SendEmailOptions. # noqa: E501
:type: str
"""
self._to_group = to_group
@property
def to(self):
"""Gets the to of this SendEmailOptions. # noqa: E501
List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. # noqa: E501
:return: The to of this SendEmailOptions. # noqa: E501
:rtype: list[str]
"""
return self._to
@to.setter
def to(self, to):
"""Sets the to of this SendEmailOptions.
List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. # noqa: E501
:param to: The to of this SendEmailOptions. # noqa: E501
:type: list[str]
"""
self._to = to
@property
def _from(self):
"""Gets the _from of this SendEmailOptions. # noqa: E501
Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used. # noqa: E501
:return: The _from of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self.__from
@_from.setter
def _from(self, _from):
"""Sets the _from of this SendEmailOptions.
Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used. # noqa: E501
:param _from: The _from of this SendEmailOptions. # noqa: E501
:type: str
"""
self.__from = _from
@property
def cc(self):
"""Gets the cc of this SendEmailOptions. # noqa: E501
Optional list of cc destination email addresses # noqa: E501
:return: The cc of this SendEmailOptions. # noqa: E501
:rtype: list[str]
"""
return self._cc
@cc.setter
def cc(self, cc):
"""Sets the cc of this SendEmailOptions.
Optional list of cc destination email addresses # noqa: E501
:param cc: The cc of this SendEmailOptions. # noqa: E501
:type: list[str]
"""
self._cc = cc
@property
def bcc(self):
"""Gets the bcc of this SendEmailOptions. # noqa: E501
Optional list of bcc destination email addresses # noqa: E501
:return: The bcc of this SendEmailOptions. # noqa: E501
:rtype: list[str]
"""
return self._bcc
@bcc.setter
def bcc(self, bcc):
"""Sets the bcc of this SendEmailOptions.
Optional list of bcc destination email addresses # noqa: E501
:param bcc: The bcc of this SendEmailOptions. # noqa: E501
:type: list[str]
"""
self._bcc = bcc
@property
def subject(self):
"""Gets the subject of this SendEmailOptions. # noqa: E501
Optional email subject line # noqa: E501
:return: The subject of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this SendEmailOptions.
Optional email subject line # noqa: E501
:param subject: The subject of this SendEmailOptions. # noqa: E501
:type: str
"""
self._subject = subject
@property
def reply_to(self):
"""Gets the reply_to of this SendEmailOptions. # noqa: E501
Optional replyTo header # noqa: E501
:return: The reply_to of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._reply_to
@reply_to.setter
def reply_to(self, reply_to):
"""Sets the reply_to of this SendEmailOptions.
Optional replyTo header # noqa: E501
:param reply_to: The reply_to of this SendEmailOptions. # noqa: E501
:type: str
"""
self._reply_to = reply_to
@property
def custom_headers(self):
"""Gets the custom_headers of this SendEmailOptions. # noqa: E501
Optional custom headers # noqa: E501
:return: The custom_headers of this SendEmailOptions. # noqa: E501
:rtype: dict(str, str)
"""
return self._custom_headers
@custom_headers.setter
def custom_headers(self, custom_headers):
"""Sets the custom_headers of this SendEmailOptions.
Optional custom headers # noqa: E501
:param custom_headers: The custom_headers of this SendEmailOptions. # noqa: E501
:type: dict(str, str)
"""
self._custom_headers = custom_headers
@property
def body(self):
"""Gets the body of this SendEmailOptions. # noqa: E501
Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. # noqa: E501
:return: The body of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._body
@body.setter
def body(self, body):
"""Sets the body of this SendEmailOptions.
Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. # noqa: E501
:param body: The body of this SendEmailOptions. # noqa: E501
:type: str
"""
self._body = body
@property
def html(self):
"""Gets the html of this SendEmailOptions. # noqa: E501
Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) # noqa: E501
:return: The html of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._html
@html.setter
def html(self, html):
"""Sets the html of this SendEmailOptions.
Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) # noqa: E501
:param html: The html of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._html = html
@property
def is_html(self):
"""Gets the is_html of this SendEmailOptions. # noqa: E501
Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients # noqa: E501
:return: The is_html of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._is_html
@is_html.setter
def is_html(self, is_html):
"""Sets the is_html of this SendEmailOptions.
Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients # noqa: E501
:param is_html: The is_html of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._is_html = is_html
@property
def charset(self):
"""Gets the charset of this SendEmailOptions. # noqa: E501
Optional charset # noqa: E501
:return: The charset of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._charset
@charset.setter
def charset(self, charset):
"""Sets the charset of this SendEmailOptions.
Optional charset # noqa: E501
:param charset: The charset of this SendEmailOptions. # noqa: E501
:type: str
"""
self._charset = charset
@property
def attachments(self):
"""Gets the attachments of this SendEmailOptions. # noqa: E501
Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. # noqa: E501
:return: The attachments of this SendEmailOptions. # noqa: E501
:rtype: list[str]
"""
return self._attachments
@attachments.setter
def attachments(self, attachments):
"""Sets the attachments of this SendEmailOptions.
Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. # noqa: E501
:param attachments: The attachments of this SendEmailOptions. # noqa: E501
:type: list[str]
"""
self._attachments = attachments
@property
def template_variables(self):
"""Gets the template_variables of this SendEmailOptions. # noqa: E501
Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. # noqa: E501
:return: The template_variables of this SendEmailOptions. # noqa: E501
:rtype: dict(str, object)
"""
return self._template_variables
@template_variables.setter
def template_variables(self, template_variables):
"""Sets the template_variables of this SendEmailOptions.
Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. # noqa: E501
:param template_variables: The template_variables of this SendEmailOptions. # noqa: E501
:type: dict(str, object)
"""
self._template_variables = template_variables
@property
def template(self):
"""Gets the template of this SendEmailOptions. # noqa: E501
Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. # noqa: E501
:return: The template of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._template
@template.setter
def template(self, template):
"""Sets the template of this SendEmailOptions.
Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. # noqa: E501
:param template: The template of this SendEmailOptions. # noqa: E501
:type: str
"""
self._template = template
@property
def send_strategy(self):
"""Gets the send_strategy of this SendEmailOptions. # noqa: E501
How an email should be sent based on its recipients # noqa: E501
:return: The send_strategy of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._send_strategy
@send_strategy.setter
def send_strategy(self, send_strategy):
"""Sets the send_strategy of this SendEmailOptions.
How an email should be sent based on its recipients # noqa: E501
:param send_strategy: The send_strategy of this SendEmailOptions. # noqa: E501
:type: str
"""
allowed_values = [None,"SINGLE_MESSAGE"] # noqa: E501
if self.local_vars_configuration.client_side_validation and send_strategy not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `send_strategy` ({0}), must be one of {1}" # noqa: E501
.format(send_strategy, allowed_values)
)
self._send_strategy = send_strategy
@property
def use_inbox_name(self):
"""Gets the use_inbox_name of this SendEmailOptions. # noqa: E501
Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name. # noqa: E501
:return: The use_inbox_name of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._use_inbox_name
@use_inbox_name.setter
def use_inbox_name(self, use_inbox_name):
"""Sets the use_inbox_name of this SendEmailOptions.
Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name. # noqa: E501
:param use_inbox_name: The use_inbox_name of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._use_inbox_name = use_inbox_name
@property
def add_tracking_pixel(self):
"""Gets the add_tracking_pixel of this SendEmailOptions. # noqa: E501
Add tracking pixel to email # noqa: E501
:return: The add_tracking_pixel of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._add_tracking_pixel
@add_tracking_pixel.setter
def add_tracking_pixel(self, add_tracking_pixel):
"""Sets the add_tracking_pixel of this SendEmailOptions.
Add tracking pixel to email # noqa: E501
:param add_tracking_pixel: The add_tracking_pixel of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._add_tracking_pixel = add_tracking_pixel
@property
def filter_bounced_recipients(self):
"""Gets the filter_bounced_recipients of this SendEmailOptions. # noqa: E501
Filter recipients to remove any bounced recipients from to, bcc, and cc before sending # noqa: E501
:return: The filter_bounced_recipients of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._filter_bounced_recipients
@filter_bounced_recipients.setter
def filter_bounced_recipients(self, filter_bounced_recipients):
"""Sets the filter_bounced_recipients of this SendEmailOptions.
Filter recipients to remove any bounced recipients from to, bcc, and cc before sending # noqa: E501
:param filter_bounced_recipients: The filter_bounced_recipients of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._filter_bounced_recipients = filter_bounced_recipients
@property
def validate_email_addresses(self):
"""Gets the validate_email_addresses of this SendEmailOptions. # noqa: E501
Validate recipient email addresses before sending # noqa: E501
:return: The validate_email_addresses of this SendEmailOptions. # noqa: E501
:rtype: str
"""
return self._validate_email_addresses
@validate_email_addresses.setter
def validate_email_addresses(self, validate_email_addresses):
"""Sets the validate_email_addresses of this SendEmailOptions.
Validate recipient email addresses before sending # noqa: E501
:param validate_email_addresses: The validate_email_addresses of this SendEmailOptions. # noqa: E501
:type: str
"""
allowed_values = [None,"VALIDATE_FILTER_REMOVE_INVALID", "VALIDATE_ERROR_IF_INVALID", "NO_VALIDATION"] # noqa: E501
if self.local_vars_configuration.client_side_validation and validate_email_addresses not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `validate_email_addresses` ({0}), must be one of {1}" # noqa: E501
.format(validate_email_addresses, allowed_values)
)
self._validate_email_addresses = validate_email_addresses
@property
def ignore_empty_recipients(self):
"""Gets the ignore_empty_recipients of this SendEmailOptions. # noqa: E501
Ignore empty recipients after validation removes all recipients as invalid and fail silently # noqa: E501
:return: The ignore_empty_recipients of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._ignore_empty_recipients
@ignore_empty_recipients.setter
def ignore_empty_recipients(self, ignore_empty_recipients):
"""Sets the ignore_empty_recipients of this SendEmailOptions.
Ignore empty recipients after validation removes all recipients as invalid and fail silently # noqa: E501
:param ignore_empty_recipients: The ignore_empty_recipients of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._ignore_empty_recipients = ignore_empty_recipients
@property
def is_x_amp_html(self):
"""Gets the is_x_amp_html of this SendEmailOptions. # noqa: E501
Is content AMP4EMAIL compatible. If set will send as x-amp-html part. # noqa: E501
:return: The is_x_amp_html of this SendEmailOptions. # noqa: E501
:rtype: bool
"""
return self._is_x_amp_html
@is_x_amp_html.setter
def is_x_amp_html(self, is_x_amp_html):
"""Sets the is_x_amp_html of this SendEmailOptions.
Is content AMP4EMAIL compatible. If set will send as x-amp-html part. # noqa: E501
:param is_x_amp_html: The is_x_amp_html of this SendEmailOptions. # noqa: E501
:type: bool
"""
self._is_x_amp_html = is_x_amp_html
@property
def body_parts(self):
"""Gets the body_parts of this SendEmailOptions. # noqa: E501
Email body content parts for multipart mime message. Will override body. # noqa: E501
:return: The body_parts of this SendEmailOptions. # noqa: E501
:rtype: list[SendEmailBodyPart]
"""
return self._body_parts
@body_parts.setter
def body_parts(self, body_parts):
"""Sets the body_parts of this SendEmailOptions.
Email body content parts for multipart mime message. Will override body. # noqa: E501
:param body_parts: The body_parts of this SendEmailOptions. # noqa: E501
:type: list[SendEmailBodyPart]
"""
self._body_parts = body_parts
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.openapi_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendEmailOptions):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
if not isinstance(other, SendEmailOptions):
return True
return self.to_dict() != other.to_dict()Classes
class SendEmailOptions (to_contacts=None, to_group=None, to=None, cc=None, bcc=None, subject=None, reply_to=None, custom_headers=None, body=None, html=None, is_html=None, charset=None, attachments=None, template_variables=None, template=None, send_strategy=None, use_inbox_name=None, add_tracking_pixel=None, filter_bounced_recipients=None, validate_email_addresses=None, ignore_empty_recipients=None, is_x_amp_html=None, body_parts=None, local_vars_configuration=None)-
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
SendEmailOptions - a model defined in OpenAPI
Expand source code
class SendEmailOptions(object): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually. """ """ Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition. """ openapi_types = { 'to_contacts': 'list[str]', 'to_group': 'str', 'to': 'list[str]', '_from': 'str', 'cc': 'list[str]', 'bcc': 'list[str]', 'subject': 'str', 'reply_to': 'str', 'custom_headers': 'dict(str, str)', 'body': 'str', 'html': 'bool', 'is_html': 'bool', 'charset': 'str', 'attachments': 'list[str]', 'template_variables': 'dict(str, object)', 'template': 'str', 'send_strategy': 'str', 'use_inbox_name': 'bool', 'add_tracking_pixel': 'bool', 'filter_bounced_recipients': 'bool', 'validate_email_addresses': 'str', 'ignore_empty_recipients': 'bool', 'is_x_amp_html': 'bool', 'body_parts': 'list[SendEmailBodyPart]' } attribute_map = { 'to_contacts': 'toContacts', 'to_group': 'toGroup', 'to': 'to', '_from': 'from', 'cc': 'cc', 'bcc': 'bcc', 'subject': 'subject', 'reply_to': 'replyTo', 'custom_headers': 'customHeaders', 'body': 'body', 'html': 'html', 'is_html': 'isHTML', 'charset': 'charset', 'attachments': 'attachments', 'template_variables': 'templateVariables', 'template': 'template', 'send_strategy': 'sendStrategy', 'use_inbox_name': 'useInboxName', 'add_tracking_pixel': 'addTrackingPixel', 'filter_bounced_recipients': 'filterBouncedRecipients', 'validate_email_addresses': 'validateEmailAddresses', 'ignore_empty_recipients': 'ignoreEmptyRecipients', 'is_x_amp_html': 'isXAmpHtml', 'body_parts': 'bodyParts' } def __init__(self, to_contacts=None, to_group=None, to=None, _from=None, cc=None, bcc=None, subject=None, reply_to=None, custom_headers=None, body=None, html=None, is_html=None, charset=None, attachments=None, template_variables=None, template=None, send_strategy=None, use_inbox_name=None, add_tracking_pixel=None, filter_bounced_recipients=None, validate_email_addresses=None, ignore_empty_recipients=None, is_x_amp_html=None, body_parts=None, local_vars_configuration=None): # noqa: E501 """SendEmailOptions - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._to_contacts = None self._to_group = None self._to = None self.__from = None self._cc = None self._bcc = None self._subject = None self._reply_to = None self._custom_headers = None self._body = None self._html = None self._is_html = None self._charset = None self._attachments = None self._template_variables = None self._template = None self._send_strategy = None self._use_inbox_name = None self._add_tracking_pixel = None self._filter_bounced_recipients = None self._validate_email_addresses = None self._ignore_empty_recipients = None self._is_x_amp_html = None self._body_parts = None self.discriminator = None self.to_contacts = to_contacts self.to_group = to_group self.to = to self._from = _from self.cc = cc self.bcc = bcc self.subject = subject self.reply_to = reply_to self.custom_headers = custom_headers self.body = body self.html = html self.is_html = is_html self.charset = charset self.attachments = attachments self.template_variables = template_variables self.template = template self.send_strategy = send_strategy self.use_inbox_name = use_inbox_name self.add_tracking_pixel = add_tracking_pixel self.filter_bounced_recipients = filter_bounced_recipients self.validate_email_addresses = validate_email_addresses self.ignore_empty_recipients = ignore_empty_recipients self.is_x_amp_html = is_x_amp_html self.body_parts = body_parts @property def to_contacts(self): """Gets the to_contacts of this SendEmailOptions. # noqa: E501 Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. # noqa: E501 :return: The to_contacts of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._to_contacts @to_contacts.setter def to_contacts(self, to_contacts): """Sets the to_contacts of this SendEmailOptions. Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. # noqa: E501 :param to_contacts: The to_contacts of this SendEmailOptions. # noqa: E501 :type: list[str] """ self._to_contacts = to_contacts @property def to_group(self): """Gets the to_group of this SendEmailOptions. # noqa: E501 Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients # noqa: E501 :return: The to_group of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._to_group @to_group.setter def to_group(self, to_group): """Sets the to_group of this SendEmailOptions. Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients # noqa: E501 :param to_group: The to_group of this SendEmailOptions. # noqa: E501 :type: str """ self._to_group = to_group @property def to(self): """Gets the to of this SendEmailOptions. # noqa: E501 List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. # noqa: E501 :return: The to of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._to @to.setter def to(self, to): """Sets the to of this SendEmailOptions. List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. # noqa: E501 :param to: The to of this SendEmailOptions. # noqa: E501 :type: list[str] """ self._to = to @property def _from(self): """Gets the _from of this SendEmailOptions. # noqa: E501 Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used. # noqa: E501 :return: The _from of this SendEmailOptions. # noqa: E501 :rtype: str """ return self.__from @_from.setter def _from(self, _from): """Sets the _from of this SendEmailOptions. Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used. # noqa: E501 :param _from: The _from of this SendEmailOptions. # noqa: E501 :type: str """ self.__from = _from @property def cc(self): """Gets the cc of this SendEmailOptions. # noqa: E501 Optional list of cc destination email addresses # noqa: E501 :return: The cc of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._cc @cc.setter def cc(self, cc): """Sets the cc of this SendEmailOptions. Optional list of cc destination email addresses # noqa: E501 :param cc: The cc of this SendEmailOptions. # noqa: E501 :type: list[str] """ self._cc = cc @property def bcc(self): """Gets the bcc of this SendEmailOptions. # noqa: E501 Optional list of bcc destination email addresses # noqa: E501 :return: The bcc of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._bcc @bcc.setter def bcc(self, bcc): """Sets the bcc of this SendEmailOptions. Optional list of bcc destination email addresses # noqa: E501 :param bcc: The bcc of this SendEmailOptions. # noqa: E501 :type: list[str] """ self._bcc = bcc @property def subject(self): """Gets the subject of this SendEmailOptions. # noqa: E501 Optional email subject line # noqa: E501 :return: The subject of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._subject @subject.setter def subject(self, subject): """Sets the subject of this SendEmailOptions. Optional email subject line # noqa: E501 :param subject: The subject of this SendEmailOptions. # noqa: E501 :type: str """ self._subject = subject @property def reply_to(self): """Gets the reply_to of this SendEmailOptions. # noqa: E501 Optional replyTo header # noqa: E501 :return: The reply_to of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._reply_to @reply_to.setter def reply_to(self, reply_to): """Sets the reply_to of this SendEmailOptions. Optional replyTo header # noqa: E501 :param reply_to: The reply_to of this SendEmailOptions. # noqa: E501 :type: str """ self._reply_to = reply_to @property def custom_headers(self): """Gets the custom_headers of this SendEmailOptions. # noqa: E501 Optional custom headers # noqa: E501 :return: The custom_headers of this SendEmailOptions. # noqa: E501 :rtype: dict(str, str) """ return self._custom_headers @custom_headers.setter def custom_headers(self, custom_headers): """Sets the custom_headers of this SendEmailOptions. Optional custom headers # noqa: E501 :param custom_headers: The custom_headers of this SendEmailOptions. # noqa: E501 :type: dict(str, str) """ self._custom_headers = custom_headers @property def body(self): """Gets the body of this SendEmailOptions. # noqa: E501 Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. # noqa: E501 :return: The body of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._body @body.setter def body(self, body): """Sets the body of this SendEmailOptions. Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. # noqa: E501 :param body: The body of this SendEmailOptions. # noqa: E501 :type: str """ self._body = body @property def html(self): """Gets the html of this SendEmailOptions. # noqa: E501 Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) # noqa: E501 :return: The html of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._html @html.setter def html(self, html): """Sets the html of this SendEmailOptions. Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) # noqa: E501 :param html: The html of this SendEmailOptions. # noqa: E501 :type: bool """ self._html = html @property def is_html(self): """Gets the is_html of this SendEmailOptions. # noqa: E501 Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients # noqa: E501 :return: The is_html of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._is_html @is_html.setter def is_html(self, is_html): """Sets the is_html of this SendEmailOptions. Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients # noqa: E501 :param is_html: The is_html of this SendEmailOptions. # noqa: E501 :type: bool """ self._is_html = is_html @property def charset(self): """Gets the charset of this SendEmailOptions. # noqa: E501 Optional charset # noqa: E501 :return: The charset of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._charset @charset.setter def charset(self, charset): """Sets the charset of this SendEmailOptions. Optional charset # noqa: E501 :param charset: The charset of this SendEmailOptions. # noqa: E501 :type: str """ self._charset = charset @property def attachments(self): """Gets the attachments of this SendEmailOptions. # noqa: E501 Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. # noqa: E501 :return: The attachments of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._attachments @attachments.setter def attachments(self, attachments): """Sets the attachments of this SendEmailOptions. Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. # noqa: E501 :param attachments: The attachments of this SendEmailOptions. # noqa: E501 :type: list[str] """ self._attachments = attachments @property def template_variables(self): """Gets the template_variables of this SendEmailOptions. # noqa: E501 Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. # noqa: E501 :return: The template_variables of this SendEmailOptions. # noqa: E501 :rtype: dict(str, object) """ return self._template_variables @template_variables.setter def template_variables(self, template_variables): """Sets the template_variables of this SendEmailOptions. Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. # noqa: E501 :param template_variables: The template_variables of this SendEmailOptions. # noqa: E501 :type: dict(str, object) """ self._template_variables = template_variables @property def template(self): """Gets the template of this SendEmailOptions. # noqa: E501 Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. # noqa: E501 :return: The template of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._template @template.setter def template(self, template): """Sets the template of this SendEmailOptions. Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. # noqa: E501 :param template: The template of this SendEmailOptions. # noqa: E501 :type: str """ self._template = template @property def send_strategy(self): """Gets the send_strategy of this SendEmailOptions. # noqa: E501 How an email should be sent based on its recipients # noqa: E501 :return: The send_strategy of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._send_strategy @send_strategy.setter def send_strategy(self, send_strategy): """Sets the send_strategy of this SendEmailOptions. How an email should be sent based on its recipients # noqa: E501 :param send_strategy: The send_strategy of this SendEmailOptions. # noqa: E501 :type: str """ allowed_values = [None,"SINGLE_MESSAGE"] # noqa: E501 if self.local_vars_configuration.client_side_validation and send_strategy not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `send_strategy` ({0}), must be one of {1}" # noqa: E501 .format(send_strategy, allowed_values) ) self._send_strategy = send_strategy @property def use_inbox_name(self): """Gets the use_inbox_name of this SendEmailOptions. # noqa: E501 Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name. # noqa: E501 :return: The use_inbox_name of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._use_inbox_name @use_inbox_name.setter def use_inbox_name(self, use_inbox_name): """Sets the use_inbox_name of this SendEmailOptions. Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name. # noqa: E501 :param use_inbox_name: The use_inbox_name of this SendEmailOptions. # noqa: E501 :type: bool """ self._use_inbox_name = use_inbox_name @property def add_tracking_pixel(self): """Gets the add_tracking_pixel of this SendEmailOptions. # noqa: E501 Add tracking pixel to email # noqa: E501 :return: The add_tracking_pixel of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._add_tracking_pixel @add_tracking_pixel.setter def add_tracking_pixel(self, add_tracking_pixel): """Sets the add_tracking_pixel of this SendEmailOptions. Add tracking pixel to email # noqa: E501 :param add_tracking_pixel: The add_tracking_pixel of this SendEmailOptions. # noqa: E501 :type: bool """ self._add_tracking_pixel = add_tracking_pixel @property def filter_bounced_recipients(self): """Gets the filter_bounced_recipients of this SendEmailOptions. # noqa: E501 Filter recipients to remove any bounced recipients from to, bcc, and cc before sending # noqa: E501 :return: The filter_bounced_recipients of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._filter_bounced_recipients @filter_bounced_recipients.setter def filter_bounced_recipients(self, filter_bounced_recipients): """Sets the filter_bounced_recipients of this SendEmailOptions. Filter recipients to remove any bounced recipients from to, bcc, and cc before sending # noqa: E501 :param filter_bounced_recipients: The filter_bounced_recipients of this SendEmailOptions. # noqa: E501 :type: bool """ self._filter_bounced_recipients = filter_bounced_recipients @property def validate_email_addresses(self): """Gets the validate_email_addresses of this SendEmailOptions. # noqa: E501 Validate recipient email addresses before sending # noqa: E501 :return: The validate_email_addresses of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._validate_email_addresses @validate_email_addresses.setter def validate_email_addresses(self, validate_email_addresses): """Sets the validate_email_addresses of this SendEmailOptions. Validate recipient email addresses before sending # noqa: E501 :param validate_email_addresses: The validate_email_addresses of this SendEmailOptions. # noqa: E501 :type: str """ allowed_values = [None,"VALIDATE_FILTER_REMOVE_INVALID", "VALIDATE_ERROR_IF_INVALID", "NO_VALIDATION"] # noqa: E501 if self.local_vars_configuration.client_side_validation and validate_email_addresses not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `validate_email_addresses` ({0}), must be one of {1}" # noqa: E501 .format(validate_email_addresses, allowed_values) ) self._validate_email_addresses = validate_email_addresses @property def ignore_empty_recipients(self): """Gets the ignore_empty_recipients of this SendEmailOptions. # noqa: E501 Ignore empty recipients after validation removes all recipients as invalid and fail silently # noqa: E501 :return: The ignore_empty_recipients of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._ignore_empty_recipients @ignore_empty_recipients.setter def ignore_empty_recipients(self, ignore_empty_recipients): """Sets the ignore_empty_recipients of this SendEmailOptions. Ignore empty recipients after validation removes all recipients as invalid and fail silently # noqa: E501 :param ignore_empty_recipients: The ignore_empty_recipients of this SendEmailOptions. # noqa: E501 :type: bool """ self._ignore_empty_recipients = ignore_empty_recipients @property def is_x_amp_html(self): """Gets the is_x_amp_html of this SendEmailOptions. # noqa: E501 Is content AMP4EMAIL compatible. If set will send as x-amp-html part. # noqa: E501 :return: The is_x_amp_html of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._is_x_amp_html @is_x_amp_html.setter def is_x_amp_html(self, is_x_amp_html): """Sets the is_x_amp_html of this SendEmailOptions. Is content AMP4EMAIL compatible. If set will send as x-amp-html part. # noqa: E501 :param is_x_amp_html: The is_x_amp_html of this SendEmailOptions. # noqa: E501 :type: bool """ self._is_x_amp_html = is_x_amp_html @property def body_parts(self): """Gets the body_parts of this SendEmailOptions. # noqa: E501 Email body content parts for multipart mime message. Will override body. # noqa: E501 :return: The body_parts of this SendEmailOptions. # noqa: E501 :rtype: list[SendEmailBodyPart] """ return self._body_parts @body_parts.setter def body_parts(self, body_parts): """Sets the body_parts of this SendEmailOptions. Email body content parts for multipart mime message. Will override body. # noqa: E501 :param body_parts: The body_parts of this SendEmailOptions. # noqa: E501 :type: list[SendEmailBodyPart] """ self._body_parts = body_parts def to_dict(self): """Returns the model properties as a dict""" result = {} for attr, _ in six.iteritems(self.openapi_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value )) elif hasattr(value, "to_dict"): result[attr] = value.to_dict() elif isinstance(value, dict): result[attr] = dict(map( lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, value.items() )) else: result[attr] = value return result def to_str(self): """Returns the string representation of the model""" return pprint.pformat(self.to_dict()) def __repr__(self): """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): """Returns true if both objects are equal""" if not isinstance(other, SendEmailOptions): return False return self.to_dict() == other.to_dict() def __ne__(self, other): """Returns true if both objects are not equal""" if not isinstance(other, SendEmailOptions): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var add_tracking_pixel-
Gets the add_tracking_pixel of this SendEmailOptions. # noqa: E501
Add tracking pixel to email # noqa: E501
:return: The add_tracking_pixel of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def add_tracking_pixel(self): """Gets the add_tracking_pixel of this SendEmailOptions. # noqa: E501 Add tracking pixel to email # noqa: E501 :return: The add_tracking_pixel of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._add_tracking_pixel var attachments-
Gets the attachments of this SendEmailOptions. # noqa: E501
Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support
multi-part form,base64 file encoding, and octet stream binary uploads. See theUploadControllerfor available methods. # noqa: E501:return: The attachments of this SendEmailOptions. # noqa: E501 :rtype: list[str]
Expand source code
@property def attachments(self): """Gets the attachments of this SendEmailOptions. # noqa: E501 Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. # noqa: E501 :return: The attachments of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._attachments var bcc-
Gets the bcc of this SendEmailOptions. # noqa: E501
Optional list of bcc destination email addresses # noqa: E501
:return: The bcc of this SendEmailOptions. # noqa: E501 :rtype: list[str]
Expand source code
@property def bcc(self): """Gets the bcc of this SendEmailOptions. # noqa: E501 Optional list of bcc destination email addresses # noqa: E501 :return: The bcc of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._bcc var body-
Gets the body of this SendEmailOptions. # noqa: E501
Optional contents of email. If body contains HTML then set
isHTMLto true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction withtoGroupcontact variables ortemplateVariablesdata. If you need more templating control consider creating a template and using thetemplateproperty instead of the body. # noqa: E501:return: The body of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def body(self): """Gets the body of this SendEmailOptions. # noqa: E501 Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. # noqa: E501 :return: The body of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._body var body_parts-
Gets the body_parts of this SendEmailOptions. # noqa: E501
Email body content parts for multipart mime message. Will override body. # noqa: E501
:return: The body_parts of this SendEmailOptions. # noqa: E501 :rtype: list[SendEmailBodyPart]
Expand source code
@property def body_parts(self): """Gets the body_parts of this SendEmailOptions. # noqa: E501 Email body content parts for multipart mime message. Will override body. # noqa: E501 :return: The body_parts of this SendEmailOptions. # noqa: E501 :rtype: list[SendEmailBodyPart] """ return self._body_parts var cc-
Gets the cc of this SendEmailOptions. # noqa: E501
Optional list of cc destination email addresses # noqa: E501
:return: The cc of this SendEmailOptions. # noqa: E501 :rtype: list[str]
Expand source code
@property def cc(self): """Gets the cc of this SendEmailOptions. # noqa: E501 Optional list of cc destination email addresses # noqa: E501 :return: The cc of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._cc var charset-
Gets the charset of this SendEmailOptions. # noqa: E501
Optional charset # noqa: E501
:return: The charset of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def charset(self): """Gets the charset of this SendEmailOptions. # noqa: E501 Optional charset # noqa: E501 :return: The charset of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._charset var custom_headers-
Gets the custom_headers of this SendEmailOptions. # noqa: E501
Optional custom headers # noqa: E501
:return: The custom_headers of this SendEmailOptions. # noqa: E501 :rtype: dict(str, str)
Expand source code
@property def custom_headers(self): """Gets the custom_headers of this SendEmailOptions. # noqa: E501 Optional custom headers # noqa: E501 :return: The custom_headers of this SendEmailOptions. # noqa: E501 :rtype: dict(str, str) """ return self._custom_headers var filter_bounced_recipients-
Gets the filter_bounced_recipients of this SendEmailOptions. # noqa: E501
Filter recipients to remove any bounced recipients from to, bcc, and cc before sending # noqa: E501
:return: The filter_bounced_recipients of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def filter_bounced_recipients(self): """Gets the filter_bounced_recipients of this SendEmailOptions. # noqa: E501 Filter recipients to remove any bounced recipients from to, bcc, and cc before sending # noqa: E501 :return: The filter_bounced_recipients of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._filter_bounced_recipients var html-
Gets the html of this SendEmailOptions. # noqa: E501
Optional HTML flag to indicate that contents is HTML. Set's a
content-type: text/htmlfor email. (Deprecated: useisHTMLinstead.) # noqa: E501:return: The html of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def html(self): """Gets the html of this SendEmailOptions. # noqa: E501 Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.) # noqa: E501 :return: The html of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._html var ignore_empty_recipients-
Gets the ignore_empty_recipients of this SendEmailOptions. # noqa: E501
Ignore empty recipients after validation removes all recipients as invalid and fail silently # noqa: E501
:return: The ignore_empty_recipients of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def ignore_empty_recipients(self): """Gets the ignore_empty_recipients of this SendEmailOptions. # noqa: E501 Ignore empty recipients after validation removes all recipients as invalid and fail silently # noqa: E501 :return: The ignore_empty_recipients of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._ignore_empty_recipients var is_html-
Gets the is_html of this SendEmailOptions. # noqa: E501
Optional HTML flag. If true the
content-typeof the email will betext/html. Set to true when sending HTML to ensure proper rending on email clients # noqa: E501:return: The is_html of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def is_html(self): """Gets the is_html of this SendEmailOptions. # noqa: E501 Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients # noqa: E501 :return: The is_html of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._is_html var is_x_amp_html-
Gets the is_x_amp_html of this SendEmailOptions. # noqa: E501
Is content AMP4EMAIL compatible. If set will send as x-amp-html part. # noqa: E501
:return: The is_x_amp_html of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def is_x_amp_html(self): """Gets the is_x_amp_html of this SendEmailOptions. # noqa: E501 Is content AMP4EMAIL compatible. If set will send as x-amp-html part. # noqa: E501 :return: The is_x_amp_html of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._is_x_amp_html var reply_to-
Gets the reply_to of this SendEmailOptions. # noqa: E501
Optional replyTo header # noqa: E501
:return: The reply_to of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def reply_to(self): """Gets the reply_to of this SendEmailOptions. # noqa: E501 Optional replyTo header # noqa: E501 :return: The reply_to of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._reply_to var send_strategy-
Gets the send_strategy of this SendEmailOptions. # noqa: E501
How an email should be sent based on its recipients # noqa: E501
:return: The send_strategy of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def send_strategy(self): """Gets the send_strategy of this SendEmailOptions. # noqa: E501 How an email should be sent based on its recipients # noqa: E501 :return: The send_strategy of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._send_strategy var subject-
Gets the subject of this SendEmailOptions. # noqa: E501
Optional email subject line # noqa: E501
:return: The subject of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def subject(self): """Gets the subject of this SendEmailOptions. # noqa: E501 Optional email subject line # noqa: E501 :return: The subject of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._subject var template-
Gets the template of this SendEmailOptions. # noqa: E501
Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of
templateVariables. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. # noqa: E501:return: The template of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def template(self): """Gets the template of this SendEmailOptions. # noqa: E501 Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. # noqa: E501 :return: The template of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._template var template_variables-
Gets the template_variables of this SendEmailOptions. # noqa: E501
Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. # noqa: E501
:return: The template_variables of this SendEmailOptions. # noqa: E501 :rtype: dict(str, object)
Expand source code
@property def template_variables(self): """Gets the template_variables of this SendEmailOptions. # noqa: E501 Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. # noqa: E501 :return: The template_variables of this SendEmailOptions. # noqa: E501 :rtype: dict(str, object) """ return self._template_variables var to-
Gets the to of this SendEmailOptions. # noqa: E501
List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. # noqa: E501
:return: The to of this SendEmailOptions. # noqa: E501 :rtype: list[str]
Expand source code
@property def to(self): """Gets the to of this SendEmailOptions. # noqa: E501 List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing. # noqa: E501 :return: The to of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._to var to_contacts-
Gets the to_contacts of this SendEmailOptions. # noqa: E501
Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. # noqa: E501
:return: The to_contacts of this SendEmailOptions. # noqa: E501 :rtype: list[str]
Expand source code
@property def to_contacts(self): """Gets the to_contacts of this SendEmailOptions. # noqa: E501 Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. # noqa: E501 :return: The to_contacts of this SendEmailOptions. # noqa: E501 :rtype: list[str] """ return self._to_contacts var to_group-
Gets the to_group of this SendEmailOptions. # noqa: E501
Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients # noqa: E501
:return: The to_group of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def to_group(self): """Gets the to_group of this SendEmailOptions. # noqa: E501 Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients # noqa: E501 :return: The to_group of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._to_group var use_inbox_name-
Gets the use_inbox_name of this SendEmailOptions. # noqa: E501
Use name of inbox as sender email address name. Will construct RFC 5322 email address with
Inbox name <inbox@address.com>if the inbox has a name. # noqa: E501:return: The use_inbox_name of this SendEmailOptions. # noqa: E501 :rtype: bool
Expand source code
@property def use_inbox_name(self): """Gets the use_inbox_name of this SendEmailOptions. # noqa: E501 Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name. # noqa: E501 :return: The use_inbox_name of this SendEmailOptions. # noqa: E501 :rtype: bool """ return self._use_inbox_name var validate_email_addresses-
Gets the validate_email_addresses of this SendEmailOptions. # noqa: E501
Validate recipient email addresses before sending # noqa: E501
:return: The validate_email_addresses of this SendEmailOptions. # noqa: E501 :rtype: str
Expand source code
@property def validate_email_addresses(self): """Gets the validate_email_addresses of this SendEmailOptions. # noqa: E501 Validate recipient email addresses before sending # noqa: E501 :return: The validate_email_addresses of this SendEmailOptions. # noqa: E501 :rtype: str """ return self._validate_email_addresses
Methods
def to_dict(self)-
Returns the model properties as a dict
Expand source code
def to_dict(self): """Returns the model properties as a dict""" result = {} for attr, _ in six.iteritems(self.openapi_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value )) elif hasattr(value, "to_dict"): result[attr] = value.to_dict() elif isinstance(value, dict): result[attr] = dict(map( lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, value.items() )) else: result[attr] = value return result def to_str(self)-
Returns the string representation of the model
Expand source code
def to_str(self): """Returns the string representation of the model""" return pprint.pformat(self.to_dict())