Module mailslurp_client.api.email_controller_api
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
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from mailslurp_client.api_client import ApiClient
from mailslurp_client.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
class EmailControllerApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def apply_imap_flag_operation(self, email_id, imap_flag_operation_options, **kwargs): # noqa: E501
"""Set IMAP flags associated with a message. Only supports '\\Seen' flag. # noqa: E501
Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.apply_imap_flag_operation(email_id, imap_flag_operation_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param ImapFlagOperationOptions imap_flag_operation_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailPreview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, **kwargs) # noqa: E501
def apply_imap_flag_operation_with_http_info(self, email_id, imap_flag_operation_options, **kwargs): # noqa: E501
"""Set IMAP flags associated with a message. Only supports '\\Seen' flag. # noqa: E501
Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param ImapFlagOperationOptions imap_flag_operation_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'imap_flag_operation_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method apply_imap_flag_operation" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `apply_imap_flag_operation`") # noqa: E501
# verify the required parameter 'imap_flag_operation_options' is set
if self.api_client.client_side_validation and ('imap_flag_operation_options' not in local_var_params or # noqa: E501
local_var_params['imap_flag_operation_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `imap_flag_operation_options` when calling `apply_imap_flag_operation`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'imap_flag_operation_options' in local_var_params:
body_params = local_var_params['imap_flag_operation_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/imap-flag-operation', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailPreview', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def can_send(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Check if email can be sent and options are valid. # noqa: E501
Can user send email to given recipient or is the recipient blocked # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.can_send(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CanSendEmailResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.can_send_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501
def can_send_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Check if email can be sent and options are valid. # noqa: E501
Can user send email to given recipient or is the recipient blocked # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.can_send_with_http_info(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CanSendEmailResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'send_email_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method can_send" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `can_send`") # noqa: E501
# verify the required parameter 'send_email_options' is set
if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501
local_var_params['send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_email_options` when calling `can_send`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_email_options' in local_var_params:
body_params = local_var_params['send_email_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/can-send', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CanSendEmailResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def check_email_body(self, email_id, **kwargs): # noqa: E501
"""Detect broken links, spelling, and images in email content # noqa: E501
Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CheckEmailBodyResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.check_email_body_with_http_info(email_id, **kwargs) # noqa: E501
def check_email_body_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Detect broken links, spelling, and images in email content # noqa: E501
Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CheckEmailBodyResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method check_email_body" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `check_email_body`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/check-email-body', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CheckEmailBodyResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def check_email_body_feature_support(self, email_id, **kwargs): # noqa: E501
"""Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501
Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body_feature_support(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CheckEmailBodyFeatureSupportResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.check_email_body_feature_support_with_http_info(email_id, **kwargs) # noqa: E501
def check_email_body_feature_support_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501
Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body_feature_support_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CheckEmailBodyFeatureSupportResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method check_email_body_feature_support" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `check_email_body_feature_support`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/check-email-body-feature-support', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CheckEmailBodyFeatureSupportResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def check_email_client_support(self, check_email_client_support_options, **kwargs): # noqa: E501
"""Show which email programs and devices support the features used in an email body. # noqa: E501
Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_client_support(check_email_client_support_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CheckEmailClientSupportOptions check_email_client_support_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CheckEmailClientSupportResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.check_email_client_support_with_http_info(check_email_client_support_options, **kwargs) # noqa: E501
def check_email_client_support_with_http_info(self, check_email_client_support_options, **kwargs): # noqa: E501
"""Show which email programs and devices support the features used in an email body. # noqa: E501
Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_client_support_with_http_info(check_email_client_support_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CheckEmailClientSupportOptions check_email_client_support_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CheckEmailClientSupportResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'check_email_client_support_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method check_email_client_support" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'check_email_client_support_options' is set
if self.api_client.client_side_validation and ('check_email_client_support_options' not in local_var_params or # noqa: E501
local_var_params['check_email_client_support_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `check_email_client_support_options` when calling `check_email_client_support`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'check_email_client_support_options' in local_var_params:
body_params = local_var_params['check_email_client_support_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/check-email-client-support', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CheckEmailClientSupportResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_all_emails(self, **kwargs): # noqa: E501
"""Delete all emails in all inboxes. # noqa: E501
Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_emails(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.delete_all_emails_with_http_info(**kwargs) # noqa: E501
def delete_all_emails_with_http_info(self, **kwargs): # noqa: E501
"""Delete all emails in all inboxes. # noqa: E501
Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_emails_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_all_emails" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_email(self, email_id, **kwargs): # noqa: E501
"""Delete an email # noqa: E501
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to delete (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.delete_email_with_http_info(email_id, **kwargs) # noqa: E501
def delete_email_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Delete an email # noqa: E501
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to delete (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `delete_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def download_attachment(self, email_id, attachment_id, **kwargs): # noqa: E501
"""Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501
Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_attachment(email_id, attachment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param str attachment_id: ID of attachment (required)
:param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.download_attachment_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501
def download_attachment_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501
"""Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501
Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_attachment_with_http_info(email_id, attachment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param str attachment_id: ID of attachment (required)
:param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'attachment_id',
'api_key'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method download_attachment" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `download_attachment`") # noqa: E501
# verify the required parameter 'attachment_id' is set
if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501
local_var_params['attachment_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `attachment_id` when calling `download_attachment`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
if 'attachment_id' in local_var_params:
path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501
query_params = []
if 'api_key' in local_var_params and local_var_params['api_key'] is not None: # noqa: E501
query_params.append(('apiKey', local_var_params['api_key'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/octet-stream']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/attachments/{attachmentId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def download_attachment_base64(self, email_id, attachment_id, **kwargs): # noqa: E501
"""Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. # noqa: E501
Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_attachment_base64(email_id, attachment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param str attachment_id: ID of attachment (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: DownloadAttachmentDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.download_attachment_base64_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501
def download_attachment_base64_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501
"""Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. # noqa: E501
Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_attachment_base64_with_http_info(email_id, attachment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param str attachment_id: ID of attachment (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(DownloadAttachmentDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'attachment_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method download_attachment_base64" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `download_attachment_base64`") # noqa: E501
# verify the required parameter 'attachment_id' is set
if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501
local_var_params['attachment_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `attachment_id` when calling `download_attachment_base64`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
if 'attachment_id' in local_var_params:
path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/attachments/{attachmentId}/base64', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DownloadAttachmentDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def download_body(self, email_id, **kwargs): # noqa: E501
"""Get email body as string. Returned as `plain/text` with content type header. # noqa: E501
Returns the specified email body for a given email as a string # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.download_body_with_http_info(email_id, **kwargs) # noqa: E501
def download_body_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get email body as string. Returned as `plain/text` with content type header. # noqa: E501
Returns the specified email body for a given email as a string # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method download_body" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `download_body`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'text/html']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/body', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def download_body_bytes(self, email_id, **kwargs): # noqa: E501
"""Get email body in bytes. Returned as `octet-stream` with content type header. # noqa: E501
Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body_bytes(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.download_body_bytes_with_http_info(email_id, **kwargs) # noqa: E501
def download_body_bytes_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get email body in bytes. Returned as `octet-stream` with content type header. # noqa: E501
Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body_bytes_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method download_body_bytes" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `download_body_bytes`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/octet-stream']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/body-bytes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def forward_email(self, email_id, forward_email_options, **kwargs): # noqa: E501
"""Forward email to recipients # noqa: E501
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.forward_email(email_id, forward_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param ForwardEmailOptions forward_email_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: SentEmailDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.forward_email_with_http_info(email_id, forward_email_options, **kwargs) # noqa: E501
def forward_email_with_http_info(self, email_id, forward_email_options, **kwargs): # noqa: E501
"""Forward email to recipients # noqa: E501
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.forward_email_with_http_info(email_id, forward_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param ForwardEmailOptions forward_email_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'forward_email_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method forward_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `forward_email`") # noqa: E501
# verify the required parameter 'forward_email_options' is set
if self.api_client.client_side_validation and ('forward_email_options' not in local_var_params or # noqa: E501
local_var_params['forward_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `forward_email_options` when calling `forward_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'forward_email_options' in local_var_params:
body_params = local_var_params['forward_email_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/forward', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentEmailDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_attachment_meta_data(self, email_id, attachment_id, **kwargs): # noqa: E501
"""Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. # noqa: E501
Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_attachment_meta_data(email_id, attachment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param str attachment_id: ID of attachment (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: AttachmentMetaData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_attachment_meta_data_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501
def get_attachment_meta_data_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501
"""Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. # noqa: E501
Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_attachment_meta_data_with_http_info(email_id, attachment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param str attachment_id: ID of attachment (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(AttachmentMetaData, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'attachment_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_attachment_meta_data" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_attachment_meta_data`") # noqa: E501
# verify the required parameter 'attachment_id' is set
if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501
local_var_params['attachment_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `attachment_id` when calling `get_attachment_meta_data`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
if 'attachment_id' in local_var_params:
path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/attachments/{attachmentId}/metadata', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AttachmentMetaData', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email(self, email_id, **kwargs): # noqa: E501
"""Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Email
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Email, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'decode'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501
query_params.append(('decode', local_var_params['decode'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Email', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_attachments(self, email_id, **kwargs): # noqa: E501
"""Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501
Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_attachments(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[AttachmentMetaData]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_attachments_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_attachments_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501
Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_attachments_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[AttachmentMetaData], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_attachments" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_attachments`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/attachments', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[AttachmentMetaData]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_content_match(self, email_id, content_match_options, **kwargs): # noqa: E501
"""Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501
Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_content_match(email_id, content_match_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to match against (required)
:param ContentMatchOptions content_match_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailContentMatchResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_content_match_with_http_info(email_id, content_match_options, **kwargs) # noqa: E501
def get_email_content_match_with_http_info(self, email_id, content_match_options, **kwargs): # noqa: E501
"""Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501
Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_content_match_with_http_info(email_id, content_match_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to match against (required)
:param ContentMatchOptions content_match_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailContentMatchResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'content_match_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_content_match" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_content_match`") # noqa: E501
# verify the required parameter 'content_match_options' is set
if self.api_client.client_side_validation and ('content_match_options' not in local_var_params or # noqa: E501
local_var_params['content_match_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `content_match_options` when calling `get_email_content_match`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'content_match_options' in local_var_params:
body_params = local_var_params['content_match_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/contentMatch', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailContentMatchResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_content_part(self, email_id, content_type, **kwargs): # noqa: E501
"""Get email content part by content type # noqa: E501
Get email body content parts from a multipart email message for a given content type # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_content_part(email_id, content_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to match against (required)
:param str content_type: Content type (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailContentPartResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_content_part_with_http_info(email_id, content_type, **kwargs) # noqa: E501
def get_email_content_part_with_http_info(self, email_id, content_type, **kwargs): # noqa: E501
"""Get email content part by content type # noqa: E501
Get email body content parts from a multipart email message for a given content type # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_content_part_with_http_info(email_id, content_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to match against (required)
:param str content_type: Content type (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailContentPartResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'content_type'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_content_part" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_content_part`") # noqa: E501
# verify the required parameter 'content_type' is set
if self.api_client.client_side_validation and ('content_type' not in local_var_params or # noqa: E501
local_var_params['content_type'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `content_type` when calling `get_email_content_part`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'content_type' in local_var_params and local_var_params['content_type'] is not None: # noqa: E501
query_params.append(('contentType', local_var_params['content_type'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/contentPart', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailContentPartResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_count(self, **kwargs): # noqa: E501
"""Get email count # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_count(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CountDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_count_with_http_info(**kwargs) # noqa: E501
def get_email_count_with_http_info(self, **kwargs): # noqa: E501
"""Get email count # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_count_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_count" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/emails/count', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CountDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_html(self, email_id, **kwargs): # noqa: E501
"""Get email content as HTML. For displaying emails in browser context. # noqa: E501
Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool decode:
:param bool replace_cid_images:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_html_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_html_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get email content as HTML. For displaying emails in browser context. # noqa: E501
Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool decode:
:param bool replace_cid_images:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'decode',
'replace_cid_images'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_html" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501
query_params.append(('decode', local_var_params['decode'])) # noqa: E501
if 'replace_cid_images' in local_var_params and local_var_params['replace_cid_images'] is not None: # noqa: E501
query_params.append(('replaceCidImages', local_var_params['replace_cid_images'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['text/html;charset=utf-8', 'text/html']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/html', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_html_json(self, email_id, **kwargs): # noqa: E501
"""Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501
Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_json(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool decode:
:param bool replace_cid_images:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailHtmlDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_html_json_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_html_json_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501
Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_json_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool decode:
:param bool replace_cid_images:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailHtmlDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'decode',
'replace_cid_images'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_html_json" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html_json`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501
query_params.append(('decode', local_var_params['decode'])) # noqa: E501
if 'replace_cid_images' in local_var_params and local_var_params['replace_cid_images'] is not None: # noqa: E501
query_params.append(('replaceCidImages', local_var_params['replace_cid_images'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/html/json', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailHtmlDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_html_query(self, email_id, html_selector, **kwargs): # noqa: E501
"""Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_query(email_id, html_selector, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to perform HTML query on (required)
:param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailTextLinesResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_html_query_with_http_info(email_id, html_selector, **kwargs) # noqa: E501
def get_email_html_query_with_http_info(self, email_id, html_selector, **kwargs): # noqa: E501
"""Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_query_with_http_info(email_id, html_selector, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to perform HTML query on (required)
:param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'html_selector'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_html_query" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html_query`") # noqa: E501
# verify the required parameter 'html_selector' is set
if self.api_client.client_side_validation and ('html_selector' not in local_var_params or # noqa: E501
local_var_params['html_selector'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `html_selector` when calling `get_email_html_query`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'html_selector' in local_var_params and local_var_params['html_selector'] is not None: # noqa: E501
query_params.append(('htmlSelector', local_var_params['html_selector'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/htmlQuery', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailTextLinesResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_links(self, email_id, **kwargs): # noqa: E501
"""Parse and return list of links found in an email (only works for HTML content) # noqa: E501
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_links(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to fetch text for (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailLinksResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_links_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_links_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Parse and return list of links found in an email (only works for HTML content) # noqa: E501
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_links_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to fetch text for (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailLinksResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_links" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_links`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/links', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailLinksResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_preview_ur_ls(self, email_id, **kwargs): # noqa: E501
"""Get email URLs for viewing in browser or downloading # noqa: E501
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_preview_ur_ls(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailPreviewUrls
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_preview_ur_ls_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_preview_ur_ls_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get email URLs for viewing in browser or downloading # noqa: E501
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_preview_ur_ls_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailPreviewUrls, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_preview_ur_ls" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_preview_ur_ls`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/urls', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailPreviewUrls', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_screenshot_as_base64(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501
"""Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501
Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_base64(email_id, get_email_screenshot_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param GetEmailScreenshotOptions get_email_screenshot_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailScreenshotResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, **kwargs) # noqa: E501
def get_email_screenshot_as_base64_with_http_info(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501
"""Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501
Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param GetEmailScreenshotOptions get_email_screenshot_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailScreenshotResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'get_email_screenshot_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_screenshot_as_base64" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_screenshot_as_base64`") # noqa: E501
# verify the required parameter 'get_email_screenshot_options' is set
if self.api_client.client_side_validation and ('get_email_screenshot_options' not in local_var_params or # noqa: E501
local_var_params['get_email_screenshot_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `get_email_screenshot_options` when calling `get_email_screenshot_as_base64`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'get_email_screenshot_options' in local_var_params:
body_params = local_var_params['get_email_screenshot_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/screenshot/base64', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailScreenshotResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_screenshot_as_binary(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501
"""Take a screenshot of an email in a browser # noqa: E501
Returns binary octet-stream of screenshot of the given email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_binary(email_id, get_email_screenshot_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param GetEmailScreenshotOptions get_email_screenshot_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, **kwargs) # noqa: E501
def get_email_screenshot_as_binary_with_http_info(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501
"""Take a screenshot of an email in a browser # noqa: E501
Returns binary octet-stream of screenshot of the given email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param GetEmailScreenshotOptions get_email_screenshot_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'get_email_screenshot_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_screenshot_as_binary" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_screenshot_as_binary`") # noqa: E501
# verify the required parameter 'get_email_screenshot_options' is set
if self.api_client.client_side_validation and ('get_email_screenshot_options' not in local_var_params or # noqa: E501
local_var_params['get_email_screenshot_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `get_email_screenshot_options` when calling `get_email_screenshot_as_binary`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'get_email_screenshot_options' in local_var_params:
body_params = local_var_params['get_email_screenshot_options']
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/screenshot/binary', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_text_lines(self, email_id, **kwargs): # noqa: E501
"""Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_text_lines(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to fetch text for (required)
:param bool decode_html_entities: Decode HTML entities
:param str line_separator: Line separator character
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailTextLinesResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_email_text_lines_with_http_info(email_id, **kwargs) # noqa: E501
def get_email_text_lines_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_text_lines_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email to fetch text for (required)
:param bool decode_html_entities: Decode HTML entities
:param str line_separator: Line separator character
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'decode_html_entities',
'line_separator'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_text_lines" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_text_lines`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'decode_html_entities' in local_var_params and local_var_params['decode_html_entities'] is not None: # noqa: E501
query_params.append(('decodeHtmlEntities', local_var_params['decode_html_entities'])) # noqa: E501
if 'line_separator' in local_var_params and local_var_params['line_separator'] is not None: # noqa: E501
query_params.append(('lineSeparator', local_var_params['line_separator'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/textLines', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailTextLinesResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_emails_offset_paginated(self, **kwargs): # noqa: E501
"""Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_offset_paginated(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:param int page: Optional page index in email list pagination
:param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:param datetime since: Optional filter emails received after given date time
:param datetime before: Optional filter emails received before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageEmailProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_emails_offset_paginated_with_http_info(**kwargs) # noqa: E501
def get_emails_offset_paginated_with_http_info(self, **kwargs): # noqa: E501
"""Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_offset_paginated_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:param int page: Optional page index in email list pagination
:param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:param datetime since: Optional filter emails received after given date time
:param datetime before: Optional filter emails received before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'unread_only',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_emails_offset_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_emails_offset_paginated`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
collection_formats['inboxId'] = 'multi' # noqa: E501
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501
query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/offset-paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageEmailProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_emails_paginated(self, **kwargs): # noqa: E501
"""Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_paginated(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:param int page: Optional page index in email list pagination
:param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:param datetime before: Optional filter emails received before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageEmailProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_emails_paginated_with_http_info(**kwargs) # noqa: E501
def get_emails_paginated_with_http_info(self, **kwargs): # noqa: E501
"""Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_paginated_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:param int page: Optional page index in email list pagination
:param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:param datetime before: Optional filter emails received before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'unread_only',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_emails_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_emails_paginated`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
collection_formats['inboxId'] = 'multi' # noqa: E501
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501
query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageEmailProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_gravatar_url_for_email_address(self, email_address, **kwargs): # noqa: E501
"""get_gravatar_url_for_email_address # noqa: E501
Get gravatar url for email address # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_gravatar_url_for_email_address(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: (required)
:param str size:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: GravatarUrl
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_gravatar_url_for_email_address_with_http_info(email_address, **kwargs) # noqa: E501
def get_gravatar_url_for_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501
"""get_gravatar_url_for_email_address # noqa: E501
Get gravatar url for email address # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_gravatar_url_for_email_address_with_http_info(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: (required)
:param str size:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(GravatarUrl, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_address',
'size'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_gravatar_url_for_email_address" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_address' is set
if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501
local_var_params['email_address'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_address` when calling `get_gravatar_url_for_email_address`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501
query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/gravatarFor', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GravatarUrl', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_latest_email(self, **kwargs): # noqa: E501
"""Get latest email in all inboxes. Most recently received. # noqa: E501
Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Email
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_latest_email_with_http_info(**kwargs) # noqa: E501
def get_latest_email_with_http_info(self, **kwargs): # noqa: E501
"""Get latest email in all inboxes. Most recently received. # noqa: E501
Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Email, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_ids'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_latest_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_ids' in local_var_params and local_var_params['inbox_ids'] is not None: # noqa: E501
query_params.append(('inboxIds', local_var_params['inbox_ids'])) # noqa: E501
collection_formats['inboxIds'] = 'multi' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/latest', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Email', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_latest_email_in_inbox1(self, inbox_id, **kwargs): # noqa: E501
"""Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501
Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox1(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to get the latest email from (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Email
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_latest_email_in_inbox1_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_latest_email_in_inbox1_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501
Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox1_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to get the latest email from (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Email, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_latest_email_in_inbox1" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_latest_email_in_inbox1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/latestIn', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Email', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_organization_emails_paginated(self, **kwargs): # noqa: E501
"""Get all organization emails. List team or shared test email accounts # noqa: E501
By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_organization_emails_paginated(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:param int page: Optional page index in email list pagination
:param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:param str search_filter: Optional search filter search filter for emails.
:param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:param datetime before: Optional filter emails received before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageEmailProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_organization_emails_paginated_with_http_info(**kwargs) # noqa: E501
def get_organization_emails_paginated_with_http_info(self, **kwargs): # noqa: E501
"""Get all organization emails. List team or shared test email accounts # noqa: E501
By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_organization_emails_paginated_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:param int page: Optional page index in email list pagination
:param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:param str search_filter: Optional search filter search filter for emails.
:param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:param datetime before: Optional filter emails received before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'unread_only',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_organization_emails_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_organization_emails_paginated`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
collection_formats['inboxId'] = 'multi' # noqa: E501
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501
query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/organization', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageEmailProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_raw_email_contents(self, email_id, **kwargs): # noqa: E501
"""Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501
Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_contents(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_raw_email_contents_with_http_info(email_id, **kwargs) # noqa: E501
def get_raw_email_contents_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501
Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_contents_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_raw_email_contents" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_raw_email_contents`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/raw', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_raw_email_json(self, email_id, **kwargs): # noqa: E501
"""Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_json(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: RawEmailJson
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_raw_email_json_with_http_info(email_id, **kwargs) # noqa: E501
def get_raw_email_json_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_json_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(RawEmailJson, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_raw_email_json" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `get_raw_email_json`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/raw/json', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='RawEmailJson', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_unread_email_count(self, **kwargs): # noqa: E501
"""Get unread email count # noqa: E501
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unread_email_count(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Optional inbox ID filter
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: UnreadCount
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_unread_email_count_with_http_info(**kwargs) # noqa: E501
def get_unread_email_count_with_http_info(self, **kwargs): # noqa: E501
"""Get unread email count # noqa: E501
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unread_email_count_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Optional inbox ID filter
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(UnreadCount, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_unread_email_count" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/unreadCount', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UnreadCount', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def mark_all_as_read(self, **kwargs): # noqa: E501
"""Mark all emails as read or unread # noqa: E501
Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_all_as_read(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool read: What value to assign to email read property. Default true.
:param str inbox_id: Optional inbox ID filter
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.mark_all_as_read_with_http_info(**kwargs) # noqa: E501
def mark_all_as_read_with_http_info(self, **kwargs): # noqa: E501
"""Mark all emails as read or unread # noqa: E501
Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_all_as_read_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool read: What value to assign to email read property. Default true.
:param str inbox_id: Optional inbox ID filter
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'read',
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method mark_all_as_read" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'read' in local_var_params and local_var_params['read'] is not None: # noqa: E501
query_params.append(('read', local_var_params['read'])) # noqa: E501
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/read', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def mark_as_read(self, email_id, **kwargs): # noqa: E501
"""Mark an email as read or unread # noqa: E501
Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_as_read(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool read: What value to assign to email read property. Default true.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: EmailPreview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.mark_as_read_with_http_info(email_id, **kwargs) # noqa: E501
def mark_as_read_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Mark an email as read or unread # noqa: E501
Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_as_read_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: (required)
:param bool read: What value to assign to email read property. Default true.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'read'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method mark_as_read" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `mark_as_read`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
if 'read' in local_var_params and local_var_params['read'] is not None: # noqa: E501
query_params.append(('read', local_var_params['read'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/read', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailPreview', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def reply_to_email(self, email_id, reply_to_email_options, **kwargs): # noqa: E501
"""Reply to an email # noqa: E501
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reply_to_email(email_id, reply_to_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of the email that should be replied to (required)
:param ReplyToEmailOptions reply_to_email_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: SentEmailDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.reply_to_email_with_http_info(email_id, reply_to_email_options, **kwargs) # noqa: E501
def reply_to_email_with_http_info(self, email_id, reply_to_email_options, **kwargs): # noqa: E501
"""Reply to an email # noqa: E501
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reply_to_email_with_http_info(email_id, reply_to_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of the email that should be replied to (required)
:param ReplyToEmailOptions reply_to_email_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id',
'reply_to_email_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method reply_to_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `reply_to_email`") # noqa: E501
# verify the required parameter 'reply_to_email_options' is set
if self.api_client.client_side_validation and ('reply_to_email_options' not in local_var_params or # noqa: E501
local_var_params['reply_to_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `reply_to_email_options` when calling `reply_to_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reply_to_email_options' in local_var_params:
body_params = local_var_params['reply_to_email_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentEmailDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def search_emails(self, search_emails_options, **kwargs): # noqa: E501
"""Get all emails by search criteria. Return in paginated form. # noqa: E501
Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_emails(search_emails_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SearchEmailsOptions search_emails_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageEmailProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.search_emails_with_http_info(search_emails_options, **kwargs) # noqa: E501
def search_emails_with_http_info(self, search_emails_options, **kwargs): # noqa: E501
"""Get all emails by search criteria. Return in paginated form. # noqa: E501
Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_emails_with_http_info(search_emails_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SearchEmailsOptions search_emails_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'search_emails_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method search_emails" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'search_emails_options' is set
if self.api_client.client_side_validation and ('search_emails_options' not in local_var_params or # noqa: E501
local_var_params['search_emails_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `search_emails_options` when calling `search_emails`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'search_emails_options' in local_var_params:
body_params = local_var_params['search_emails_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/search', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageEmailProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def send_email_source_optional(self, send_email_options, **kwargs): # noqa: E501
"""Send email # noqa: E501
Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_email_source_optional(send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SendEmailOptions send_email_options: (required)
:param str inbox_id: ID of the inbox you want to send the email from
:param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
:param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_email_source_optional_with_http_info(send_email_options, **kwargs) # noqa: E501
def send_email_source_optional_with_http_info(self, send_email_options, **kwargs): # noqa: E501
"""Send email # noqa: E501
Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_email_source_optional_with_http_info(send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SendEmailOptions send_email_options: (required)
:param str inbox_id: ID of the inbox you want to send the email from
:param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
:param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'send_email_options',
'inbox_id',
'use_domain_pool',
'virtual_send'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method send_email_source_optional" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'send_email_options' is set
if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501
local_var_params['send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_source_optional`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
if 'use_domain_pool' in local_var_params and local_var_params['use_domain_pool'] is not None: # noqa: E501
query_params.append(('useDomainPool', local_var_params['use_domain_pool'])) # noqa: E501
if 'virtual_send' in local_var_params and local_var_params['virtual_send'] is not None: # noqa: E501
query_params.append(('virtualSend', local_var_params['virtual_send'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_email_options' in local_var_params:
body_params = local_var_params['send_email_options']
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def validate_email(self, email_id, **kwargs): # noqa: E501
"""Validate email HTML contents # noqa: E501
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.validate_email(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ValidationDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.validate_email_with_http_info(email_id, **kwargs) # noqa: E501
def validate_email_with_http_info(self, email_id, **kwargs): # noqa: E501
"""Validate email HTML contents # noqa: E501
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.validate_email_with_http_info(email_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_id: ID of email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ValidationDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method validate_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_id' is set
if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501
local_var_params['email_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_id` when calling `validate_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email_id' in local_var_params:
path_params['emailId'] = local_var_params['email_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emails/{emailId}/validate', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ValidationDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)Classes
class EmailControllerApi (api_client=None)-
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Expand source code
class EmailControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def apply_imap_flag_operation(self, email_id, imap_flag_operation_options, **kwargs): # noqa: E501 """Set IMAP flags associated with a message. Only supports '\\Seen' flag. # noqa: E501 Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_imap_flag_operation(email_id, imap_flag_operation_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param ImapFlagOperationOptions imap_flag_operation_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreview If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, **kwargs) # noqa: E501 def apply_imap_flag_operation_with_http_info(self, email_id, imap_flag_operation_options, **kwargs): # noqa: E501 """Set IMAP flags associated with a message. Only supports '\\Seen' flag. # noqa: E501 Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param ImapFlagOperationOptions imap_flag_operation_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'imap_flag_operation_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method apply_imap_flag_operation" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `apply_imap_flag_operation`") # noqa: E501 # verify the required parameter 'imap_flag_operation_options' is set if self.api_client.client_side_validation and ('imap_flag_operation_options' not in local_var_params or # noqa: E501 local_var_params['imap_flag_operation_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `imap_flag_operation_options` when calling `apply_imap_flag_operation`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'imap_flag_operation_options' in local_var_params: body_params = local_var_params['imap_flag_operation_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/imap-flag-operation', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailPreview', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def can_send(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Check if email can be sent and options are valid. # noqa: E501 Can user send email to given recipient or is the recipient blocked # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.can_send(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CanSendEmailResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.can_send_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def can_send_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Check if email can be sent and options are valid. # noqa: E501 Can user send email to given recipient or is the recipient blocked # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.can_send_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CanSendEmailResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method can_send" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `can_send`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `can_send`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/can-send', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CanSendEmailResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_body(self, email_id, **kwargs): # noqa: E501 """Detect broken links, spelling, and images in email content # noqa: E501 Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailBodyResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_body_with_http_info(email_id, **kwargs) # noqa: E501 def check_email_body_with_http_info(self, email_id, **kwargs): # noqa: E501 """Detect broken links, spelling, and images in email content # noqa: E501 Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailBodyResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_body" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `check_email_body`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/check-email-body', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailBodyResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_body_feature_support(self, email_id, **kwargs): # noqa: E501 """Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501 Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body_feature_support(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailBodyFeatureSupportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_body_feature_support_with_http_info(email_id, **kwargs) # noqa: E501 def check_email_body_feature_support_with_http_info(self, email_id, **kwargs): # noqa: E501 """Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501 Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body_feature_support_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailBodyFeatureSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_body_feature_support" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `check_email_body_feature_support`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/check-email-body-feature-support', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailBodyFeatureSupportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_client_support(self, check_email_client_support_options, **kwargs): # noqa: E501 """Show which email programs and devices support the features used in an email body. # noqa: E501 Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_client_support(check_email_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailClientSupportOptions check_email_client_support_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailClientSupportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_client_support_with_http_info(check_email_client_support_options, **kwargs) # noqa: E501 def check_email_client_support_with_http_info(self, check_email_client_support_options, **kwargs): # noqa: E501 """Show which email programs and devices support the features used in an email body. # noqa: E501 Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_client_support_with_http_info(check_email_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailClientSupportOptions check_email_client_support_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailClientSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_client_support_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_client_support" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_client_support_options' is set if self.api_client.client_side_validation and ('check_email_client_support_options' not in local_var_params or # noqa: E501 local_var_params['check_email_client_support_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_client_support_options` when calling `check_email_client_support`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_client_support_options' in local_var_params: body_params = local_var_params['check_email_client_support_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/check-email-client-support', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailClientSupportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_emails(self, **kwargs): # noqa: E501 """Delete all emails in all inboxes. # noqa: E501 Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_emails(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_all_emails_with_http_info(**kwargs) # noqa: E501 def delete_all_emails_with_http_info(self, **kwargs): # noqa: E501 """Delete all emails in all inboxes. # noqa: E501 Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_emails_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_email(self, email_id, **kwargs): # noqa: E501 """Delete an email # noqa: E501 Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to delete (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_email_with_http_info(email_id, **kwargs) # noqa: E501 def delete_email_with_http_info(self, email_id, **kwargs): # noqa: E501 """Delete an email # noqa: E501 Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to delete (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `delete_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_attachment(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501 Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_attachment_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501 def download_attachment_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501 Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'attachment_id', 'api_key' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_attachment" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_attachment`") # noqa: E501 # verify the required parameter 'attachment_id' is set if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501 local_var_params['attachment_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `attachment_id` when calling `download_attachment`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 if 'attachment_id' in local_var_params: path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501 query_params = [] if 'api_key' in local_var_params and local_var_params['api_key'] is not None: # noqa: E501 query_params.append(('apiKey', local_var_params['api_key'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/octet-stream']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments/{attachmentId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_attachment_base64(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. # noqa: E501 Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment_base64(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DownloadAttachmentDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_attachment_base64_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501 def download_attachment_base64_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. # noqa: E501 Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment_base64_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DownloadAttachmentDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'attachment_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_attachment_base64" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_attachment_base64`") # noqa: E501 # verify the required parameter 'attachment_id' is set if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501 local_var_params['attachment_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `attachment_id` when calling `download_attachment_base64`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 if 'attachment_id' in local_var_params: path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments/{attachmentId}/base64', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='DownloadAttachmentDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_body(self, email_id, **kwargs): # noqa: E501 """Get email body as string. Returned as `plain/text` with content type header. # noqa: E501 Returns the specified email body for a given email as a string # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_body_with_http_info(email_id, **kwargs) # noqa: E501 def download_body_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email body as string. Returned as `plain/text` with content type header. # noqa: E501 Returns the specified email body for a given email as a string # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_body" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_body`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['text/plain', 'text/html']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/body', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_body_bytes(self, email_id, **kwargs): # noqa: E501 """Get email body in bytes. Returned as `octet-stream` with content type header. # noqa: E501 Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body_bytes(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_body_bytes_with_http_info(email_id, **kwargs) # noqa: E501 def download_body_bytes_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email body in bytes. Returned as `octet-stream` with content type header. # noqa: E501 Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body_bytes_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_body_bytes" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_body_bytes`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/octet-stream']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/body-bytes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def forward_email(self, email_id, forward_email_options, **kwargs): # noqa: E501 """Forward email to recipients # noqa: E501 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.forward_email(email_id, forward_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param ForwardEmailOptions forward_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.forward_email_with_http_info(email_id, forward_email_options, **kwargs) # noqa: E501 def forward_email_with_http_info(self, email_id, forward_email_options, **kwargs): # noqa: E501 """Forward email to recipients # noqa: E501 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.forward_email_with_http_info(email_id, forward_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param ForwardEmailOptions forward_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'forward_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method forward_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `forward_email`") # noqa: E501 # verify the required parameter 'forward_email_options' is set if self.api_client.client_side_validation and ('forward_email_options' not in local_var_params or # noqa: E501 local_var_params['forward_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `forward_email_options` when calling `forward_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'forward_email_options' in local_var_params: body_params = local_var_params['forward_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/forward', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_attachment_meta_data(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. # noqa: E501 Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_attachment_meta_data(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: AttachmentMetaData If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_attachment_meta_data_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501 def get_attachment_meta_data_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. # noqa: E501 Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_attachment_meta_data_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(AttachmentMetaData, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'attachment_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_attachment_meta_data" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_attachment_meta_data`") # noqa: E501 # verify the required parameter 'attachment_id' is set if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501 local_var_params['attachment_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `attachment_id` when calling `get_attachment_meta_data`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 if 'attachment_id' in local_var_params: path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments/{attachmentId}/metadata', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AttachmentMetaData', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email(self, email_id, **kwargs): # noqa: E501 """Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501 Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501 Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501 query_params.append(('decode', local_var_params['decode'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_attachments(self, email_id, **kwargs): # noqa: E501 """Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501 Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_attachments(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[AttachmentMetaData] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_attachments_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_attachments_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501 Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_attachments_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[AttachmentMetaData], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_attachments" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_attachments`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AttachmentMetaData]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_content_match(self, email_id, content_match_options, **kwargs): # noqa: E501 """Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501 Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_match(email_id, content_match_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param ContentMatchOptions content_match_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailContentMatchResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_content_match_with_http_info(email_id, content_match_options, **kwargs) # noqa: E501 def get_email_content_match_with_http_info(self, email_id, content_match_options, **kwargs): # noqa: E501 """Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501 Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_match_with_http_info(email_id, content_match_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param ContentMatchOptions content_match_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailContentMatchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'content_match_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_content_match" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_content_match`") # noqa: E501 # verify the required parameter 'content_match_options' is set if self.api_client.client_side_validation and ('content_match_options' not in local_var_params or # noqa: E501 local_var_params['content_match_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `content_match_options` when calling `get_email_content_match`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'content_match_options' in local_var_params: body_params = local_var_params['content_match_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/contentMatch', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailContentMatchResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_content_part(self, email_id, content_type, **kwargs): # noqa: E501 """Get email content part by content type # noqa: E501 Get email body content parts from a multipart email message for a given content type # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_part(email_id, content_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param str content_type: Content type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailContentPartResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_content_part_with_http_info(email_id, content_type, **kwargs) # noqa: E501 def get_email_content_part_with_http_info(self, email_id, content_type, **kwargs): # noqa: E501 """Get email content part by content type # noqa: E501 Get email body content parts from a multipart email message for a given content type # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_part_with_http_info(email_id, content_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param str content_type: Content type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailContentPartResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'content_type' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_content_part" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_content_part`") # noqa: E501 # verify the required parameter 'content_type' is set if self.api_client.client_side_validation and ('content_type' not in local_var_params or # noqa: E501 local_var_params['content_type'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `content_type` when calling `get_email_content_part`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'content_type' in local_var_params and local_var_params['content_type'] is not None: # noqa: E501 query_params.append(('contentType', local_var_params['content_type'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/contentPart', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailContentPartResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_count(self, **kwargs): # noqa: E501 """Get email count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_count_with_http_info(**kwargs) # noqa: E501 def get_email_count_with_http_info(self, **kwargs): # noqa: E501 """Get email count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/emails/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_html(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML. For displaying emails in browser context. # noqa: E501 Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_html_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_html_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML. For displaying emails in browser context. # noqa: E501 Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode', 'replace_cid_images' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_html" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501 query_params.append(('decode', local_var_params['decode'])) # noqa: E501 if 'replace_cid_images' in local_var_params and local_var_params['replace_cid_images'] is not None: # noqa: E501 query_params.append(('replaceCidImages', local_var_params['replace_cid_images'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['text/html;charset=utf-8', 'text/html']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/html', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_html_json(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501 Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_json(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailHtmlDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_html_json_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_html_json_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501 Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_json_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailHtmlDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode', 'replace_cid_images' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_html_json" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html_json`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501 query_params.append(('decode', local_var_params['decode'])) # noqa: E501 if 'replace_cid_images' in local_var_params and local_var_params['replace_cid_images'] is not None: # noqa: E501 query_params.append(('replaceCidImages', local_var_params['replace_cid_images'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/html/json', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailHtmlDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_html_query(self, email_id, html_selector, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_query(email_id, html_selector, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to perform HTML query on (required) :param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailTextLinesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_html_query_with_http_info(email_id, html_selector, **kwargs) # noqa: E501 def get_email_html_query_with_http_info(self, email_id, html_selector, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_query_with_http_info(email_id, html_selector, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to perform HTML query on (required) :param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'html_selector' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_html_query" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html_query`") # noqa: E501 # verify the required parameter 'html_selector' is set if self.api_client.client_side_validation and ('html_selector' not in local_var_params or # noqa: E501 local_var_params['html_selector'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `html_selector` when calling `get_email_html_query`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'html_selector' in local_var_params and local_var_params['html_selector'] is not None: # noqa: E501 query_params.append(('htmlSelector', local_var_params['html_selector'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/htmlQuery', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailTextLinesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_links(self, email_id, **kwargs): # noqa: E501 """Parse and return list of links found in an email (only works for HTML content) # noqa: E501 HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_links(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailLinksResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_links_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_links_with_http_info(self, email_id, **kwargs): # noqa: E501 """Parse and return list of links found in an email (only works for HTML content) # noqa: E501 HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_links_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailLinksResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_links" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_links`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/links', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailLinksResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_preview_ur_ls(self, email_id, **kwargs): # noqa: E501 """Get email URLs for viewing in browser or downloading # noqa: E501 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_preview_ur_ls(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreviewUrls If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_preview_ur_ls_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_preview_ur_ls_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email URLs for viewing in browser or downloading # noqa: E501 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_preview_ur_ls_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreviewUrls, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_preview_ur_ls" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_preview_ur_ls`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/urls', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailPreviewUrls', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_screenshot_as_base64(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501 Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_base64(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailScreenshotResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, **kwargs) # noqa: E501 def get_email_screenshot_as_base64_with_http_info(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501 Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailScreenshotResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'get_email_screenshot_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_screenshot_as_base64" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_screenshot_as_base64`") # noqa: E501 # verify the required parameter 'get_email_screenshot_options' is set if self.api_client.client_side_validation and ('get_email_screenshot_options' not in local_var_params or # noqa: E501 local_var_params['get_email_screenshot_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `get_email_screenshot_options` when calling `get_email_screenshot_as_base64`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'get_email_screenshot_options' in local_var_params: body_params = local_var_params['get_email_screenshot_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/screenshot/base64', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailScreenshotResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_screenshot_as_binary(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser # noqa: E501 Returns binary octet-stream of screenshot of the given email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_binary(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, **kwargs) # noqa: E501 def get_email_screenshot_as_binary_with_http_info(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser # noqa: E501 Returns binary octet-stream of screenshot of the given email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'get_email_screenshot_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_screenshot_as_binary" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_screenshot_as_binary`") # noqa: E501 # verify the required parameter 'get_email_screenshot_options' is set if self.api_client.client_side_validation and ('get_email_screenshot_options' not in local_var_params or # noqa: E501 local_var_params['get_email_screenshot_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `get_email_screenshot_options` when calling `get_email_screenshot_as_binary`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'get_email_screenshot_options' in local_var_params: body_params = local_var_params['get_email_screenshot_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/screenshot/binary', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_text_lines(self, email_id, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_text_lines(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param bool decode_html_entities: Decode HTML entities :param str line_separator: Line separator character :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailTextLinesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_text_lines_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_text_lines_with_http_info(self, email_id, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_text_lines_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param bool decode_html_entities: Decode HTML entities :param str line_separator: Line separator character :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode_html_entities', 'line_separator' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_text_lines" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_text_lines`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode_html_entities' in local_var_params and local_var_params['decode_html_entities'] is not None: # noqa: E501 query_params.append(('decodeHtmlEntities', local_var_params['decode_html_entities'])) # noqa: E501 if 'line_separator' in local_var_params and local_var_params['line_separator'] is not None: # noqa: E501 query_params.append(('lineSeparator', local_var_params['line_separator'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/textLines', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailTextLinesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_emails_offset_paginated(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_offset_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_emails_offset_paginated_with_http_info(**kwargs) # noqa: E501 def get_emails_offset_paginated_with_http_info(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_offset_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'unread_only', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_emails_offset_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_emails_offset_paginated`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 collection_formats['inboxId'] = 'multi' # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/offset-paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_emails_paginated(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_emails_paginated_with_http_info(**kwargs) # noqa: E501 def get_emails_paginated_with_http_info(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'unread_only', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_emails_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_emails_paginated`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 collection_formats['inboxId'] = 'multi' # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_gravatar_url_for_email_address(self, email_address, **kwargs): # noqa: E501 """get_gravatar_url_for_email_address # noqa: E501 Get gravatar url for email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_gravatar_url_for_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param str size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: GravatarUrl If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_gravatar_url_for_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_gravatar_url_for_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """get_gravatar_url_for_email_address # noqa: E501 Get gravatar url for email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_gravatar_url_for_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param str size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(GravatarUrl, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address', 'size' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_gravatar_url_for_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `get_gravatar_url_for_email_address`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/gravatarFor', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GravatarUrl', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_latest_email(self, **kwargs): # noqa: E501 """Get latest email in all inboxes. Most recently received. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_latest_email_with_http_info(**kwargs) # noqa: E501 def get_latest_email_with_http_info(self, **kwargs): # noqa: E501 """Get latest email in all inboxes. Most recently received. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_ids' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_latest_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_ids' in local_var_params and local_var_params['inbox_ids'] is not None: # noqa: E501 query_params.append(('inboxIds', local_var_params['inbox_ids'])) # noqa: E501 collection_formats['inboxIds'] = 'multi' # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/latest', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_latest_email_in_inbox1(self, inbox_id, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox1(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_latest_email_in_inbox1_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_latest_email_in_inbox1_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox1_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_latest_email_in_inbox1" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_latest_email_in_inbox1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/latestIn', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_organization_emails_paginated(self, **kwargs): # noqa: E501 """Get all organization emails. List team or shared test email accounts # noqa: E501 By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_emails_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter search filter for emails. :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_organization_emails_paginated_with_http_info(**kwargs) # noqa: E501 def get_organization_emails_paginated_with_http_info(self, **kwargs): # noqa: E501 """Get all organization emails. List team or shared test email accounts # noqa: E501 By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_emails_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter search filter for emails. :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'unread_only', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_organization_emails_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_organization_emails_paginated`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 collection_formats['inboxId'] = 'multi' # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/organization', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_raw_email_contents(self, email_id, **kwargs): # noqa: E501 """Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501 Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_contents(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_raw_email_contents_with_http_info(email_id, **kwargs) # noqa: E501 def get_raw_email_contents_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501 Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_contents_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_raw_email_contents" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_raw_email_contents`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/raw', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_raw_email_json(self, email_id, **kwargs): # noqa: E501 """Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501 Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_json(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: RawEmailJson If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_raw_email_json_with_http_info(email_id, **kwargs) # noqa: E501 def get_raw_email_json_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501 Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_json_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(RawEmailJson, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_raw_email_json" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_raw_email_json`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/raw/json', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='RawEmailJson', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_unread_email_count(self, **kwargs): # noqa: E501 """Get unread email count # noqa: E501 Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_unread_email_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: UnreadCount If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_unread_email_count_with_http_info(**kwargs) # noqa: E501 def get_unread_email_count_with_http_info(self, **kwargs): # noqa: E501 """Get unread email count # noqa: E501 Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_unread_email_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(UnreadCount, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_unread_email_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/unreadCount', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='UnreadCount', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def mark_all_as_read(self, **kwargs): # noqa: E501 """Mark all emails as read or unread # noqa: E501 Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_all_as_read(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool read: What value to assign to email read property. Default true. :param str inbox_id: Optional inbox ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.mark_all_as_read_with_http_info(**kwargs) # noqa: E501 def mark_all_as_read_with_http_info(self, **kwargs): # noqa: E501 """Mark all emails as read or unread # noqa: E501 Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_all_as_read_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool read: What value to assign to email read property. Default true. :param str inbox_id: Optional inbox ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'read', 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method mark_all_as_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'read' in local_var_params and local_var_params['read'] is not None: # noqa: E501 query_params.append(('read', local_var_params['read'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/read', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def mark_as_read(self, email_id, **kwargs): # noqa: E501 """Mark an email as read or unread # noqa: E501 Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_as_read(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool read: What value to assign to email read property. Default true. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreview If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.mark_as_read_with_http_info(email_id, **kwargs) # noqa: E501 def mark_as_read_with_http_info(self, email_id, **kwargs): # noqa: E501 """Mark an email as read or unread # noqa: E501 Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_as_read_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool read: What value to assign to email read property. Default true. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'read' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method mark_as_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `mark_as_read`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'read' in local_var_params and local_var_params['read'] is not None: # noqa: E501 query_params.append(('read', local_var_params['read'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/read', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailPreview', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def reply_to_email(self, email_id, reply_to_email_options, **kwargs): # noqa: E501 """Reply to an email # noqa: E501 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reply_to_email(email_id, reply_to_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of the email that should be replied to (required) :param ReplyToEmailOptions reply_to_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.reply_to_email_with_http_info(email_id, reply_to_email_options, **kwargs) # noqa: E501 def reply_to_email_with_http_info(self, email_id, reply_to_email_options, **kwargs): # noqa: E501 """Reply to an email # noqa: E501 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reply_to_email_with_http_info(email_id, reply_to_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of the email that should be replied to (required) :param ReplyToEmailOptions reply_to_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'reply_to_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method reply_to_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `reply_to_email`") # noqa: E501 # verify the required parameter 'reply_to_email_options' is set if self.api_client.client_side_validation and ('reply_to_email_options' not in local_var_params or # noqa: E501 local_var_params['reply_to_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `reply_to_email_options` when calling `reply_to_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'reply_to_email_options' in local_var_params: body_params = local_var_params['reply_to_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def search_emails(self, search_emails_options, **kwargs): # noqa: E501 """Get all emails by search criteria. Return in paginated form. # noqa: E501 Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_emails(search_emails_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchEmailsOptions search_emails_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.search_emails_with_http_info(search_emails_options, **kwargs) # noqa: E501 def search_emails_with_http_info(self, search_emails_options, **kwargs): # noqa: E501 """Get all emails by search criteria. Return in paginated form. # noqa: E501 Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_emails_with_http_info(search_emails_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchEmailsOptions search_emails_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'search_emails_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method search_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'search_emails_options' is set if self.api_client.client_side_validation and ('search_emails_options' not in local_var_params or # noqa: E501 local_var_params['search_emails_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `search_emails_options` when calling `search_emails`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'search_emails_options' in local_var_params: body_params = local_var_params['search_emails_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/search', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_email_source_optional(self, send_email_options, **kwargs): # noqa: E501 """Send email # noqa: E501 Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_source_optional(send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SendEmailOptions send_email_options: (required) :param str inbox_id: ID of the inbox you want to send the email from :param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. :param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_source_optional_with_http_info(send_email_options, **kwargs) # noqa: E501 def send_email_source_optional_with_http_info(self, send_email_options, **kwargs): # noqa: E501 """Send email # noqa: E501 Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_source_optional_with_http_info(send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SendEmailOptions send_email_options: (required) :param str inbox_id: ID of the inbox you want to send the email from :param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. :param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'send_email_options', 'inbox_id', 'use_domain_pool', 'virtual_send' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email_source_optional" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_source_optional`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'use_domain_pool' in local_var_params and local_var_params['use_domain_pool'] is not None: # noqa: E501 query_params.append(('useDomainPool', local_var_params['use_domain_pool'])) # noqa: E501 if 'virtual_send' in local_var_params and local_var_params['virtual_send'] is not None: # noqa: E501 query_params.append(('virtualSend', local_var_params['virtual_send'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def validate_email(self, email_id, **kwargs): # noqa: E501 """Validate email HTML contents # noqa: E501 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.validate_email(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ValidationDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.validate_email_with_http_info(email_id, **kwargs) # noqa: E501 def validate_email_with_http_info(self, email_id, **kwargs): # noqa: E501 """Validate email HTML contents # noqa: E501 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.validate_email_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ValidationDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method validate_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `validate_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/validate', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ValidationDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)Methods
def apply_imap_flag_operation(self, email_id, imap_flag_operation_options, **kwargs)-
Set IMAP flags associated with a message. Only supports '\Seen' flag. # noqa: E501
Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.apply_imap_flag_operation(email_id, imap_flag_operation_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param ImapFlagOperationOptions imap_flag_operation_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreview If the method is called asynchronously, returns the request thread.
Expand source code
def apply_imap_flag_operation(self, email_id, imap_flag_operation_options, **kwargs): # noqa: E501 """Set IMAP flags associated with a message. Only supports '\\Seen' flag. # noqa: E501 Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_imap_flag_operation(email_id, imap_flag_operation_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param ImapFlagOperationOptions imap_flag_operation_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreview If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, **kwargs) # noqa: E501 def apply_imap_flag_operation_with_http_info(self, email_id, imap_flag_operation_options, **kwargs)-
Set IMAP flags associated with a message. Only supports '\Seen' flag. # noqa: E501
Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param ImapFlagOperationOptions imap_flag_operation_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def apply_imap_flag_operation_with_http_info(self, email_id, imap_flag_operation_options, **kwargs): # noqa: E501 """Set IMAP flags associated with a message. Only supports '\\Seen' flag. # noqa: E501 Apply RFC3501 section-2.3.2 IMAP flag operations on an email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param ImapFlagOperationOptions imap_flag_operation_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'imap_flag_operation_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method apply_imap_flag_operation" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `apply_imap_flag_operation`") # noqa: E501 # verify the required parameter 'imap_flag_operation_options' is set if self.api_client.client_side_validation and ('imap_flag_operation_options' not in local_var_params or # noqa: E501 local_var_params['imap_flag_operation_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `imap_flag_operation_options` when calling `apply_imap_flag_operation`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'imap_flag_operation_options' in local_var_params: body_params = local_var_params['imap_flag_operation_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/imap-flag-operation', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailPreview', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def can_send(self, inbox_id, send_email_options, **kwargs)-
Check if email can be sent and options are valid. # noqa: E501
Can user send email to given recipient or is the recipient blocked # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.can_send(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CanSendEmailResults If the method is called asynchronously, returns the request thread.
Expand source code
def can_send(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Check if email can be sent and options are valid. # noqa: E501 Can user send email to given recipient or is the recipient blocked # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.can_send(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CanSendEmailResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.can_send_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def can_send_with_http_info(self, inbox_id, send_email_options, **kwargs)-
Check if email can be sent and options are valid. # noqa: E501
Can user send email to given recipient or is the recipient blocked # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.can_send_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CanSendEmailResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def can_send_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Check if email can be sent and options are valid. # noqa: E501 Can user send email to given recipient or is the recipient blocked # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.can_send_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CanSendEmailResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method can_send" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `can_send`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `can_send`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/can-send', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CanSendEmailResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_body(self, email_id, **kwargs)-
Detect broken links, spelling, and images in email content # noqa: E501
Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailBodyResults If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_body(self, email_id, **kwargs): # noqa: E501 """Detect broken links, spelling, and images in email content # noqa: E501 Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailBodyResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_body_with_http_info(email_id, **kwargs) # noqa: E501 def check_email_body_feature_support(self, email_id, **kwargs)-
Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501
Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body_feature_support(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailBodyFeatureSupportResults If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_body_feature_support(self, email_id, **kwargs): # noqa: E501 """Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501 Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body_feature_support(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailBodyFeatureSupportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_body_feature_support_with_http_info(email_id, **kwargs) # noqa: E501 def check_email_body_feature_support_with_http_info(self, email_id, **kwargs)-
Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501
Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body_feature_support_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailBodyFeatureSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_body_feature_support_with_http_info(self, email_id, **kwargs): # noqa: E501 """Show which mail clients support the HTML and CSS features used in an email body. # noqa: E501 Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body_feature_support_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailBodyFeatureSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_body_feature_support" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `check_email_body_feature_support`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/check-email-body-feature-support', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailBodyFeatureSupportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_body_with_http_info(self, email_id, **kwargs)-
Detect broken links, spelling, and images in email content # noqa: E501
Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_body_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailBodyResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_body_with_http_info(self, email_id, **kwargs): # noqa: E501 """Detect broken links, spelling, and images in email content # noqa: E501 Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_body_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailBodyResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_body" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `check_email_body`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/check-email-body', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailBodyResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_client_support(self, check_email_client_support_options, **kwargs)-
Show which email programs and devices support the features used in an email body. # noqa: E501
Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_client_support(check_email_client_support_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailClientSupportOptions check_email_client_support_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailClientSupportResults If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_client_support(self, check_email_client_support_options, **kwargs): # noqa: E501 """Show which email programs and devices support the features used in an email body. # noqa: E501 Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_client_support(check_email_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailClientSupportOptions check_email_client_support_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailClientSupportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_client_support_with_http_info(check_email_client_support_options, **kwargs) # noqa: E501 def check_email_client_support_with_http_info(self, check_email_client_support_options, **kwargs)-
Show which email programs and devices support the features used in an email body. # noqa: E501
Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_client_support_with_http_info(check_email_client_support_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailClientSupportOptions check_email_client_support_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailClientSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_client_support_with_http_info(self, check_email_client_support_options, **kwargs): # noqa: E501 """Show which email programs and devices support the features used in an email body. # noqa: E501 Evaluate the features used in an email body and return a report of email client support across different platforms and versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_client_support_with_http_info(check_email_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailClientSupportOptions check_email_client_support_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailClientSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_client_support_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_client_support" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_client_support_options' is set if self.api_client.client_side_validation and ('check_email_client_support_options' not in local_var_params or # noqa: E501 local_var_params['check_email_client_support_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_client_support_options` when calling `check_email_client_support`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_client_support_options' in local_var_params: body_params = local_var_params['check_email_client_support_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/check-email-client-support', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailClientSupportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_emails(self, **kwargs)-
Delete all emails in all inboxes. # noqa: E501
Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_emails(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_all_emails(self, **kwargs): # noqa: E501 """Delete all emails in all inboxes. # noqa: E501 Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_emails(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_all_emails_with_http_info(**kwargs) # noqa: E501 def delete_all_emails_with_http_info(self, **kwargs)-
Delete all emails in all inboxes. # noqa: E501
Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_emails_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_all_emails_with_http_info(self, **kwargs): # noqa: E501 """Delete all emails in all inboxes. # noqa: E501 Deletes all emails in your account. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_emails_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_email(self, email_id, **kwargs)-
Delete an email # noqa: E501
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to delete (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_email(self, email_id, **kwargs): # noqa: E501 """Delete an email # noqa: E501 Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to delete (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_email_with_http_info(email_id, **kwargs) # noqa: E501 def delete_email_with_http_info(self, email_id, **kwargs)-
Delete an email # noqa: E501
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to delete (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_email_with_http_info(self, email_id, **kwargs): # noqa: E501 """Delete an email # noqa: E501 Deletes an email and removes it from the inbox. Deleted emails cannot be recovered. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to delete (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `delete_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_attachment(self, email_id, attachment_id, **kwargs)-
Get email attachment bytes. Returned as
octet-streamwith content type header. If you have trouble with byte responses try thedownloadAttachmentBase64response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_attachment(email_id, attachment_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code
def download_attachment(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501 Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_attachment_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501 def download_attachment_base64(self, email_id, attachment_id, **kwargs)-
Get email attachment as base64 encoded string as an alternative to binary responses. Decode the
base64FileContentsas autf-8encoded string or array of bytes depending on thecontentType. # noqa: E501Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the
downloadAttachmentmethod but allows some clients to get around issues with binary responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.download_attachment_base64(email_id, attachment_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DownloadAttachmentDto If the method is called asynchronously, returns the request thread.
Expand source code
def download_attachment_base64(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. # noqa: E501 Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment_base64(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DownloadAttachmentDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_attachment_base64_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501 def download_attachment_base64_with_http_info(self, email_id, attachment_id, **kwargs)-
Get email attachment as base64 encoded string as an alternative to binary responses. Decode the
base64FileContentsas autf-8encoded string or array of bytes depending on thecontentType. # noqa: E501Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the
downloadAttachmentmethod but allows some clients to get around issues with binary responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.download_attachment_base64_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DownloadAttachmentDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def download_attachment_base64_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. # noqa: E501 Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment_base64_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DownloadAttachmentDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'attachment_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_attachment_base64" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_attachment_base64`") # noqa: E501 # verify the required parameter 'attachment_id' is set if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501 local_var_params['attachment_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `attachment_id` when calling `download_attachment_base64`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 if 'attachment_id' in local_var_params: path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments/{attachmentId}/base64', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='DownloadAttachmentDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_attachment_with_http_info(self, email_id, attachment_id, **kwargs)-
Get email attachment bytes. Returned as
octet-streamwith content type header. If you have trouble with byte responses try thedownloadAttachmentBase64response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_attachment_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def download_attachment_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. # noqa: E501 Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_attachment_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param str api_key: Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'attachment_id', 'api_key' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_attachment" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_attachment`") # noqa: E501 # verify the required parameter 'attachment_id' is set if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501 local_var_params['attachment_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `attachment_id` when calling `download_attachment`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 if 'attachment_id' in local_var_params: path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501 query_params = [] if 'api_key' in local_var_params and local_var_params['api_key'] is not None: # noqa: E501 query_params.append(('apiKey', local_var_params['api_key'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/octet-stream']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments/{attachmentId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_body(self, email_id, **kwargs)-
Get email body as string. Returned as
plain/textwith content type header. # noqa: E501Returns the specified email body for a given email as a string # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code
def download_body(self, email_id, **kwargs): # noqa: E501 """Get email body as string. Returned as `plain/text` with content type header. # noqa: E501 Returns the specified email body for a given email as a string # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_body_with_http_info(email_id, **kwargs) # noqa: E501 def download_body_bytes(self, email_id, **kwargs)-
Get email body in bytes. Returned as
octet-streamwith content type header. # noqa: E501Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body_bytes(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code
def download_body_bytes(self, email_id, **kwargs): # noqa: E501 """Get email body in bytes. Returned as `octet-stream` with content type header. # noqa: E501 Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body_bytes(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.download_body_bytes_with_http_info(email_id, **kwargs) # noqa: E501 def download_body_bytes_with_http_info(self, email_id, **kwargs)-
Get email body in bytes. Returned as
octet-streamwith content type header. # noqa: E501Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body_bytes_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def download_body_bytes_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email body in bytes. Returned as `octet-stream` with content type header. # noqa: E501 Returns the specified email body for a given email as a stream / array of bytes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body_bytes_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_body_bytes" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_body_bytes`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/octet-stream']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/body-bytes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def download_body_with_http_info(self, email_id, **kwargs)-
Get email body as string. Returned as
plain/textwith content type header. # noqa: E501Returns the specified email body for a given email as a string # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_body_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def download_body_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email body as string. Returned as `plain/text` with content type header. # noqa: E501 Returns the specified email body for a given email as a string # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.download_body_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method download_body" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `download_body`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['text/plain', 'text/html']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/body', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def forward_email(self, email_id, forward_email_options, **kwargs)-
Forward email to recipients # noqa: E501
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the
fromoption. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.forward_email(email_id, forward_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param ForwardEmailOptions forward_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread.
Expand source code
def forward_email(self, email_id, forward_email_options, **kwargs): # noqa: E501 """Forward email to recipients # noqa: E501 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.forward_email(email_id, forward_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param ForwardEmailOptions forward_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.forward_email_with_http_info(email_id, forward_email_options, **kwargs) # noqa: E501 def forward_email_with_http_info(self, email_id, forward_email_options, **kwargs)-
Forward email to recipients # noqa: E501
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the
fromoption. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.forward_email_with_http_info(email_id, forward_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param ForwardEmailOptions forward_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def forward_email_with_http_info(self, email_id, forward_email_options, **kwargs): # noqa: E501 """Forward email to recipients # noqa: E501 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.forward_email_with_http_info(email_id, forward_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param ForwardEmailOptions forward_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'forward_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method forward_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `forward_email`") # noqa: E501 # verify the required parameter 'forward_email_options' is set if self.api_client.client_side_validation and ('forward_email_options' not in local_var_params or # noqa: E501 local_var_params['forward_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `forward_email_options` when calling `forward_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'forward_email_options' in local_var_params: body_params = local_var_params['forward_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/forward', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_attachment_meta_data(self, email_id, attachment_id, **kwargs)-
Get email attachment metadata. This is the
contentTypeandcontentLengthof an attachment. To get the individual attachments use thedownloadAttachmentmethods. # noqa: E501Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_attachment_meta_data(email_id, attachment_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: AttachmentMetaData If the method is called asynchronously, returns the request thread.
Expand source code
def get_attachment_meta_data(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. # noqa: E501 Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_attachment_meta_data(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: AttachmentMetaData If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_attachment_meta_data_with_http_info(email_id, attachment_id, **kwargs) # noqa: E501 def get_attachment_meta_data_with_http_info(self, email_id, attachment_id, **kwargs)-
Get email attachment metadata. This is the
contentTypeandcontentLengthof an attachment. To get the individual attachments use thedownloadAttachmentmethods. # noqa: E501Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_attachment_meta_data_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(AttachmentMetaData, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_attachment_meta_data_with_http_info(self, email_id, attachment_id, **kwargs): # noqa: E501 """Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. # noqa: E501 Returns the metadata such as name and content-type for a given attachment and email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_attachment_meta_data_with_http_info(email_id, attachment_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param str attachment_id: ID of attachment (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(AttachmentMetaData, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'attachment_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_attachment_meta_data" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_attachment_meta_data`") # noqa: E501 # verify the required parameter 'attachment_id' is set if self.api_client.client_side_validation and ('attachment_id' not in local_var_params or # noqa: E501 local_var_params['attachment_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `attachment_id` when calling `get_attachment_meta_data`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 if 'attachment_id' in local_var_params: path_params['attachmentId'] = local_var_params['attachment_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments/{attachmentId}/metadata', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AttachmentMetaData', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email(self, email_id, **kwargs)-
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance
=D7). This can be a pain for testing :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread.Expand source code
def get_email(self, email_id, **kwargs): # noqa: E501 """Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501 Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_attachments(self, email_id, **kwargs)-
Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501
Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_attachments(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[AttachmentMetaData] If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_attachments(self, email_id, **kwargs): # noqa: E501 """Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501 Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_attachments(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[AttachmentMetaData] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_attachments_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_attachments_with_http_info(self, email_id, **kwargs)-
Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501
Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_attachments_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[AttachmentMetaData], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_attachments_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get all email attachment metadata. Metadata includes name and size of attachments. # noqa: E501 Returns an array of attachment metadata such as name and content-type for a given email if present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_attachments_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[AttachmentMetaData], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_attachments" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_attachments`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/attachments', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AttachmentMetaData]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_content_match(self, email_id, content_match_options, **kwargs)-
Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501
Return the matches for a given Java style regex pattern. Do not include the typical
/at start or end of regex in some languages. Given an exampleyour code is: 12345the pattern to extract match looks likecode is: (\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups:['code is: 123456', '123456']See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_email_content_match(email_id, content_match_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param ContentMatchOptions content_match_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailContentMatchResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_content_match(self, email_id, content_match_options, **kwargs): # noqa: E501 """Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501 Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_match(email_id, content_match_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param ContentMatchOptions content_match_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailContentMatchResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_content_match_with_http_info(email_id, content_match_options, **kwargs) # noqa: E501 def get_email_content_match_with_http_info(self, email_id, content_match_options, **kwargs)-
Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501
Return the matches for a given Java style regex pattern. Do not include the typical
/at start or end of regex in some languages. Given an exampleyour code is: 12345the pattern to extract match looks likecode is: (\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups:['code is: 123456', '123456']See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_email_content_match_with_http_info(email_id, content_match_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param ContentMatchOptions content_match_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailContentMatchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_content_match_with_http_info(self, email_id, content_match_options, **kwargs): # noqa: E501 """Get email content regex pattern match results. Runs regex against email body and returns match groups. # noqa: E501 Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_match_with_http_info(email_id, content_match_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param ContentMatchOptions content_match_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailContentMatchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'content_match_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_content_match" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_content_match`") # noqa: E501 # verify the required parameter 'content_match_options' is set if self.api_client.client_side_validation and ('content_match_options' not in local_var_params or # noqa: E501 local_var_params['content_match_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `content_match_options` when calling `get_email_content_match`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'content_match_options' in local_var_params: body_params = local_var_params['content_match_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/contentMatch', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailContentMatchResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_content_part(self, email_id, content_type, **kwargs)-
Get email content part by content type # noqa: E501
Get email body content parts from a multipart email message for a given content type # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_content_part(email_id, content_type, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param str content_type: Content type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailContentPartResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_content_part(self, email_id, content_type, **kwargs): # noqa: E501 """Get email content part by content type # noqa: E501 Get email body content parts from a multipart email message for a given content type # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_part(email_id, content_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param str content_type: Content type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailContentPartResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_content_part_with_http_info(email_id, content_type, **kwargs) # noqa: E501 def get_email_content_part_with_http_info(self, email_id, content_type, **kwargs)-
Get email content part by content type # noqa: E501
Get email body content parts from a multipart email message for a given content type # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_content_part_with_http_info(email_id, content_type, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param str content_type: Content type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailContentPartResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_content_part_with_http_info(self, email_id, content_type, **kwargs): # noqa: E501 """Get email content part by content type # noqa: E501 Get email body content parts from a multipart email message for a given content type # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_content_part_with_http_info(email_id, content_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to match against (required) :param str content_type: Content type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailContentPartResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'content_type' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_content_part" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_content_part`") # noqa: E501 # verify the required parameter 'content_type' is set if self.api_client.client_side_validation and ('content_type' not in local_var_params or # noqa: E501 local_var_params['content_type'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `content_type` when calling `get_email_content_part`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'content_type' in local_var_params and local_var_params['content_type'] is not None: # noqa: E501 query_params.append(('contentType', local_var_params['content_type'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/contentPart', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailContentPartResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_count(self, **kwargs)-
Get email count # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_count(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CountDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_count(self, **kwargs): # noqa: E501 """Get email count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_count_with_http_info(**kwargs) # noqa: E501 def get_email_count_with_http_info(self, **kwargs)-
Get email count # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_count_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_count_with_http_info(self, **kwargs): # noqa: E501 """Get email count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/emails/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_html(self, email_id, **kwargs)-
Get email content as HTML. For displaying emails in browser context. # noqa: E501
Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser:
?apiKey=xxx. Returns content-typetext/html;charset=utf-8so you must call expecting that content response not JSON. For JSON response see thegetEmailHTMLJsonmethod. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_email_html(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_html(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML. For displaying emails in browser context. # noqa: E501 Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_html_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_html_json(self, email_id, **kwargs)-
Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501
Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type
application/json;charset=utf-8so you must call expecting that content response not JSON. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_email_html_json(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailHtmlDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_html_json(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501 Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_json(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailHtmlDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_html_json_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_html_json_with_http_info(self, email_id, **kwargs)-
Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501
Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type
application/json;charset=utf-8so you must call expecting that content response not JSON. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_email_html_json_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailHtmlDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_html_json_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content # noqa: E501 Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_json_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailHtmlDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode', 'replace_cid_images' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_html_json" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html_json`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501 query_params.append(('decode', local_var_params['decode'])) # noqa: E501 if 'replace_cid_images' in local_var_params and local_var_params['replace_cid_images'] is not None: # noqa: E501 query_params.append(('replaceCidImages', local_var_params['replace_cid_images'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/html/json', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailHtmlDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_html_query(self, email_id, html_selector, **kwargs)-
Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_query(email_id, html_selector, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to perform HTML query on (required) :param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailTextLinesResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_html_query(self, email_id, html_selector, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_query(email_id, html_selector, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to perform HTML query on (required) :param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailTextLinesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_html_query_with_http_info(email_id, html_selector, **kwargs) # noqa: E501 def get_email_html_query_with_http_info(self, email_id, html_selector, **kwargs)-
Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_html_query_with_http_info(email_id, html_selector, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to perform HTML query on (required) :param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_html_query_with_http_info(self, email_id, html_selector, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_query_with_http_info(email_id, html_selector, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to perform HTML query on (required) :param str html_selector: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'html_selector' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_html_query" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html_query`") # noqa: E501 # verify the required parameter 'html_selector' is set if self.api_client.client_side_validation and ('html_selector' not in local_var_params or # noqa: E501 local_var_params['html_selector'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `html_selector` when calling `get_email_html_query`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'html_selector' in local_var_params and local_var_params['html_selector'] is not None: # noqa: E501 query_params.append(('htmlSelector', local_var_params['html_selector'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/htmlQuery', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailTextLinesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_html_with_http_info(self, email_id, **kwargs)-
Get email content as HTML. For displaying emails in browser context. # noqa: E501
Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser:
?apiKey=xxx. Returns content-typetext/html;charset=utf-8so you must call expecting that content response not JSON. For JSON response see thegetEmailHTMLJsonmethod. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_email_html_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_html_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email content as HTML. For displaying emails in browser context. # noqa: E501 Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_html_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: :param bool replace_cid_images: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode', 'replace_cid_images' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_html" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_html`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501 query_params.append(('decode', local_var_params['decode'])) # noqa: E501 if 'replace_cid_images' in local_var_params and local_var_params['replace_cid_images'] is not None: # noqa: E501 query_params.append(('replaceCidImages', local_var_params['replace_cid_images'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['text/html;charset=utf-8', 'text/html']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/html', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_links(self, email_id, **kwargs)-
Parse and return list of links found in an email (only works for HTML content) # noqa: E501
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_links(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailLinksResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_links(self, email_id, **kwargs): # noqa: E501 """Parse and return list of links found in an email (only works for HTML content) # noqa: E501 HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_links(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailLinksResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_links_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_links_with_http_info(self, email_id, **kwargs)-
Parse and return list of links found in an email (only works for HTML content) # noqa: E501
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_links_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailLinksResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_links_with_http_info(self, email_id, **kwargs): # noqa: E501 """Parse and return list of links found in an email (only works for HTML content) # noqa: E501 HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_links_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailLinksResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_links" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_links`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/links', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailLinksResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_preview_ur_ls(self, email_id, **kwargs)-
Get email URLs for viewing in browser or downloading # noqa: E501
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_preview_ur_ls(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreviewUrls If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_preview_ur_ls(self, email_id, **kwargs): # noqa: E501 """Get email URLs for viewing in browser or downloading # noqa: E501 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_preview_ur_ls(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreviewUrls If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_preview_ur_ls_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_preview_ur_ls_with_http_info(self, email_id, **kwargs)-
Get email URLs for viewing in browser or downloading # noqa: E501
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_preview_ur_ls_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreviewUrls, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_preview_ur_ls_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email URLs for viewing in browser or downloading # noqa: E501 Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_preview_ur_ls_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreviewUrls, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_preview_ur_ls" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_preview_ur_ls`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/urls', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailPreviewUrls', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_screenshot_as_base64(self, email_id, get_email_screenshot_options, **kwargs)-
Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501
Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_base64(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailScreenshotResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_screenshot_as_base64(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501 Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_base64(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailScreenshotResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, **kwargs) # noqa: E501 def get_email_screenshot_as_base64_with_http_info(self, email_id, get_email_screenshot_options, **kwargs)-
Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501
Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailScreenshotResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_screenshot_as_base64_with_http_info(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser and return base64 encoded string # noqa: E501 Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailScreenshotResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'get_email_screenshot_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_screenshot_as_base64" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_screenshot_as_base64`") # noqa: E501 # verify the required parameter 'get_email_screenshot_options' is set if self.api_client.client_side_validation and ('get_email_screenshot_options' not in local_var_params or # noqa: E501 local_var_params['get_email_screenshot_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `get_email_screenshot_options` when calling `get_email_screenshot_as_base64`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'get_email_screenshot_options' in local_var_params: body_params = local_var_params['get_email_screenshot_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/screenshot/base64', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailScreenshotResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_screenshot_as_binary(self, email_id, get_email_screenshot_options, **kwargs)-
Take a screenshot of an email in a browser # noqa: E501
Returns binary octet-stream of screenshot of the given email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_binary(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_screenshot_as_binary(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser # noqa: E501 Returns binary octet-stream of screenshot of the given email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_binary(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, **kwargs) # noqa: E501 def get_email_screenshot_as_binary_with_http_info(self, email_id, get_email_screenshot_options, **kwargs)-
Take a screenshot of an email in a browser # noqa: E501
Returns binary octet-stream of screenshot of the given email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_screenshot_as_binary_with_http_info(self, email_id, get_email_screenshot_options, **kwargs): # noqa: E501 """Take a screenshot of an email in a browser # noqa: E501 Returns binary octet-stream of screenshot of the given email # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param GetEmailScreenshotOptions get_email_screenshot_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'get_email_screenshot_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_screenshot_as_binary" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_screenshot_as_binary`") # noqa: E501 # verify the required parameter 'get_email_screenshot_options' is set if self.api_client.client_side_validation and ('get_email_screenshot_options' not in local_var_params or # noqa: E501 local_var_params['get_email_screenshot_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `get_email_screenshot_options` when calling `get_email_screenshot_as_binary`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'get_email_screenshot_options' in local_var_params: body_params = local_var_params['get_email_screenshot_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/screenshot/binary', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_text_lines(self, email_id, **kwargs)-
Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_text_lines(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param bool decode_html_entities: Decode HTML entities :param str line_separator: Line separator character :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailTextLinesResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_text_lines(self, email_id, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_text_lines(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param bool decode_html_entities: Decode HTML entities :param str line_separator: Line separator character :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailTextLinesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_text_lines_with_http_info(email_id, **kwargs) # noqa: E501 def get_email_text_lines_with_http_info(self, email_id, **kwargs)-
Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_text_lines_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param bool decode_html_entities: Decode HTML entities :param str line_separator: Line separator character :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_email_text_lines_with_http_info(self, email_id, **kwargs): # noqa: E501 """Parse and return text from an email, stripping HTML and decoding encoded characters # noqa: E501 Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_text_lines_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email to fetch text for (required) :param bool decode_html_entities: Decode HTML entities :param str line_separator: Line separator character :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailTextLinesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode_html_entities', 'line_separator' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_text_lines" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email_text_lines`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode_html_entities' in local_var_params and local_var_params['decode_html_entities'] is not None: # noqa: E501 query_params.append(('decodeHtmlEntities', local_var_params['decode_html_entities'])) # noqa: E501 if 'line_separator' in local_var_params and local_var_params['line_separator'] is not None: # noqa: E501 query_params.append(('lineSeparator', local_var_params['line_separator'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/textLines', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailTextLinesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_with_http_info(self, email_id, **kwargs)-
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance
=D7). This can be a pain for testing :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.Expand source code
def get_email_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. # noqa: E501 Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool decode: Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'decode' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'decode' in local_var_params and local_var_params['decode'] is not None: # noqa: E501 query_params.append(('decode', local_var_params['decode'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_emails_offset_paginated(self, **kwargs)-
Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_offset_paginated(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_emails_offset_paginated(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_offset_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_emails_offset_paginated_with_http_info(**kwargs) # noqa: E501 def get_emails_offset_paginated_with_http_info(self, **kwargs)-
Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_offset_paginated_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_emails_offset_paginated_with_http_info(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_offset_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'unread_only', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_emails_offset_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_emails_offset_paginated`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 collection_formats['inboxId'] = 'multi' # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/offset-paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_emails_paginated(self, **kwargs)-
Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_paginated(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_emails_paginated(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_emails_paginated_with_http_info(**kwargs) # noqa: E501 def get_emails_paginated_with_http_info(self, **kwargs)-
Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_paginated_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_emails_paginated_with_http_info(self, **kwargs): # noqa: E501 """Get all emails in all inboxes in paginated form. Email API list all. # noqa: E501 By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'unread_only', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_emails_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_emails_paginated`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 collection_formats['inboxId'] = 'multi' # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_gravatar_url_for_email_address(self, email_address, **kwargs)-
get_gravatar_url_for_email_address # noqa: E501
Get gravatar url for email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_gravatar_url_for_email_address(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param str size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: GravatarUrl If the method is called asynchronously, returns the request thread.
Expand source code
def get_gravatar_url_for_email_address(self, email_address, **kwargs): # noqa: E501 """get_gravatar_url_for_email_address # noqa: E501 Get gravatar url for email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_gravatar_url_for_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param str size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: GravatarUrl If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_gravatar_url_for_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_gravatar_url_for_email_address_with_http_info(self, email_address, **kwargs)-
get_gravatar_url_for_email_address # noqa: E501
Get gravatar url for email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_gravatar_url_for_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param str size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(GravatarUrl, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_gravatar_url_for_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """get_gravatar_url_for_email_address # noqa: E501 Get gravatar url for email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_gravatar_url_for_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param str size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(GravatarUrl, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address', 'size' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_gravatar_url_for_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `get_gravatar_url_for_email_address`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/gravatarFor', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GravatarUrl', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_latest_email(self, **kwargs)-
Get latest email in all inboxes. Most recently received. # noqa: E501
Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread.
Expand source code
def get_latest_email(self, **kwargs): # noqa: E501 """Get latest email in all inboxes. Most recently received. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_latest_email_with_http_info(**kwargs) # noqa: E501 def get_latest_email_in_inbox1(self, inbox_id, **kwargs)-
Get latest email in an inbox. Use
WaitForControllerto get emails that may not have arrived yet. # noqa: E501Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox1(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread.
Expand source code
def get_latest_email_in_inbox1(self, inbox_id, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox1(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_latest_email_in_inbox1_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_latest_email_in_inbox1_with_http_info(self, inbox_id, **kwargs)-
Get latest email in an inbox. Use
WaitForControllerto get emails that may not have arrived yet. # noqa: E501Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox1_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_latest_email_in_inbox1_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox1_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_latest_email_in_inbox1" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_latest_email_in_inbox1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/latestIn', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_latest_email_with_http_info(self, **kwargs)-
Get latest email in all inboxes. Most recently received. # noqa: E501
Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_latest_email_with_http_info(self, **kwargs): # noqa: E501 """Get latest email in all inboxes. Most recently received. # noqa: E501 Get the newest email in all inboxes or in a passed set of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_ids: Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_ids' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_latest_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_ids' in local_var_params and local_var_params['inbox_ids'] is not None: # noqa: E501 query_params.append(('inboxIds', local_var_params['inbox_ids'])) # noqa: E501 collection_formats['inboxIds'] = 'multi' # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/latest', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_organization_emails_paginated(self, **kwargs)-
Get all organization emails. List team or shared test email accounts # noqa: E501
By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_organization_emails_paginated(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter search filter for emails. :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_organization_emails_paginated(self, **kwargs): # noqa: E501 """Get all organization emails. List team or shared test email accounts # noqa: E501 By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_emails_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter search filter for emails. :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_organization_emails_paginated_with_http_info(**kwargs) # noqa: E501 def get_organization_emails_paginated_with_http_info(self, **kwargs)-
Get all organization emails. List team or shared test email accounts # noqa: E501
By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_organization_emails_paginated_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter search filter for emails. :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_organization_emails_paginated_with_http_info(self, **kwargs): # noqa: E501 """Get all organization emails. List team or shared test email accounts # noqa: E501 By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_emails_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param list[str] inbox_id: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. :param int page: Optional page index in email list pagination :param int size: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param bool unread_only: Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly :param str search_filter: Optional search filter search filter for emails. :param datetime since: Optional filter emails received after given date time. If unset will use time 24hours prior to now. :param datetime before: Optional filter emails received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'unread_only', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_organization_emails_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_organization_emails_paginated`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 collection_formats['inboxId'] = 'multi' # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/organization', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_raw_email_contents(self, email_id, **kwargs)-
Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501
Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_contents(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def get_raw_email_contents(self, email_id, **kwargs): # noqa: E501 """Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501 Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_contents(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_raw_email_contents_with_http_info(email_id, **kwargs) # noqa: E501 def get_raw_email_contents_with_http_info(self, email_id, **kwargs)-
Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501
Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_contents_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def get_raw_email_contents_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get raw email string. Returns unparsed raw SMTP message with headers and body. # noqa: E501 Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_contents_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_raw_email_contents" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_raw_email_contents`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/raw', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_raw_email_json(self, email_id, **kwargs)-
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_json(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: RawEmailJson If the method is called asynchronously, returns the request thread.
Expand source code
def get_raw_email_json(self, email_id, **kwargs): # noqa: E501 """Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501 Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_json(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: RawEmailJson If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_raw_email_json_with_http_info(email_id, **kwargs) # noqa: E501 def get_raw_email_json_with_http_info(self, email_id, **kwargs)-
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_raw_email_json_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(RawEmailJson, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_raw_email_json_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. # noqa: E501 Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_email_json_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(RawEmailJson, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_raw_email_json" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `get_raw_email_json`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/raw/json', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='RawEmailJson', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_unread_email_count(self, **kwargs)-
Get unread email count # noqa: E501
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unread_email_count(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: UnreadCount If the method is called asynchronously, returns the request thread.
Expand source code
def get_unread_email_count(self, **kwargs): # noqa: E501 """Get unread email count # noqa: E501 Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_unread_email_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: UnreadCount If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_unread_email_count_with_http_info(**kwargs) # noqa: E501 def get_unread_email_count_with_http_info(self, **kwargs)-
Get unread email count # noqa: E501
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unread_email_count_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(UnreadCount, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_unread_email_count_with_http_info(self, **kwargs): # noqa: E501 """Get unread email count # noqa: E501 Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_unread_email_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(UnreadCount, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_unread_email_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/unreadCount', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='UnreadCount', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def mark_all_as_read(self, **kwargs)-
Mark all emails as read or unread # noqa: E501
Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_all_as_read(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool read: What value to assign to email read property. Default true. :param str inbox_id: Optional inbox ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def mark_all_as_read(self, **kwargs): # noqa: E501 """Mark all emails as read or unread # noqa: E501 Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_all_as_read(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool read: What value to assign to email read property. Default true. :param str inbox_id: Optional inbox ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.mark_all_as_read_with_http_info(**kwargs) # noqa: E501 def mark_all_as_read_with_http_info(self, **kwargs)-
Mark all emails as read or unread # noqa: E501
Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_all_as_read_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool read: What value to assign to email read property. Default true. :param str inbox_id: Optional inbox ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def mark_all_as_read_with_http_info(self, **kwargs): # noqa: E501 """Mark all emails as read or unread # noqa: E501 Marks all emails as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_all_as_read_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool read: What value to assign to email read property. Default true. :param str inbox_id: Optional inbox ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'read', 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method mark_all_as_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'read' in local_var_params and local_var_params['read'] is not None: # noqa: E501 query_params.append(('read', local_var_params['read'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/read', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def mark_as_read(self, email_id, **kwargs)-
Mark an email as read or unread # noqa: E501
Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_as_read(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool read: What value to assign to email read property. Default true. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreview If the method is called asynchronously, returns the request thread.
Expand source code
def mark_as_read(self, email_id, **kwargs): # noqa: E501 """Mark an email as read or unread # noqa: E501 Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_as_read(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool read: What value to assign to email read property. Default true. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailPreview If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.mark_as_read_with_http_info(email_id, **kwargs) # noqa: E501 def mark_as_read_with_http_info(self, email_id, **kwargs)-
Mark an email as read or unread # noqa: E501
Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.mark_as_read_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: (required) :param bool read: What value to assign to email read property. Default true. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def mark_as_read_with_http_info(self, email_id, **kwargs): # noqa: E501 """Mark an email as read or unread # noqa: E501 Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.mark_as_read_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: (required) :param bool read: What value to assign to email read property. Default true. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'read' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method mark_as_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `mark_as_read`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] if 'read' in local_var_params and local_var_params['read'] is not None: # noqa: E501 query_params.append(('read', local_var_params['read'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/read', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailPreview', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def reply_to_email(self, email_id, reply_to_email_options, **kwargs)-
Reply to an email # noqa: E501
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails
to,cc, andbcc. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.reply_to_email(email_id, reply_to_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of the email that should be replied to (required) :param ReplyToEmailOptions reply_to_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread.
Expand source code
def reply_to_email(self, email_id, reply_to_email_options, **kwargs): # noqa: E501 """Reply to an email # noqa: E501 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reply_to_email(email_id, reply_to_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of the email that should be replied to (required) :param ReplyToEmailOptions reply_to_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.reply_to_email_with_http_info(email_id, reply_to_email_options, **kwargs) # noqa: E501 def reply_to_email_with_http_info(self, email_id, reply_to_email_options, **kwargs)-
Reply to an email # noqa: E501
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails
to,cc, andbcc. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.reply_to_email_with_http_info(email_id, reply_to_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of the email that should be replied to (required) :param ReplyToEmailOptions reply_to_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def reply_to_email_with_http_info(self, email_id, reply_to_email_options, **kwargs): # noqa: E501 """Reply to an email # noqa: E501 Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reply_to_email_with_http_info(email_id, reply_to_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of the email that should be replied to (required) :param ReplyToEmailOptions reply_to_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'reply_to_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method reply_to_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `reply_to_email`") # noqa: E501 # verify the required parameter 'reply_to_email_options' is set if self.api_client.client_side_validation and ('reply_to_email_options' not in local_var_params or # noqa: E501 local_var_params['reply_to_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `reply_to_email_options` when calling `reply_to_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'reply_to_email_options' in local_var_params: body_params = local_var_params['reply_to_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def search_emails(self, search_emails_options, **kwargs)-
Get all emails by search criteria. Return in paginated form. # noqa: E501
Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_emails(search_emails_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SearchEmailsOptions search_emails_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread.
Expand source code
def search_emails(self, search_emails_options, **kwargs): # noqa: E501 """Get all emails by search criteria. Return in paginated form. # noqa: E501 Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_emails(search_emails_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchEmailsOptions search_emails_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.search_emails_with_http_info(search_emails_options, **kwargs) # noqa: E501 def search_emails_with_http_info(self, search_emails_options, **kwargs)-
Get all emails by search criteria. Return in paginated form. # noqa: E501
Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_emails_with_http_info(search_emails_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SearchEmailsOptions search_emails_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def search_emails_with_http_info(self, search_emails_options, **kwargs): # noqa: E501 """Get all emails by search criteria. Return in paginated form. # noqa: E501 Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_emails_with_http_info(search_emails_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchEmailsOptions search_emails_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'search_emails_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method search_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'search_emails_options' is set if self.api_client.client_side_validation and ('search_emails_options' not in local_var_params or # noqa: E501 local_var_params['search_emails_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `search_emails_options` when calling `search_emails`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'search_emails_options' in local_var_params: body_params = local_var_params['search_emails_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/search', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_email_source_optional(self, send_email_options, **kwargs)-
Send email # noqa: E501
Alias for
InboxController.sendEmailmethod - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.send_email_source_optional(send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SendEmailOptions send_email_options: (required) :param str inbox_id: ID of the inbox you want to send the email from :param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. :param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_source_optional(self, send_email_options, **kwargs): # noqa: E501 """Send email # noqa: E501 Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_source_optional(send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SendEmailOptions send_email_options: (required) :param str inbox_id: ID of the inbox you want to send the email from :param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. :param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_source_optional_with_http_info(send_email_options, **kwargs) # noqa: E501 def send_email_source_optional_with_http_info(self, send_email_options, **kwargs)-
Send email # noqa: E501
Alias for
InboxController.sendEmailmethod - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.send_email_source_optional_with_http_info(send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SendEmailOptions send_email_options: (required) :param str inbox_id: ID of the inbox you want to send the email from :param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. :param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_source_optional_with_http_info(self, send_email_options, **kwargs): # noqa: E501 """Send email # noqa: E501 Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_source_optional_with_http_info(send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SendEmailOptions send_email_options: (required) :param str inbox_id: ID of the inbox you want to send the email from :param bool use_domain_pool: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. :param bool virtual_send: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'send_email_options', 'inbox_id', 'use_domain_pool', 'virtual_send' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email_source_optional" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_source_optional`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'use_domain_pool' in local_var_params and local_var_params['use_domain_pool'] is not None: # noqa: E501 query_params.append(('useDomainPool', local_var_params['use_domain_pool'])) # noqa: E501 if 'virtual_send' in local_var_params and local_var_params['virtual_send'] is not None: # noqa: E501 query_params.append(('virtualSend', local_var_params['virtual_send'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def validate_email(self, email_id, **kwargs)-
Validate email HTML contents # noqa: E501
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.validate_email(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ValidationDto If the method is called asynchronously, returns the request thread.
Expand source code
def validate_email(self, email_id, **kwargs): # noqa: E501 """Validate email HTML contents # noqa: E501 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.validate_email(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ValidationDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.validate_email_with_http_info(email_id, **kwargs) # noqa: E501 def validate_email_with_http_info(self, email_id, **kwargs)-
Validate email HTML contents # noqa: E501
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.validate_email_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ValidationDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def validate_email_with_http_info(self, email_id, **kwargs): # noqa: E501 """Validate email HTML contents # noqa: E501 Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.validate_email_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: ID of email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ValidationDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method validate_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `validate_email`") # noqa: E501 collection_formats = {} path_params = {} if 'email_id' in local_var_params: path_params['emailId'] = local_var_params['email_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emails/{emailId}/validate', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ValidationDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)