Module mailslurp_client.api.common_actions_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 CommonActionsControllerApi(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 create_new_email_address(self, **kwargs): # noqa: E501
"""Create new random inbox # noqa: E501
Returns an Inbox with an `id` and an `emailAddress` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_new_email_address(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool allow_team_access:
:param bool use_domain_pool:
:param datetime expires_at:
:param int expires_in:
:param str email_address:
:param str inbox_type:
:param str description:
:param str name:
:param list[str] tags:
:param bool favourite:
:param bool virtual_inbox:
:param bool use_short_address:
:param str domain_name:
:param str domain_id:
:param str prefix:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_new_email_address_with_http_info(**kwargs) # noqa: E501
def create_new_email_address_with_http_info(self, **kwargs): # noqa: E501
"""Create new random inbox # noqa: E501
Returns an Inbox with an `id` and an `emailAddress` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_new_email_address_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool allow_team_access:
:param bool use_domain_pool:
:param datetime expires_at:
:param int expires_in:
:param str email_address:
:param str inbox_type:
:param str description:
:param str name:
:param list[str] tags:
:param bool favourite:
:param bool virtual_inbox:
:param bool use_short_address:
:param str domain_name:
:param str domain_id:
:param str prefix:
: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(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'allow_team_access',
'use_domain_pool',
'expires_at',
'expires_in',
'email_address',
'inbox_type',
'description',
'name',
'tags',
'favourite',
'virtual_inbox',
'use_short_address',
'domain_name',
'domain_id',
'prefix'
]
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 create_new_email_address" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'allow_team_access' in local_var_params and local_var_params['allow_team_access'] is not None: # noqa: E501
query_params.append(('allowTeamAccess', local_var_params['allow_team_access'])) # 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 'expires_at' in local_var_params and local_var_params['expires_at'] is not None: # noqa: E501
query_params.append(('expiresAt', local_var_params['expires_at'])) # noqa: E501
if 'expires_in' in local_var_params and local_var_params['expires_in'] is not None: # noqa: E501
query_params.append(('expiresIn', local_var_params['expires_in'])) # noqa: E501
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 'inbox_type' in local_var_params and local_var_params['inbox_type'] is not None: # noqa: E501
query_params.append(('inboxType', local_var_params['inbox_type'])) # noqa: E501
if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501
query_params.append(('description', local_var_params['description'])) # noqa: E501
if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501
query_params.append(('name', local_var_params['name'])) # noqa: E501
if 'tags' in local_var_params and local_var_params['tags'] is not None: # noqa: E501
query_params.append(('tags', local_var_params['tags'])) # noqa: E501
collection_formats['tags'] = 'multi' # noqa: E501
if 'favourite' in local_var_params and local_var_params['favourite'] is not None: # noqa: E501
query_params.append(('favourite', local_var_params['favourite'])) # noqa: E501
if 'virtual_inbox' in local_var_params and local_var_params['virtual_inbox'] is not None: # noqa: E501
query_params.append(('virtualInbox', local_var_params['virtual_inbox'])) # noqa: E501
if 'use_short_address' in local_var_params and local_var_params['use_short_address'] is not None: # noqa: E501
query_params.append(('useShortAddress', local_var_params['use_short_address'])) # noqa: E501
if 'domain_name' in local_var_params and local_var_params['domain_name'] is not None: # noqa: E501
query_params.append(('domainName', local_var_params['domain_name'])) # noqa: E501
if 'domain_id' in local_var_params and local_var_params['domain_id'] is not None: # noqa: E501
query_params.append(('domainId', local_var_params['domain_id'])) # noqa: E501
if 'prefix' in local_var_params and local_var_params['prefix'] is not None: # noqa: E501
query_params.append(('prefix', local_var_params['prefix'])) # 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(
'/newEmailAddress', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxDto', # 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 create_random_inbox(self, **kwargs): # noqa: E501
"""Create new random inbox # noqa: E501
Returns an Inbox with an `id` and an `emailAddress` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_random_inbox(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool allow_team_access:
:param bool use_domain_pool:
:param datetime expires_at:
:param int expires_in:
:param str email_address:
:param str inbox_type:
:param str description:
:param str name:
:param list[str] tags:
:param bool favourite:
:param bool virtual_inbox:
:param bool use_short_address:
:param str domain_name:
:param str domain_id:
:param str prefix:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_random_inbox_with_http_info(**kwargs) # noqa: E501
def create_random_inbox_with_http_info(self, **kwargs): # noqa: E501
"""Create new random inbox # noqa: E501
Returns an Inbox with an `id` and an `emailAddress` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_random_inbox_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool allow_team_access:
:param bool use_domain_pool:
:param datetime expires_at:
:param int expires_in:
:param str email_address:
:param str inbox_type:
:param str description:
:param str name:
:param list[str] tags:
:param bool favourite:
:param bool virtual_inbox:
:param bool use_short_address:
:param str domain_name:
:param str domain_id:
:param str prefix:
: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(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'allow_team_access',
'use_domain_pool',
'expires_at',
'expires_in',
'email_address',
'inbox_type',
'description',
'name',
'tags',
'favourite',
'virtual_inbox',
'use_short_address',
'domain_name',
'domain_id',
'prefix'
]
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 create_random_inbox" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'allow_team_access' in local_var_params and local_var_params['allow_team_access'] is not None: # noqa: E501
query_params.append(('allowTeamAccess', local_var_params['allow_team_access'])) # 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 'expires_at' in local_var_params and local_var_params['expires_at'] is not None: # noqa: E501
query_params.append(('expiresAt', local_var_params['expires_at'])) # noqa: E501
if 'expires_in' in local_var_params and local_var_params['expires_in'] is not None: # noqa: E501
query_params.append(('expiresIn', local_var_params['expires_in'])) # noqa: E501
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 'inbox_type' in local_var_params and local_var_params['inbox_type'] is not None: # noqa: E501
query_params.append(('inboxType', local_var_params['inbox_type'])) # noqa: E501
if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501
query_params.append(('description', local_var_params['description'])) # noqa: E501
if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501
query_params.append(('name', local_var_params['name'])) # noqa: E501
if 'tags' in local_var_params and local_var_params['tags'] is not None: # noqa: E501
query_params.append(('tags', local_var_params['tags'])) # noqa: E501
collection_formats['tags'] = 'multi' # noqa: E501
if 'favourite' in local_var_params and local_var_params['favourite'] is not None: # noqa: E501
query_params.append(('favourite', local_var_params['favourite'])) # noqa: E501
if 'virtual_inbox' in local_var_params and local_var_params['virtual_inbox'] is not None: # noqa: E501
query_params.append(('virtualInbox', local_var_params['virtual_inbox'])) # noqa: E501
if 'use_short_address' in local_var_params and local_var_params['use_short_address'] is not None: # noqa: E501
query_params.append(('useShortAddress', local_var_params['use_short_address'])) # noqa: E501
if 'domain_name' in local_var_params and local_var_params['domain_name'] is not None: # noqa: E501
query_params.append(('domainName', local_var_params['domain_name'])) # noqa: E501
if 'domain_id' in local_var_params and local_var_params['domain_id'] is not None: # noqa: E501
query_params.append(('domainId', local_var_params['domain_id'])) # noqa: E501
if 'prefix' in local_var_params and local_var_params['prefix'] is not None: # noqa: E501
query_params.append(('prefix', local_var_params['prefix'])) # 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(
'/createInbox', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxDto', # 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_address(self, inbox_id, **kwargs): # noqa: E501
"""Delete inbox email address by inbox id # noqa: E501
Deletes inbox 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.delete_email_address(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_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: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.delete_email_address_with_http_info(inbox_id, **kwargs) # noqa: E501
def delete_email_address_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Delete inbox email address by inbox id # noqa: E501
Deletes inbox 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.delete_email_address_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_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: None
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 delete_email_address" % 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 `delete_email_address`") # 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
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/deleteEmailAddress', '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 empty_inbox(self, inbox_id, **kwargs): # noqa: E501
"""Delete all emails in an inbox # noqa: E501
Deletes all emails # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.empty_inbox(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_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: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.empty_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501
def empty_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Delete all emails in an inbox # noqa: E501
Deletes all emails # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.empty_inbox_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_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: None
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 empty_inbox" % 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 `empty_inbox`") # 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
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/emptyInbox', '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 send_email_query(self, to, **kwargs): # noqa: E501
"""Send an email using query parameters # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query(to, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str to: Email address to send to (required)
:param str sender_id: ID of inbox to send from. If null an inbox will be created for sending
:param str body: Body of the email message. Supports HTML
:param str subject: Subject line of the email
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for 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_query_with_http_info(to, **kwargs) # noqa: E501
def send_email_query_with_http_info(self, to, **kwargs): # noqa: E501
"""Send an email using query parameters # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query_with_http_info(to, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str to: Email address to send to (required)
:param str sender_id: ID of inbox to send from. If null an inbox will be created for sending
:param str body: Body of the email message. Supports HTML
:param str subject: Subject line of the email
: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 = [
'to',
'sender_id',
'body',
'subject'
]
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_query" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'to' is set
if self.api_client.client_side_validation and ('to' not in local_var_params or # noqa: E501
local_var_params['to'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `to` when calling `send_email_query`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'sender_id' in local_var_params and local_var_params['sender_id'] is not None: # noqa: E501
query_params.append(('senderId', local_var_params['sender_id'])) # noqa: E501
if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
query_params.append(('to', local_var_params['to'])) # noqa: E501
if 'body' in local_var_params and local_var_params['body'] is not None: # noqa: E501
query_params.append(('body', local_var_params['body'])) # noqa: E501
if 'subject' in local_var_params and local_var_params['subject'] is not None: # noqa: E501
query_params.append(('subject', local_var_params['subject'])) # 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(
'/sendEmailQuery', '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 send_email_simple(self, simple_send_email_options, **kwargs): # noqa: E501
"""Send an email # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. # 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_simple(simple_send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SimpleSendEmailOptions simple_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: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_email_simple_with_http_info(simple_send_email_options, **kwargs) # noqa: E501
def send_email_simple_with_http_info(self, simple_send_email_options, **kwargs): # noqa: E501
"""Send an email # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. # 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_simple_with_http_info(simple_send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SimpleSendEmailOptions simple_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: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'simple_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 send_email_simple" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'simple_send_email_options' is set
if self.api_client.client_side_validation and ('simple_send_email_options' not in local_var_params or # noqa: E501
local_var_params['simple_send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `simple_send_email_options` when calling `send_email_simple`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'simple_send_email_options' in local_var_params:
body_params = local_var_params['simple_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(
'/sendEmail', '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)Classes
class CommonActionsControllerApi (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 CommonActionsControllerApi(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 create_new_email_address(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_email_address(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_email_address_with_http_info(**kwargs) # noqa: E501 def create_new_email_address_with_http_info(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_email_address_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :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(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'allow_team_access', 'use_domain_pool', 'expires_at', 'expires_in', 'email_address', 'inbox_type', 'description', 'name', 'tags', 'favourite', 'virtual_inbox', 'use_short_address', 'domain_name', 'domain_id', 'prefix' ] 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 create_new_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'allow_team_access' in local_var_params and local_var_params['allow_team_access'] is not None: # noqa: E501 query_params.append(('allowTeamAccess', local_var_params['allow_team_access'])) # 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 'expires_at' in local_var_params and local_var_params['expires_at'] is not None: # noqa: E501 query_params.append(('expiresAt', local_var_params['expires_at'])) # noqa: E501 if 'expires_in' in local_var_params and local_var_params['expires_in'] is not None: # noqa: E501 query_params.append(('expiresIn', local_var_params['expires_in'])) # noqa: E501 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 'inbox_type' in local_var_params and local_var_params['inbox_type'] is not None: # noqa: E501 query_params.append(('inboxType', local_var_params['inbox_type'])) # noqa: E501 if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501 query_params.append(('description', local_var_params['description'])) # noqa: E501 if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501 query_params.append(('name', local_var_params['name'])) # noqa: E501 if 'tags' in local_var_params and local_var_params['tags'] is not None: # noqa: E501 query_params.append(('tags', local_var_params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'favourite' in local_var_params and local_var_params['favourite'] is not None: # noqa: E501 query_params.append(('favourite', local_var_params['favourite'])) # noqa: E501 if 'virtual_inbox' in local_var_params and local_var_params['virtual_inbox'] is not None: # noqa: E501 query_params.append(('virtualInbox', local_var_params['virtual_inbox'])) # noqa: E501 if 'use_short_address' in local_var_params and local_var_params['use_short_address'] is not None: # noqa: E501 query_params.append(('useShortAddress', local_var_params['use_short_address'])) # noqa: E501 if 'domain_name' in local_var_params and local_var_params['domain_name'] is not None: # noqa: E501 query_params.append(('domainName', local_var_params['domain_name'])) # noqa: E501 if 'domain_id' in local_var_params and local_var_params['domain_id'] is not None: # noqa: E501 query_params.append(('domainId', local_var_params['domain_id'])) # noqa: E501 if 'prefix' in local_var_params and local_var_params['prefix'] is not None: # noqa: E501 query_params.append(('prefix', local_var_params['prefix'])) # 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( '/newEmailAddress', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxDto', # 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 create_random_inbox(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_random_inbox(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_random_inbox_with_http_info(**kwargs) # noqa: E501 def create_random_inbox_with_http_info(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_random_inbox_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :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(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'allow_team_access', 'use_domain_pool', 'expires_at', 'expires_in', 'email_address', 'inbox_type', 'description', 'name', 'tags', 'favourite', 'virtual_inbox', 'use_short_address', 'domain_name', 'domain_id', 'prefix' ] 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 create_random_inbox" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'allow_team_access' in local_var_params and local_var_params['allow_team_access'] is not None: # noqa: E501 query_params.append(('allowTeamAccess', local_var_params['allow_team_access'])) # 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 'expires_at' in local_var_params and local_var_params['expires_at'] is not None: # noqa: E501 query_params.append(('expiresAt', local_var_params['expires_at'])) # noqa: E501 if 'expires_in' in local_var_params and local_var_params['expires_in'] is not None: # noqa: E501 query_params.append(('expiresIn', local_var_params['expires_in'])) # noqa: E501 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 'inbox_type' in local_var_params and local_var_params['inbox_type'] is not None: # noqa: E501 query_params.append(('inboxType', local_var_params['inbox_type'])) # noqa: E501 if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501 query_params.append(('description', local_var_params['description'])) # noqa: E501 if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501 query_params.append(('name', local_var_params['name'])) # noqa: E501 if 'tags' in local_var_params and local_var_params['tags'] is not None: # noqa: E501 query_params.append(('tags', local_var_params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'favourite' in local_var_params and local_var_params['favourite'] is not None: # noqa: E501 query_params.append(('favourite', local_var_params['favourite'])) # noqa: E501 if 'virtual_inbox' in local_var_params and local_var_params['virtual_inbox'] is not None: # noqa: E501 query_params.append(('virtualInbox', local_var_params['virtual_inbox'])) # noqa: E501 if 'use_short_address' in local_var_params and local_var_params['use_short_address'] is not None: # noqa: E501 query_params.append(('useShortAddress', local_var_params['use_short_address'])) # noqa: E501 if 'domain_name' in local_var_params and local_var_params['domain_name'] is not None: # noqa: E501 query_params.append(('domainName', local_var_params['domain_name'])) # noqa: E501 if 'domain_id' in local_var_params and local_var_params['domain_id'] is not None: # noqa: E501 query_params.append(('domainId', local_var_params['domain_id'])) # noqa: E501 if 'prefix' in local_var_params and local_var_params['prefix'] is not None: # noqa: E501 query_params.append(('prefix', local_var_params['prefix'])) # 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( '/createInbox', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxDto', # 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_address(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox email address by inbox id # noqa: E501 Deletes inbox 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.delete_email_address(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_email_address_with_http_info(inbox_id, **kwargs) # noqa: E501 def delete_email_address_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox email address by inbox id # noqa: E501 Deletes inbox 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.delete_email_address_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None 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 delete_email_address" % 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 `delete_email_address`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/deleteEmailAddress', '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 empty_inbox(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in an inbox # noqa: E501 Deletes all emails # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.empty_inbox(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.empty_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501 def empty_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in an inbox # noqa: E501 Deletes all emails # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.empty_inbox_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None 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 empty_inbox" % 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 `empty_inbox`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emptyInbox', '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 send_email_query(self, to, **kwargs): # noqa: E501 """Send an email using query parameters # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query(to, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str to: Email address to send to (required) :param str sender_id: ID of inbox to send from. If null an inbox will be created for sending :param str body: Body of the email message. Supports HTML :param str subject: Subject line of the email :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_query_with_http_info(to, **kwargs) # noqa: E501 def send_email_query_with_http_info(self, to, **kwargs): # noqa: E501 """Send an email using query parameters # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query_with_http_info(to, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str to: Email address to send to (required) :param str sender_id: ID of inbox to send from. If null an inbox will be created for sending :param str body: Body of the email message. Supports HTML :param str subject: Subject line of the email :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 = [ 'to', 'sender_id', 'body', 'subject' ] 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_query" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'to' is set if self.api_client.client_side_validation and ('to' not in local_var_params or # noqa: E501 local_var_params['to'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `to` when calling `send_email_query`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'sender_id' in local_var_params and local_var_params['sender_id'] is not None: # noqa: E501 query_params.append(('senderId', local_var_params['sender_id'])) # noqa: E501 if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501 query_params.append(('to', local_var_params['to'])) # noqa: E501 if 'body' in local_var_params and local_var_params['body'] is not None: # noqa: E501 query_params.append(('body', local_var_params['body'])) # noqa: E501 if 'subject' in local_var_params and local_var_params['subject'] is not None: # noqa: E501 query_params.append(('subject', local_var_params['subject'])) # 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( '/sendEmailQuery', '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 send_email_simple(self, simple_send_email_options, **kwargs): # noqa: E501 """Send an email # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. # 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_simple(simple_send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SimpleSendEmailOptions simple_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_simple_with_http_info(simple_send_email_options, **kwargs) # noqa: E501 def send_email_simple_with_http_info(self, simple_send_email_options, **kwargs): # noqa: E501 """Send an email # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. # 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_simple_with_http_info(simple_send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SimpleSendEmailOptions simple_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: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'simple_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 send_email_simple" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'simple_send_email_options' is set if self.api_client.client_side_validation and ('simple_send_email_options' not in local_var_params or # noqa: E501 local_var_params['simple_send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `simple_send_email_options` when calling `send_email_simple`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'simple_send_email_options' in local_var_params: body_params = local_var_params['simple_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( '/sendEmail', '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)Methods
def create_new_email_address(self, **kwargs)-
Create new random inbox # noqa: E501
Returns an Inbox with an
idand anemailAddress# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.create_new_email_address(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_new_email_address(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_email_address(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_email_address_with_http_info(**kwargs) # noqa: E501 def create_new_email_address_with_http_info(self, **kwargs)-
Create new random inbox # noqa: E501
Returns an Inbox with an
idand anemailAddress# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.create_new_email_address_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :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(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_new_email_address_with_http_info(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_email_address_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :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(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'allow_team_access', 'use_domain_pool', 'expires_at', 'expires_in', 'email_address', 'inbox_type', 'description', 'name', 'tags', 'favourite', 'virtual_inbox', 'use_short_address', 'domain_name', 'domain_id', 'prefix' ] 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 create_new_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'allow_team_access' in local_var_params and local_var_params['allow_team_access'] is not None: # noqa: E501 query_params.append(('allowTeamAccess', local_var_params['allow_team_access'])) # 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 'expires_at' in local_var_params and local_var_params['expires_at'] is not None: # noqa: E501 query_params.append(('expiresAt', local_var_params['expires_at'])) # noqa: E501 if 'expires_in' in local_var_params and local_var_params['expires_in'] is not None: # noqa: E501 query_params.append(('expiresIn', local_var_params['expires_in'])) # noqa: E501 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 'inbox_type' in local_var_params and local_var_params['inbox_type'] is not None: # noqa: E501 query_params.append(('inboxType', local_var_params['inbox_type'])) # noqa: E501 if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501 query_params.append(('description', local_var_params['description'])) # noqa: E501 if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501 query_params.append(('name', local_var_params['name'])) # noqa: E501 if 'tags' in local_var_params and local_var_params['tags'] is not None: # noqa: E501 query_params.append(('tags', local_var_params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'favourite' in local_var_params and local_var_params['favourite'] is not None: # noqa: E501 query_params.append(('favourite', local_var_params['favourite'])) # noqa: E501 if 'virtual_inbox' in local_var_params and local_var_params['virtual_inbox'] is not None: # noqa: E501 query_params.append(('virtualInbox', local_var_params['virtual_inbox'])) # noqa: E501 if 'use_short_address' in local_var_params and local_var_params['use_short_address'] is not None: # noqa: E501 query_params.append(('useShortAddress', local_var_params['use_short_address'])) # noqa: E501 if 'domain_name' in local_var_params and local_var_params['domain_name'] is not None: # noqa: E501 query_params.append(('domainName', local_var_params['domain_name'])) # noqa: E501 if 'domain_id' in local_var_params and local_var_params['domain_id'] is not None: # noqa: E501 query_params.append(('domainId', local_var_params['domain_id'])) # noqa: E501 if 'prefix' in local_var_params and local_var_params['prefix'] is not None: # noqa: E501 query_params.append(('prefix', local_var_params['prefix'])) # 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( '/newEmailAddress', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxDto', # 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 create_random_inbox(self, **kwargs)-
Create new random inbox # noqa: E501
Returns an Inbox with an
idand anemailAddress# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.create_random_inbox(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_random_inbox(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_random_inbox(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_random_inbox_with_http_info(**kwargs) # noqa: E501 def create_random_inbox_with_http_info(self, **kwargs)-
Create new random inbox # noqa: E501
Returns an Inbox with an
idand anemailAddress# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.create_random_inbox_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :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(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_random_inbox_with_http_info(self, **kwargs): # noqa: E501 """Create new random inbox # noqa: E501 Returns an Inbox with an `id` and an `emailAddress` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_random_inbox_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool allow_team_access: :param bool use_domain_pool: :param datetime expires_at: :param int expires_in: :param str email_address: :param str inbox_type: :param str description: :param str name: :param list[str] tags: :param bool favourite: :param bool virtual_inbox: :param bool use_short_address: :param str domain_name: :param str domain_id: :param str prefix: :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(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'allow_team_access', 'use_domain_pool', 'expires_at', 'expires_in', 'email_address', 'inbox_type', 'description', 'name', 'tags', 'favourite', 'virtual_inbox', 'use_short_address', 'domain_name', 'domain_id', 'prefix' ] 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 create_random_inbox" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'allow_team_access' in local_var_params and local_var_params['allow_team_access'] is not None: # noqa: E501 query_params.append(('allowTeamAccess', local_var_params['allow_team_access'])) # 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 'expires_at' in local_var_params and local_var_params['expires_at'] is not None: # noqa: E501 query_params.append(('expiresAt', local_var_params['expires_at'])) # noqa: E501 if 'expires_in' in local_var_params and local_var_params['expires_in'] is not None: # noqa: E501 query_params.append(('expiresIn', local_var_params['expires_in'])) # noqa: E501 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 'inbox_type' in local_var_params and local_var_params['inbox_type'] is not None: # noqa: E501 query_params.append(('inboxType', local_var_params['inbox_type'])) # noqa: E501 if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501 query_params.append(('description', local_var_params['description'])) # noqa: E501 if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501 query_params.append(('name', local_var_params['name'])) # noqa: E501 if 'tags' in local_var_params and local_var_params['tags'] is not None: # noqa: E501 query_params.append(('tags', local_var_params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'favourite' in local_var_params and local_var_params['favourite'] is not None: # noqa: E501 query_params.append(('favourite', local_var_params['favourite'])) # noqa: E501 if 'virtual_inbox' in local_var_params and local_var_params['virtual_inbox'] is not None: # noqa: E501 query_params.append(('virtualInbox', local_var_params['virtual_inbox'])) # noqa: E501 if 'use_short_address' in local_var_params and local_var_params['use_short_address'] is not None: # noqa: E501 query_params.append(('useShortAddress', local_var_params['use_short_address'])) # noqa: E501 if 'domain_name' in local_var_params and local_var_params['domain_name'] is not None: # noqa: E501 query_params.append(('domainName', local_var_params['domain_name'])) # noqa: E501 if 'domain_id' in local_var_params and local_var_params['domain_id'] is not None: # noqa: E501 query_params.append(('domainId', local_var_params['domain_id'])) # noqa: E501 if 'prefix' in local_var_params and local_var_params['prefix'] is not None: # noqa: E501 query_params.append(('prefix', local_var_params['prefix'])) # 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( '/createInbox', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxDto', # 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_address(self, inbox_id, **kwargs)-
Delete inbox email address by inbox id # noqa: E501
Deletes inbox 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.delete_email_address(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_email_address(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox email address by inbox id # noqa: E501 Deletes inbox 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.delete_email_address(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_email_address_with_http_info(inbox_id, **kwargs) # noqa: E501 def delete_email_address_with_http_info(self, inbox_id, **kwargs)-
Delete inbox email address by inbox id # noqa: E501
Deletes inbox 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.delete_email_address_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_email_address_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox email address by inbox id # noqa: E501 Deletes inbox 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.delete_email_address_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None 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 delete_email_address" % 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 `delete_email_address`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/deleteEmailAddress', '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 empty_inbox(self, inbox_id, **kwargs)-
Delete all emails in an inbox # noqa: E501
Deletes all emails # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.empty_inbox(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread.
Expand source code
def empty_inbox(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in an inbox # noqa: E501 Deletes all emails # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.empty_inbox(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.empty_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501 def empty_inbox_with_http_info(self, inbox_id, **kwargs)-
Delete all emails in an inbox # noqa: E501
Deletes all emails # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.empty_inbox_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_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: None If the method is called asynchronously, returns the request thread.
Expand source code
def empty_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in an inbox # noqa: E501 Deletes all emails # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.empty_inbox_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_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: None 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 empty_inbox" % 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 `empty_inbox`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/emptyInbox', '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 send_email_query(self, to, **kwargs)-
Send an email using query parameters # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query(to, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str to: Email address to send to (required) :param str sender_id: ID of inbox to send from. If null an inbox will be created for sending :param str body: Body of the email message. Supports HTML :param str subject: Subject line of the email :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_query(self, to, **kwargs): # noqa: E501 """Send an email using query parameters # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query(to, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str to: Email address to send to (required) :param str sender_id: ID of inbox to send from. If null an inbox will be created for sending :param str body: Body of the email message. Supports HTML :param str subject: Subject line of the email :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_query_with_http_info(to, **kwargs) # noqa: E501 def send_email_query_with_http_info(self, to, **kwargs)-
Send an email using query parameters # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query_with_http_info(to, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str to: Email address to send to (required) :param str sender_id: ID of inbox to send from. If null an inbox will be created for sending :param str body: Body of the email message. Supports HTML :param str subject: Subject line of the email :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_query_with_http_info(self, to, **kwargs): # noqa: E501 """Send an email using query parameters # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. # 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_query_with_http_info(to, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str to: Email address to send to (required) :param str sender_id: ID of inbox to send from. If null an inbox will be created for sending :param str body: Body of the email message. Supports HTML :param str subject: Subject line of the email :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 = [ 'to', 'sender_id', 'body', 'subject' ] 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_query" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'to' is set if self.api_client.client_side_validation and ('to' not in local_var_params or # noqa: E501 local_var_params['to'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `to` when calling `send_email_query`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'sender_id' in local_var_params and local_var_params['sender_id'] is not None: # noqa: E501 query_params.append(('senderId', local_var_params['sender_id'])) # noqa: E501 if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501 query_params.append(('to', local_var_params['to'])) # noqa: E501 if 'body' in local_var_params and local_var_params['body'] is not None: # noqa: E501 query_params.append(('body', local_var_params['body'])) # noqa: E501 if 'subject' in local_var_params and local_var_params['subject'] is not None: # noqa: E501 query_params.append(('subject', local_var_params['subject'])) # 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( '/sendEmailQuery', '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 send_email_simple(self, simple_send_email_options, **kwargs)-
Send an email # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. # 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_simple(simple_send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SimpleSendEmailOptions simple_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: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_simple(self, simple_send_email_options, **kwargs): # noqa: E501 """Send an email # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. # 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_simple(simple_send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SimpleSendEmailOptions simple_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_simple_with_http_info(simple_send_email_options, **kwargs) # noqa: E501 def send_email_simple_with_http_info(self, simple_send_email_options, **kwargs)-
Send an email # noqa: E501
If no senderId or inboxId provided a random email address will be used to send from. # 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_simple_with_http_info(simple_send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SimpleSendEmailOptions simple_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: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_simple_with_http_info(self, simple_send_email_options, **kwargs): # noqa: E501 """Send an email # noqa: E501 If no senderId or inboxId provided a random email address will be used to send from. # 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_simple_with_http_info(simple_send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SimpleSendEmailOptions simple_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: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'simple_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 send_email_simple" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'simple_send_email_options' is set if self.api_client.client_side_validation and ('simple_send_email_options' not in local_var_params or # noqa: E501 local_var_params['simple_send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `simple_send_email_options` when calling `send_email_simple`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'simple_send_email_options' in local_var_params: body_params = local_var_params['simple_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( '/sendEmail', '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)