Module mailslurp_client.models.webhook_new_email_payload
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 WebhookNewEmailPayload(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 = {
'message_id': 'str',
'webhook_id': 'str',
'event_name': 'str',
'webhook_name': 'str',
'inbox_id': 'str',
'domain_id': 'str',
'email_id': 'str',
'created_at': 'datetime',
'to': 'list[str]',
'_from': 'str',
'cc': 'list[str]',
'bcc': 'list[str]',
'subject': 'str',
'attachment_meta_datas': 'list[AttachmentMetaData]'
}
attribute_map = {
'message_id': 'messageId',
'webhook_id': 'webhookId',
'event_name': 'eventName',
'webhook_name': 'webhookName',
'inbox_id': 'inboxId',
'domain_id': 'domainId',
'email_id': 'emailId',
'created_at': 'createdAt',
'to': 'to',
'_from': 'from',
'cc': 'cc',
'bcc': 'bcc',
'subject': 'subject',
'attachment_meta_datas': 'attachmentMetaDatas'
}
def __init__(self, message_id=None, webhook_id=None, event_name=None, webhook_name=None, inbox_id=None, domain_id=None, email_id=None, created_at=None, to=None, _from=None, cc=None, bcc=None, subject=None, attachment_meta_datas=None, local_vars_configuration=None): # noqa: E501
"""WebhookNewEmailPayload - 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._message_id = None
self._webhook_id = None
self._event_name = None
self._webhook_name = None
self._inbox_id = None
self._domain_id = None
self._email_id = None
self._created_at = None
self._to = None
self.__from = None
self._cc = None
self._bcc = None
self._subject = None
self._attachment_meta_datas = None
self.discriminator = None
self.message_id = message_id
self.webhook_id = webhook_id
self.event_name = event_name
self.webhook_name = webhook_name
self.inbox_id = inbox_id
self.domain_id = domain_id
self.email_id = email_id
self.created_at = created_at
self.to = to
self._from = _from
self.cc = cc
self.bcc = bcc
self.subject = subject
self.attachment_meta_datas = attachment_meta_datas
@property
def message_id(self):
"""Gets the message_id of this WebhookNewEmailPayload. # noqa: E501
Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501
:return: The message_id of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._message_id
@message_id.setter
def message_id(self, message_id):
"""Sets the message_id of this WebhookNewEmailPayload.
Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501
:param message_id: The message_id of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and message_id is None: # noqa: E501
raise ValueError("Invalid value for `message_id`, must not be `None`") # noqa: E501
self._message_id = message_id
@property
def webhook_id(self):
"""Gets the webhook_id of this WebhookNewEmailPayload. # noqa: E501
ID of webhook entity being triggered # noqa: E501
:return: The webhook_id of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._webhook_id
@webhook_id.setter
def webhook_id(self, webhook_id):
"""Sets the webhook_id of this WebhookNewEmailPayload.
ID of webhook entity being triggered # noqa: E501
:param webhook_id: The webhook_id of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and webhook_id is None: # noqa: E501
raise ValueError("Invalid value for `webhook_id`, must not be `None`") # noqa: E501
self._webhook_id = webhook_id
@property
def event_name(self):
"""Gets the event_name of this WebhookNewEmailPayload. # noqa: E501
Name of the event type webhook is being triggered for. # noqa: E501
:return: The event_name of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._event_name
@event_name.setter
def event_name(self, event_name):
"""Sets the event_name of this WebhookNewEmailPayload.
Name of the event type webhook is being triggered for. # noqa: E501
:param event_name: The event_name of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and event_name is None: # noqa: E501
raise ValueError("Invalid value for `event_name`, must not be `None`") # noqa: E501
allowed_values = ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"] # noqa: E501
if self.local_vars_configuration.client_side_validation and event_name not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `event_name` ({0}), must be one of {1}" # noqa: E501
.format(event_name, allowed_values)
)
self._event_name = event_name
@property
def webhook_name(self):
"""Gets the webhook_name of this WebhookNewEmailPayload. # noqa: E501
Name of the webhook being triggered # noqa: E501
:return: The webhook_name of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._webhook_name
@webhook_name.setter
def webhook_name(self, webhook_name):
"""Sets the webhook_name of this WebhookNewEmailPayload.
Name of the webhook being triggered # noqa: E501
:param webhook_name: The webhook_name of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
self._webhook_name = webhook_name
@property
def inbox_id(self):
"""Gets the inbox_id of this WebhookNewEmailPayload. # noqa: E501
Id of the inbox # noqa: E501
:return: The inbox_id of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._inbox_id
@inbox_id.setter
def inbox_id(self, inbox_id):
"""Sets the inbox_id of this WebhookNewEmailPayload.
Id of the inbox # noqa: E501
:param inbox_id: The inbox_id of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and inbox_id is None: # noqa: E501
raise ValueError("Invalid value for `inbox_id`, must not be `None`") # noqa: E501
self._inbox_id = inbox_id
@property
def domain_id(self):
"""Gets the domain_id of this WebhookNewEmailPayload. # noqa: E501
Id of the domain that received an email # noqa: E501
:return: The domain_id of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._domain_id
@domain_id.setter
def domain_id(self, domain_id):
"""Sets the domain_id of this WebhookNewEmailPayload.
Id of the domain that received an email # noqa: E501
:param domain_id: The domain_id of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
self._domain_id = domain_id
@property
def email_id(self):
"""Gets the email_id of this WebhookNewEmailPayload. # noqa: E501
ID of the email that was received. Use this ID for fetching the email with the `EmailController`. # noqa: E501
:return: The email_id of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._email_id
@email_id.setter
def email_id(self, email_id):
"""Sets the email_id of this WebhookNewEmailPayload.
ID of the email that was received. Use this ID for fetching the email with the `EmailController`. # noqa: E501
:param email_id: The email_id of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and email_id is None: # noqa: E501
raise ValueError("Invalid value for `email_id`, must not be `None`") # noqa: E501
self._email_id = email_id
@property
def created_at(self):
"""Gets the created_at of this WebhookNewEmailPayload. # noqa: E501
Date time of event creation # noqa: E501
:return: The created_at of this WebhookNewEmailPayload. # noqa: E501
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this WebhookNewEmailPayload.
Date time of event creation # noqa: E501
:param created_at: The created_at of this WebhookNewEmailPayload. # noqa: E501
:type: datetime
"""
if self.local_vars_configuration.client_side_validation and created_at is None: # noqa: E501
raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501
self._created_at = created_at
@property
def to(self):
"""Gets the to of this WebhookNewEmailPayload. # noqa: E501
List of `To` recipient email addresses that the email was addressed to. See recipients object for names. # noqa: E501
:return: The to of this WebhookNewEmailPayload. # noqa: E501
:rtype: list[str]
"""
return self._to
@to.setter
def to(self, to):
"""Sets the to of this WebhookNewEmailPayload.
List of `To` recipient email addresses that the email was addressed to. See recipients object for names. # noqa: E501
:param to: The to of this WebhookNewEmailPayload. # noqa: E501
:type: list[str]
"""
if self.local_vars_configuration.client_side_validation and to is None: # noqa: E501
raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501
self._to = to
@property
def _from(self):
"""Gets the _from of this WebhookNewEmailPayload. # noqa: E501
Who the email was sent from. An email address - see fromName for the sender name. # noqa: E501
:return: The _from of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self.__from
@_from.setter
def _from(self, _from):
"""Sets the _from of this WebhookNewEmailPayload.
Who the email was sent from. An email address - see fromName for the sender name. # noqa: E501
:param _from: The _from of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and _from is None: # noqa: E501
raise ValueError("Invalid value for `_from`, must not be `None`") # noqa: E501
self.__from = _from
@property
def cc(self):
"""Gets the cc of this WebhookNewEmailPayload. # noqa: E501
List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501
:return: The cc of this WebhookNewEmailPayload. # noqa: E501
:rtype: list[str]
"""
return self._cc
@cc.setter
def cc(self, cc):
"""Sets the cc of this WebhookNewEmailPayload.
List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501
:param cc: The cc of this WebhookNewEmailPayload. # noqa: E501
:type: list[str]
"""
if self.local_vars_configuration.client_side_validation and cc is None: # noqa: E501
raise ValueError("Invalid value for `cc`, must not be `None`") # noqa: E501
self._cc = cc
@property
def bcc(self):
"""Gets the bcc of this WebhookNewEmailPayload. # noqa: E501
List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501
:return: The bcc of this WebhookNewEmailPayload. # noqa: E501
:rtype: list[str]
"""
return self._bcc
@bcc.setter
def bcc(self, bcc):
"""Sets the bcc of this WebhookNewEmailPayload.
List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501
:param bcc: The bcc of this WebhookNewEmailPayload. # noqa: E501
:type: list[str]
"""
if self.local_vars_configuration.client_side_validation and bcc is None: # noqa: E501
raise ValueError("Invalid value for `bcc`, must not be `None`") # noqa: E501
self._bcc = bcc
@property
def subject(self):
"""Gets the subject of this WebhookNewEmailPayload. # noqa: E501
The subject line of the email message as specified by SMTP subject header # noqa: E501
:return: The subject of this WebhookNewEmailPayload. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this WebhookNewEmailPayload.
The subject line of the email message as specified by SMTP subject header # noqa: E501
:param subject: The subject of this WebhookNewEmailPayload. # noqa: E501
:type: str
"""
self._subject = subject
@property
def attachment_meta_datas(self):
"""Gets the attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501
List of attachment meta data objects if attachments present # noqa: E501
:return: The attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501
:rtype: list[AttachmentMetaData]
"""
return self._attachment_meta_datas
@attachment_meta_datas.setter
def attachment_meta_datas(self, attachment_meta_datas):
"""Sets the attachment_meta_datas of this WebhookNewEmailPayload.
List of attachment meta data objects if attachments present # noqa: E501
:param attachment_meta_datas: The attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501
:type: list[AttachmentMetaData]
"""
if self.local_vars_configuration.client_side_validation and attachment_meta_datas is None: # noqa: E501
raise ValueError("Invalid value for `attachment_meta_datas`, must not be `None`") # noqa: E501
self._attachment_meta_datas = attachment_meta_datas
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, WebhookNewEmailPayload):
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, WebhookNewEmailPayload):
return True
return self.to_dict() != other.to_dict()Classes
class WebhookNewEmailPayload (message_id=None, webhook_id=None, event_name=None, webhook_name=None, inbox_id=None, domain_id=None, email_id=None, created_at=None, to=None, cc=None, bcc=None, subject=None, attachment_meta_datas=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.
WebhookNewEmailPayload - a model defined in OpenAPI
Expand source code
class WebhookNewEmailPayload(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 = { 'message_id': 'str', 'webhook_id': 'str', 'event_name': 'str', 'webhook_name': 'str', 'inbox_id': 'str', 'domain_id': 'str', 'email_id': 'str', 'created_at': 'datetime', 'to': 'list[str]', '_from': 'str', 'cc': 'list[str]', 'bcc': 'list[str]', 'subject': 'str', 'attachment_meta_datas': 'list[AttachmentMetaData]' } attribute_map = { 'message_id': 'messageId', 'webhook_id': 'webhookId', 'event_name': 'eventName', 'webhook_name': 'webhookName', 'inbox_id': 'inboxId', 'domain_id': 'domainId', 'email_id': 'emailId', 'created_at': 'createdAt', 'to': 'to', '_from': 'from', 'cc': 'cc', 'bcc': 'bcc', 'subject': 'subject', 'attachment_meta_datas': 'attachmentMetaDatas' } def __init__(self, message_id=None, webhook_id=None, event_name=None, webhook_name=None, inbox_id=None, domain_id=None, email_id=None, created_at=None, to=None, _from=None, cc=None, bcc=None, subject=None, attachment_meta_datas=None, local_vars_configuration=None): # noqa: E501 """WebhookNewEmailPayload - 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._message_id = None self._webhook_id = None self._event_name = None self._webhook_name = None self._inbox_id = None self._domain_id = None self._email_id = None self._created_at = None self._to = None self.__from = None self._cc = None self._bcc = None self._subject = None self._attachment_meta_datas = None self.discriminator = None self.message_id = message_id self.webhook_id = webhook_id self.event_name = event_name self.webhook_name = webhook_name self.inbox_id = inbox_id self.domain_id = domain_id self.email_id = email_id self.created_at = created_at self.to = to self._from = _from self.cc = cc self.bcc = bcc self.subject = subject self.attachment_meta_datas = attachment_meta_datas @property def message_id(self): """Gets the message_id of this WebhookNewEmailPayload. # noqa: E501 Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501 :return: The message_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._message_id @message_id.setter def message_id(self, message_id): """Sets the message_id of this WebhookNewEmailPayload. Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501 :param message_id: The message_id of this WebhookNewEmailPayload. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and message_id is None: # noqa: E501 raise ValueError("Invalid value for `message_id`, must not be `None`") # noqa: E501 self._message_id = message_id @property def webhook_id(self): """Gets the webhook_id of this WebhookNewEmailPayload. # noqa: E501 ID of webhook entity being triggered # noqa: E501 :return: The webhook_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._webhook_id @webhook_id.setter def webhook_id(self, webhook_id): """Sets the webhook_id of this WebhookNewEmailPayload. ID of webhook entity being triggered # noqa: E501 :param webhook_id: The webhook_id of this WebhookNewEmailPayload. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and webhook_id is None: # noqa: E501 raise ValueError("Invalid value for `webhook_id`, must not be `None`") # noqa: E501 self._webhook_id = webhook_id @property def event_name(self): """Gets the event_name of this WebhookNewEmailPayload. # noqa: E501 Name of the event type webhook is being triggered for. # noqa: E501 :return: The event_name of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._event_name @event_name.setter def event_name(self, event_name): """Sets the event_name of this WebhookNewEmailPayload. Name of the event type webhook is being triggered for. # noqa: E501 :param event_name: The event_name of this WebhookNewEmailPayload. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and event_name is None: # noqa: E501 raise ValueError("Invalid value for `event_name`, must not be `None`") # noqa: E501 allowed_values = ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"] # noqa: E501 if self.local_vars_configuration.client_side_validation and event_name not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `event_name` ({0}), must be one of {1}" # noqa: E501 .format(event_name, allowed_values) ) self._event_name = event_name @property def webhook_name(self): """Gets the webhook_name of this WebhookNewEmailPayload. # noqa: E501 Name of the webhook being triggered # noqa: E501 :return: The webhook_name of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._webhook_name @webhook_name.setter def webhook_name(self, webhook_name): """Sets the webhook_name of this WebhookNewEmailPayload. Name of the webhook being triggered # noqa: E501 :param webhook_name: The webhook_name of this WebhookNewEmailPayload. # noqa: E501 :type: str """ self._webhook_name = webhook_name @property def inbox_id(self): """Gets the inbox_id of this WebhookNewEmailPayload. # noqa: E501 Id of the inbox # noqa: E501 :return: The inbox_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._inbox_id @inbox_id.setter def inbox_id(self, inbox_id): """Sets the inbox_id of this WebhookNewEmailPayload. Id of the inbox # noqa: E501 :param inbox_id: The inbox_id of this WebhookNewEmailPayload. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and inbox_id is None: # noqa: E501 raise ValueError("Invalid value for `inbox_id`, must not be `None`") # noqa: E501 self._inbox_id = inbox_id @property def domain_id(self): """Gets the domain_id of this WebhookNewEmailPayload. # noqa: E501 Id of the domain that received an email # noqa: E501 :return: The domain_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._domain_id @domain_id.setter def domain_id(self, domain_id): """Sets the domain_id of this WebhookNewEmailPayload. Id of the domain that received an email # noqa: E501 :param domain_id: The domain_id of this WebhookNewEmailPayload. # noqa: E501 :type: str """ self._domain_id = domain_id @property def email_id(self): """Gets the email_id of this WebhookNewEmailPayload. # noqa: E501 ID of the email that was received. Use this ID for fetching the email with the `EmailController`. # noqa: E501 :return: The email_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._email_id @email_id.setter def email_id(self, email_id): """Sets the email_id of this WebhookNewEmailPayload. ID of the email that was received. Use this ID for fetching the email with the `EmailController`. # noqa: E501 :param email_id: The email_id of this WebhookNewEmailPayload. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and email_id is None: # noqa: E501 raise ValueError("Invalid value for `email_id`, must not be `None`") # noqa: E501 self._email_id = email_id @property def created_at(self): """Gets the created_at of this WebhookNewEmailPayload. # noqa: E501 Date time of event creation # noqa: E501 :return: The created_at of this WebhookNewEmailPayload. # noqa: E501 :rtype: datetime """ return self._created_at @created_at.setter def created_at(self, created_at): """Sets the created_at of this WebhookNewEmailPayload. Date time of event creation # noqa: E501 :param created_at: The created_at of this WebhookNewEmailPayload. # noqa: E501 :type: datetime """ if self.local_vars_configuration.client_side_validation and created_at is None: # noqa: E501 raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501 self._created_at = created_at @property def to(self): """Gets the to of this WebhookNewEmailPayload. # noqa: E501 List of `To` recipient email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :return: The to of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str] """ return self._to @to.setter def to(self, to): """Sets the to of this WebhookNewEmailPayload. List of `To` recipient email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :param to: The to of this WebhookNewEmailPayload. # noqa: E501 :type: list[str] """ if self.local_vars_configuration.client_side_validation and to is None: # noqa: E501 raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501 self._to = to @property def _from(self): """Gets the _from of this WebhookNewEmailPayload. # noqa: E501 Who the email was sent from. An email address - see fromName for the sender name. # noqa: E501 :return: The _from of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self.__from @_from.setter def _from(self, _from): """Sets the _from of this WebhookNewEmailPayload. Who the email was sent from. An email address - see fromName for the sender name. # noqa: E501 :param _from: The _from of this WebhookNewEmailPayload. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and _from is None: # noqa: E501 raise ValueError("Invalid value for `_from`, must not be `None`") # noqa: E501 self.__from = _from @property def cc(self): """Gets the cc of this WebhookNewEmailPayload. # noqa: E501 List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :return: The cc of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str] """ return self._cc @cc.setter def cc(self, cc): """Sets the cc of this WebhookNewEmailPayload. List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :param cc: The cc of this WebhookNewEmailPayload. # noqa: E501 :type: list[str] """ if self.local_vars_configuration.client_side_validation and cc is None: # noqa: E501 raise ValueError("Invalid value for `cc`, must not be `None`") # noqa: E501 self._cc = cc @property def bcc(self): """Gets the bcc of this WebhookNewEmailPayload. # noqa: E501 List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :return: The bcc of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str] """ return self._bcc @bcc.setter def bcc(self, bcc): """Sets the bcc of this WebhookNewEmailPayload. List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :param bcc: The bcc of this WebhookNewEmailPayload. # noqa: E501 :type: list[str] """ if self.local_vars_configuration.client_side_validation and bcc is None: # noqa: E501 raise ValueError("Invalid value for `bcc`, must not be `None`") # noqa: E501 self._bcc = bcc @property def subject(self): """Gets the subject of this WebhookNewEmailPayload. # noqa: E501 The subject line of the email message as specified by SMTP subject header # noqa: E501 :return: The subject of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._subject @subject.setter def subject(self, subject): """Sets the subject of this WebhookNewEmailPayload. The subject line of the email message as specified by SMTP subject header # noqa: E501 :param subject: The subject of this WebhookNewEmailPayload. # noqa: E501 :type: str """ self._subject = subject @property def attachment_meta_datas(self): """Gets the attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501 List of attachment meta data objects if attachments present # noqa: E501 :return: The attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[AttachmentMetaData] """ return self._attachment_meta_datas @attachment_meta_datas.setter def attachment_meta_datas(self, attachment_meta_datas): """Sets the attachment_meta_datas of this WebhookNewEmailPayload. List of attachment meta data objects if attachments present # noqa: E501 :param attachment_meta_datas: The attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501 :type: list[AttachmentMetaData] """ if self.local_vars_configuration.client_side_validation and attachment_meta_datas is None: # noqa: E501 raise ValueError("Invalid value for `attachment_meta_datas`, must not be `None`") # noqa: E501 self._attachment_meta_datas = attachment_meta_datas 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, WebhookNewEmailPayload): 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, WebhookNewEmailPayload): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var attachment_meta_datas-
Gets the attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501
List of attachment meta data objects if attachments present # noqa: E501
:return: The attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[AttachmentMetaData]
Expand source code
@property def attachment_meta_datas(self): """Gets the attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501 List of attachment meta data objects if attachments present # noqa: E501 :return: The attachment_meta_datas of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[AttachmentMetaData] """ return self._attachment_meta_datas var bcc-
Gets the bcc of this WebhookNewEmailPayload. # noqa: E501
List of
BCCrecipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501:return: The bcc of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str]
Expand source code
@property def bcc(self): """Gets the bcc of this WebhookNewEmailPayload. # noqa: E501 List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :return: The bcc of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str] """ return self._bcc var cc-
Gets the cc of this WebhookNewEmailPayload. # noqa: E501
List of
CCrecipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501:return: The cc of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str]
Expand source code
@property def cc(self): """Gets the cc of this WebhookNewEmailPayload. # noqa: E501 List of `CC` recipients email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :return: The cc of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str] """ return self._cc var created_at-
Gets the created_at of this WebhookNewEmailPayload. # noqa: E501
Date time of event creation # noqa: E501
:return: The created_at of this WebhookNewEmailPayload. # noqa: E501 :rtype: datetime
Expand source code
@property def created_at(self): """Gets the created_at of this WebhookNewEmailPayload. # noqa: E501 Date time of event creation # noqa: E501 :return: The created_at of this WebhookNewEmailPayload. # noqa: E501 :rtype: datetime """ return self._created_at var domain_id-
Gets the domain_id of this WebhookNewEmailPayload. # noqa: E501
Id of the domain that received an email # noqa: E501
:return: The domain_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def domain_id(self): """Gets the domain_id of this WebhookNewEmailPayload. # noqa: E501 Id of the domain that received an email # noqa: E501 :return: The domain_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._domain_id var email_id-
Gets the email_id of this WebhookNewEmailPayload. # noqa: E501
ID of the email that was received. Use this ID for fetching the email with the
EmailController. # noqa: E501:return: The email_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def email_id(self): """Gets the email_id of this WebhookNewEmailPayload. # noqa: E501 ID of the email that was received. Use this ID for fetching the email with the `EmailController`. # noqa: E501 :return: The email_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._email_id var event_name-
Gets the event_name of this WebhookNewEmailPayload. # noqa: E501
Name of the event type webhook is being triggered for. # noqa: E501
:return: The event_name of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def event_name(self): """Gets the event_name of this WebhookNewEmailPayload. # noqa: E501 Name of the event type webhook is being triggered for. # noqa: E501 :return: The event_name of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._event_name var inbox_id-
Gets the inbox_id of this WebhookNewEmailPayload. # noqa: E501
Id of the inbox # noqa: E501
:return: The inbox_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def inbox_id(self): """Gets the inbox_id of this WebhookNewEmailPayload. # noqa: E501 Id of the inbox # noqa: E501 :return: The inbox_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._inbox_id var message_id-
Gets the message_id of this WebhookNewEmailPayload. # noqa: E501
Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501
:return: The message_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def message_id(self): """Gets the message_id of this WebhookNewEmailPayload. # noqa: E501 Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501 :return: The message_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._message_id var subject-
Gets the subject of this WebhookNewEmailPayload. # noqa: E501
The subject line of the email message as specified by SMTP subject header # noqa: E501
:return: The subject of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def subject(self): """Gets the subject of this WebhookNewEmailPayload. # noqa: E501 The subject line of the email message as specified by SMTP subject header # noqa: E501 :return: The subject of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._subject var to-
Gets the to of this WebhookNewEmailPayload. # noqa: E501
List of
Torecipient email addresses that the email was addressed to. See recipients object for names. # noqa: E501:return: The to of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str]
Expand source code
@property def to(self): """Gets the to of this WebhookNewEmailPayload. # noqa: E501 List of `To` recipient email addresses that the email was addressed to. See recipients object for names. # noqa: E501 :return: The to of this WebhookNewEmailPayload. # noqa: E501 :rtype: list[str] """ return self._to var webhook_id-
Gets the webhook_id of this WebhookNewEmailPayload. # noqa: E501
ID of webhook entity being triggered # noqa: E501
:return: The webhook_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def webhook_id(self): """Gets the webhook_id of this WebhookNewEmailPayload. # noqa: E501 ID of webhook entity being triggered # noqa: E501 :return: The webhook_id of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._webhook_id var webhook_name-
Gets the webhook_name of this WebhookNewEmailPayload. # noqa: E501
Name of the webhook being triggered # noqa: E501
:return: The webhook_name of this WebhookNewEmailPayload. # noqa: E501 :rtype: str
Expand source code
@property def webhook_name(self): """Gets the webhook_name of this WebhookNewEmailPayload. # noqa: E501 Name of the webhook being triggered # noqa: E501 :return: The webhook_name of this WebhookNewEmailPayload. # noqa: E501 :rtype: str """ return self._webhook_name
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())