Module mailslurp_client.api.inbox_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 InboxControllerApi(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 cancel_scheduled_job(self, job_id, **kwargs): # noqa: E501
"""Cancel a scheduled email job # noqa: E501
Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_scheduled_job(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str job_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: ScheduledJobDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.cancel_scheduled_job_with_http_info(job_id, **kwargs) # noqa: E501
def cancel_scheduled_job_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Cancel a scheduled email job # noqa: E501
Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_scheduled_job_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str job_id: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'job_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 cancel_scheduled_job" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'job_id' is set
if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501
local_var_params['job_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `job_id` when calling `cancel_scheduled_job`") # noqa: E501
collection_formats = {}
path_params = {}
if 'job_id' in local_var_params:
path_params['jobId'] = local_var_params['job_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/scheduled-jobs/{jobId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ScheduledJobDto', # 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_inbox(self, **kwargs): # noqa: E501
"""Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. # noqa: E501
Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
:param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
:param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
:param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
:param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
:param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
:param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
:param int expires_in: Number of milliseconds that inbox should exist for
:param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
:param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
:param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
:param bool use_short_address: Use a shorter email address under 31 characters
:param str domain_id: ID of custom domain to use for email address.
:param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox.
:param str prefix: Prefix to add before the email address for easier labelling or identification.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for 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_inbox_with_http_info(**kwargs) # noqa: E501
def create_inbox_with_http_info(self, **kwargs): # noqa: E501
"""Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. # noqa: E501
Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
:param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
:param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
:param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
:param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
:param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
:param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
:param int expires_in: Number of milliseconds that inbox should exist for
:param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
:param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
:param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
:param bool use_short_address: Use a shorter email address under 31 characters
:param str domain_id: ID of custom domain to use for email address.
:param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox.
:param str prefix: Prefix to add before the email address for easier labelling or identification.
: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 = [
'email_address',
'tags',
'name',
'description',
'use_domain_pool',
'favourite',
'expires_at',
'expires_in',
'allow_team_access',
'inbox_type',
'virtual_inbox',
'use_short_address',
'domain_id',
'domain_name',
'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_inbox" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501
query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501
if '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 '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 '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 '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 '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 '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 '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 '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 '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_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 '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 '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(
'/inboxes', '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_inbox_ruleset(self, inbox_id, create_inbox_ruleset_options, **kwargs): # noqa: E501
"""Create an inbox ruleset # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset(inbox_id, create_inbox_ruleset_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: inboxId (required)
:param CreateInboxRulesetOptions create_inbox_ruleset_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: InboxRulesetDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, **kwargs) # noqa: E501
def create_inbox_ruleset_with_http_info(self, inbox_id, create_inbox_ruleset_options, **kwargs): # noqa: E501
"""Create an inbox ruleset # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: inboxId (required)
:param CreateInboxRulesetOptions create_inbox_ruleset_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxRulesetDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'create_inbox_ruleset_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 create_inbox_ruleset" % 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 `create_inbox_ruleset`") # noqa: E501
# verify the required parameter 'create_inbox_ruleset_options' is set
if self.api_client.client_side_validation and ('create_inbox_ruleset_options' not in local_var_params or # noqa: E501
local_var_params['create_inbox_ruleset_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_inbox_ruleset_options` when calling `create_inbox_ruleset`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_inbox_ruleset_options' in local_var_params:
body_params = local_var_params['create_inbox_ruleset_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/rulesets', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxRulesetDto', # 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_inbox_with_defaults(self, **kwargs): # noqa: E501
"""Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_inbox_with_defaults_with_http_info(**kwargs) # noqa: E501
def create_inbox_with_defaults_with_http_info(self, **kwargs): # noqa: E501
"""Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method create_inbox_with_defaults" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/inboxes/withDefaults', '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_inbox_with_options(self, create_inbox_dto, **kwargs): # noqa: E501
"""Create an inbox with options. Extended options for inbox creation. # noqa: E501
Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options(create_inbox_dto, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CreateInboxDto create_inbox_dto: (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: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_inbox_with_options_with_http_info(create_inbox_dto, **kwargs) # noqa: E501
def create_inbox_with_options_with_http_info(self, create_inbox_dto, **kwargs): # noqa: E501
"""Create an inbox with options. Extended options for inbox creation. # noqa: E501
Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options_with_http_info(create_inbox_dto, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CreateInboxDto create_inbox_dto: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'create_inbox_dto'
]
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_inbox_with_options" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'create_inbox_dto' is set
if self.api_client.client_side_validation and ('create_inbox_dto' not in local_var_params or # noqa: E501
local_var_params['create_inbox_dto'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_inbox_dto` when calling `create_inbox_with_options`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_inbox_dto' in local_var_params:
body_params = local_var_params['create_inbox_dto']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/withOptions', '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_all_inbox_emails(self, inbox_id, **kwargs): # noqa: E501
"""Delete all emails in a given inboxes. # noqa: E501
Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inbox_emails(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_all_inbox_emails_with_http_info(inbox_id, **kwargs) # noqa: E501
def delete_all_inbox_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Delete all emails in a given inboxes. # noqa: E501
Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inbox_emails_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_all_inbox_emails" % 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_all_inbox_emails`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/deleteAllInboxEmails', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_all_inboxes(self, **kwargs): # noqa: E501
"""Delete all inboxes # noqa: E501
Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.delete_all_inboxes_with_http_info(**kwargs) # noqa: E501
def delete_all_inboxes_with_http_info(self, **kwargs): # noqa: E501
"""Delete all inboxes # noqa: E501
Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_all_inboxes" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_all_inboxes_by_description(self, description, **kwargs): # noqa: E501
"""Delete inboxes by description # noqa: E501
Permanently delete all inboxes by description # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_description(description, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str description: (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_all_inboxes_by_description_with_http_info(description, **kwargs) # noqa: E501
def delete_all_inboxes_by_description_with_http_info(self, description, **kwargs): # noqa: E501
"""Delete inboxes by description # noqa: E501
Permanently delete all inboxes by description # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_description_with_http_info(description, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str description: (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 = [
'description'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_all_inboxes_by_description" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'description' is set
if self.api_client.client_side_validation and ('description' not in local_var_params or # noqa: E501
local_var_params['description'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `description` when calling `delete_all_inboxes_by_description`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/by-description', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_all_inboxes_by_name(self, name, **kwargs): # noqa: E501
"""Delete inboxes by name # noqa: E501
Permanently delete all inboxes by name # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_name(name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str name: (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_all_inboxes_by_name_with_http_info(name, **kwargs) # noqa: E501
def delete_all_inboxes_by_name_with_http_info(self, name, **kwargs): # noqa: E501
"""Delete inboxes by name # noqa: E501
Permanently delete all inboxes by name # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_name_with_http_info(name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str name: (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 = [
'name'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_all_inboxes_by_name" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'name' is set
if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501
local_var_params['name'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `name` when calling `delete_all_inboxes_by_name`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/by-name', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_all_inboxes_by_tag(self, tag, **kwargs): # noqa: E501
"""Delete inboxes by tag # noqa: E501
Permanently delete all inboxes by tag # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_tag(tag, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str tag: (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_all_inboxes_by_tag_with_http_info(tag, **kwargs) # noqa: E501
def delete_all_inboxes_by_tag_with_http_info(self, tag, **kwargs): # noqa: E501
"""Delete inboxes by tag # noqa: E501
Permanently delete all inboxes by tag # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_tag_with_http_info(tag, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str tag: (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 = [
'tag'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_all_inboxes_by_tag" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'tag' is set
if self.api_client.client_side_validation and ('tag' not in local_var_params or # noqa: E501
local_var_params['tag'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `tag` when calling `delete_all_inboxes_by_tag`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501
query_params.append(('tag', local_var_params['tag'])) # 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(
'/inboxes/by-tag', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_inbox(self, inbox_id, **kwargs): # noqa: E501
"""Delete inbox # noqa: E501
Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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.delete_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501
def delete_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Delete inbox # noqa: E501
Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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 delete_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 `delete_inbox`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}', '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 does_inbox_exist(self, email_address, **kwargs): # noqa: E501
"""Does inbox exist # noqa: E501
Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.does_inbox_exist(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: Email address (required)
:param bool allow_catch_all:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: InboxExistsDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.does_inbox_exist_with_http_info(email_address, **kwargs) # noqa: E501
def does_inbox_exist_with_http_info(self, email_address, **kwargs): # noqa: E501
"""Does inbox exist # noqa: E501
Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.does_inbox_exist_with_http_info(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: Email address (required)
:param bool allow_catch_all:
: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(InboxExistsDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_address',
'allow_catch_all'
]
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 does_inbox_exist" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_address' is set
if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501
local_var_params['email_address'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_address` when calling `does_inbox_exist`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501
query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501
if 'allow_catch_all' in local_var_params and local_var_params['allow_catch_all'] is not None: # noqa: E501
query_params.append(('allowCatchAll', local_var_params['allow_catch_all'])) # 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(
'/inboxes/exists', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxExistsDto', # 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 flush_expired(self, **kwargs): # noqa: E501
"""Remove expired inboxes # noqa: E501
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.flush_expired(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: FlushExpiredInboxesResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.flush_expired_with_http_info(**kwargs) # noqa: E501
def flush_expired_with_http_info(self, **kwargs): # noqa: E501
"""Remove expired inboxes # noqa: E501
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.flush_expired_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(FlushExpiredInboxesResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method flush_expired" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/expired', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FlushExpiredInboxesResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_inboxes(self, **kwargs): # noqa: E501
"""List All Inboxes Paginated # noqa: E501
List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_inboxes(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool favourite: Optionally filter results for favourites only
:param str search: Optionally filter by search words partial matching ID, tags, name, and email address
:param str tag: Optionally filter by tags. Will return inboxes that include given tags
:param bool team_access: DEPRECATED. Optionally filter by team access.
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param str inbox_type: Optional filter by inbox type
:param str inbox_function: Optional filter by inbox function
:param str domain_id: Optional domain ID filter
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageInboxProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_inboxes_with_http_info(**kwargs) # noqa: E501
def get_all_inboxes_with_http_info(self, **kwargs): # noqa: E501
"""List All Inboxes Paginated # noqa: E501
List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_inboxes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool favourite: Optionally filter results for favourites only
:param str search: Optionally filter by search words partial matching ID, tags, name, and email address
:param str tag: Optionally filter by tags. Will return inboxes that include given tags
:param bool team_access: DEPRECATED. Optionally filter by team access.
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param str inbox_type: Optional filter by inbox type
:param str inbox_function: Optional filter by inbox function
:param str domain_id: Optional domain ID filter
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'favourite',
'search',
'tag',
'team_access',
'since',
'before',
'inbox_type',
'inbox_function',
'domain_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_inboxes" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if '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 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501
query_params.append(('search', local_var_params['search'])) # noqa: E501
if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501
query_params.append(('tag', local_var_params['tag'])) # noqa: E501
if 'team_access' in local_var_params and local_var_params['team_access'] is not None: # noqa: E501
query_params.append(('teamAccess', local_var_params['team_access'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 'inbox_function' in local_var_params and local_var_params['inbox_function'] is not None: # noqa: E501
query_params.append(('inboxFunction', local_var_params['inbox_function'])) # 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
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(
'/inboxes/paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_inboxes_offset_paginated(self, **kwargs): # noqa: E501
"""List All Inboxes Offset Paginated # noqa: E501
List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_inboxes_offset_paginated(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool favourite: Optionally filter results for favourites only
:param str search: Optionally filter by search words partial matching ID, tags, name, and email address
:param str tag: Optionally filter by tags. Will return inboxes that include given tags
:param bool team_access: DEPRECATED. Optionally filter by team access.
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param str inbox_type: Optional filter by inbox type
:param str inbox_function: Optional filter by inbox function
:param str domain_id: Optional domain ID filter
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageInboxProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_inboxes_offset_paginated_with_http_info(**kwargs) # noqa: E501
def get_all_inboxes_offset_paginated_with_http_info(self, **kwargs): # noqa: E501
"""List All Inboxes Offset Paginated # noqa: E501
List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_inboxes_offset_paginated_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param bool favourite: Optionally filter results for favourites only
:param str search: Optionally filter by search words partial matching ID, tags, name, and email address
:param str tag: Optionally filter by tags. Will return inboxes that include given tags
:param bool team_access: DEPRECATED. Optionally filter by team access.
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param str inbox_type: Optional filter by inbox type
:param str inbox_function: Optional filter by inbox function
:param str domain_id: Optional domain ID filter
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'favourite',
'search',
'tag',
'team_access',
'since',
'before',
'inbox_type',
'inbox_function',
'domain_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_inboxes_offset_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if '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 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501
query_params.append(('search', local_var_params['search'])) # noqa: E501
if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501
query_params.append(('tag', local_var_params['tag'])) # noqa: E501
if 'team_access' in local_var_params and local_var_params['team_access'] is not None: # noqa: E501
query_params.append(('teamAccess', local_var_params['team_access'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 'inbox_function' in local_var_params and local_var_params['inbox_function'] is not None: # noqa: E501
query_params.append(('inboxFunction', local_var_params['inbox_function'])) # 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
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(
'/inboxes/offset-paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_scheduled_jobs(self, **kwargs): # noqa: E501
"""Get all scheduled email sending jobs for account # noqa: E501
Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_scheduled_jobs(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in scheduled job list pagination
:param int size: Optional page size in scheduled job list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageScheduledJobs
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_scheduled_jobs_with_http_info(**kwargs) # noqa: E501
def get_all_scheduled_jobs_with_http_info(self, **kwargs): # noqa: E501
"""Get all scheduled email sending jobs for account # noqa: E501
Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_scheduled_jobs_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in scheduled job list pagination
:param int size: Optional page size in scheduled job list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_scheduled_jobs" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/scheduled-jobs', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageScheduledJobs', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_delivery_statuses_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501
"""get_delivery_statuses_by_inbox_id # noqa: E501
Get all email delivery statuses for an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_delivery_statuses_by_inbox_id(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in delivery status list pagination
:param int size: Optional page size in delivery status list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageDeliveryStatus
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_delivery_statuses_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""get_delivery_statuses_by_inbox_id # noqa: E501
Get all email delivery statuses for an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in delivery status list pagination
:param int size: Optional page size in delivery status list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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(PageDeliveryStatus, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_delivery_statuses_by_inbox_id" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_delivery_statuses_by_inbox_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/delivery-status', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageDeliveryStatus', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_emails(self, inbox_id, **kwargs): # noqa: E501
"""Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501
List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Id of inbox that emails belongs to (required)
:param int size: Alias for limit. Assessed first before assessing any passed limit.
:param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
:param str sort: Sort the results by received date and direction ASC or DESC
:param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned
:param int delay_timeout:
:param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
:param bool unread_only:
:param datetime before: Exclude emails received after this ISO 8601 date time
:param datetime since: Exclude emails received before this ISO 8601 date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[EmailPreview]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_emails_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501
List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_emails_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Id of inbox that emails belongs to (required)
:param int size: Alias for limit. Assessed first before assessing any passed limit.
:param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
:param str sort: Sort the results by received date and direction ASC or DESC
:param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned
:param int delay_timeout:
:param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
:param bool unread_only:
:param datetime before: Exclude emails received after this ISO 8601 date time
:param datetime since: Exclude emails received before this ISO 8601 date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[EmailPreview], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'size',
'limit',
'sort',
'retry_timeout',
'delay_timeout',
'min_count',
'unread_only',
'before',
'since'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_emails" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_emails`") # noqa: E501
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_emails`, must be a value less than or equal to `100`") # noqa: E501
if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `limit` when calling `get_emails`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'retry_timeout' in local_var_params and local_var_params['retry_timeout'] is not None: # noqa: E501
query_params.append(('retryTimeout', local_var_params['retry_timeout'])) # noqa: E501
if 'delay_timeout' in local_var_params and local_var_params['delay_timeout'] is not None: # noqa: E501
query_params.append(('delayTimeout', local_var_params['delay_timeout'])) # noqa: E501
if 'min_count' in local_var_params and local_var_params['min_count'] is not None: # noqa: E501
query_params.append(('minCount', local_var_params['min_count'])) # noqa: E501
if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501
query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
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(
'/inboxes/{inboxId}/emails', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[EmailPreview]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_imap_smtp_access(self, **kwargs): # noqa: E501
"""get_imap_smtp_access # noqa: E501
Get IMAP and SMTP access usernames and passwords # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_imap_smtp_access(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Inbox ID
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImapSmtpAccessDetails
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_imap_smtp_access_with_http_info(**kwargs) # noqa: E501
def get_imap_smtp_access_with_http_info(self, **kwargs): # noqa: E501
"""get_imap_smtp_access # noqa: E501
Get IMAP and SMTP access usernames and passwords # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_imap_smtp_access_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Inbox ID
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImapSmtpAccessDetails, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_imap_smtp_access" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/imap-smtp-access', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ImapSmtpAccessDetails', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox(self, inbox_id, **kwargs): # noqa: E501
"""Get Inbox. Returns properties of an inbox. # noqa: E501
Returns an inbox's properties, including its email address and ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_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: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get Inbox. Returns properties of an inbox. # noqa: E501
Returns an inbox's properties, including its email address and ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_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: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_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 `get_inbox`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}', 'GET',
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 get_inbox_by_email_address(self, email_address, **kwargs): # noqa: E501
"""Search for an inbox with the provided email address # noqa: E501
Get a inbox result by email address # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_email_address(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: (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: InboxByEmailAddressResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_by_email_address_with_http_info(email_address, **kwargs) # noqa: E501
def get_inbox_by_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501
"""Search for an inbox with the provided email address # noqa: E501
Get a inbox result by email address # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_email_address_with_http_info(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: (required)
:param _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(InboxByEmailAddressResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_address'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_by_email_address" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email_address' is set
if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501
local_var_params['email_address'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email_address` when calling `get_inbox_by_email_address`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501
query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501
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(
'/inboxes/byEmailAddress', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxByEmailAddressResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_by_name(self, name, **kwargs): # noqa: E501
"""Search for an inbox with the given name # noqa: E501
Get a inbox result by name # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_name(name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str name: (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: InboxByNameResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_by_name_with_http_info(name, **kwargs) # noqa: E501
def get_inbox_by_name_with_http_info(self, name, **kwargs): # noqa: E501
"""Search for an inbox with the given name # noqa: E501
Get a inbox result by name # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_name_with_http_info(name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str name: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxByNameResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'name'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_by_name" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'name' is set
if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501
local_var_params['name'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `name` when calling `get_inbox_by_name`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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
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(
'/inboxes/byName', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxByNameResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_count(self, **kwargs): # noqa: E501
"""Get total inbox count # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_count(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CountDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_count_with_http_info(**kwargs) # noqa: E501
def get_inbox_count_with_http_info(self, **kwargs): # noqa: E501
"""Get total inbox count # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_count_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_count" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/inboxes/count', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CountDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_email_count(self, inbox_id, **kwargs): # noqa: E501
"""Get email count in inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_email_count(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Id of inbox that emails belongs to (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: CountDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_email_count_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_inbox_email_count_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get email count in inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_email_count_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Id of inbox that emails belongs to (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_email_count" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_email_count`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/emails/count', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CountDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_emails_paginated(self, inbox_id, **kwargs): # noqa: E501
"""Get inbox emails paginated # noqa: E501
Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_emails_paginated(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Id of inbox that emails belongs to (required)
:param int page: Optional page index in inbox emails list pagination
:param int size: Optional page size in inbox emails list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Optional filter by received after given date time
:param datetime before: Optional filter by received before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageEmailPreview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_emails_paginated_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_inbox_emails_paginated_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get inbox emails paginated # noqa: E501
Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_emails_paginated_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Id of inbox that emails belongs to (required)
:param int page: Optional page index in inbox emails list pagination
:param int size: Optional page size in inbox emails list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Optional filter by received after given date time
:param datetime before: Optional filter by received before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageEmailPreview, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_emails_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_emails_paginated`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/emails/paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageEmailPreview', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_ids(self, **kwargs): # noqa: E501
"""Get all inbox IDs # noqa: E501
Get list of inbox IDs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_ids(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: InboxIdsResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_ids_with_http_info(**kwargs) # noqa: E501
def get_inbox_ids_with_http_info(self, **kwargs): # noqa: E501
"""Get all inbox IDs # noqa: E501
Get list of inbox IDs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_ids_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxIdsResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_ids" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/inboxes/ids', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxIdsResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_sent_emails(self, inbox_id, **kwargs): # noqa: E501
"""Get Inbox Sent Emails # noqa: E501
Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_sent_emails(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in inbox sent email list pagination
:param int size: Optional page size in inbox sent email list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional sent email search
:param datetime since: Optional filter by sent after given date time
:param datetime before: Optional filter by sent before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageSentEmailProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_sent_emails_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_inbox_sent_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get Inbox Sent Emails # noqa: E501
Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_sent_emails_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in inbox sent email list pagination
:param int size: Optional page size in inbox sent email list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional sent email search
:param datetime since: Optional filter by sent after given date time
:param datetime before: Optional filter by sent before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageSentEmailProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_sent_emails" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_sent_emails`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/sent', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageSentEmailProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inbox_tags(self, **kwargs): # noqa: E501
"""Get inbox tags # noqa: E501
Get all inbox tags # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_tags(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[str]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_tags_with_http_info(**kwargs) # noqa: E501
def get_inbox_tags_with_http_info(self, **kwargs): # noqa: E501
"""Get inbox tags # noqa: E501
Get all inbox tags # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_tags_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[str], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbox_tags" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/inboxes/tags', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[str]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_inboxes(self, **kwargs): # noqa: E501
"""List Inboxes and email addresses # noqa: E501
List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inboxes(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries.
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Optional filter by created after given date time
:param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes
:param datetime before: Optional filter by created before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[InboxDto]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inboxes_with_http_info(**kwargs) # noqa: E501
def get_inboxes_with_http_info(self, **kwargs): # noqa: E501
"""List Inboxes and email addresses # noqa: E501
List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inboxes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries.
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Optional filter by created after given date time
:param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes
:param datetime before: Optional filter by created before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[InboxDto], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'size',
'sort',
'since',
'exclude_catch_all_inboxes',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inboxes" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_inboxes`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'exclude_catch_all_inboxes' in local_var_params and local_var_params['exclude_catch_all_inboxes'] is not None: # noqa: E501
query_params.append(('excludeCatchAllInboxes', local_var_params['exclude_catch_all_inboxes'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[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 get_latest_email_in_inbox(self, inbox_id, timeout_millis, **kwargs): # noqa: E501
"""Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501
Get the newest email in an inbox or wait for one to arrive # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox(inbox_id, timeout_millis, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to get the latest email from (required)
:param int timeout_millis: Timeout milliseconds to wait for latest email (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Email
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, **kwargs) # noqa: E501
def get_latest_email_in_inbox_with_http_info(self, inbox_id, timeout_millis, **kwargs): # noqa: E501
"""Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501
Get the newest email in an inbox or wait for one to arrive # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to get the latest email from (required)
:param int timeout_millis: Timeout milliseconds to wait for latest email (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Email, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'timeout_millis'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_latest_email_in_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 `get_latest_email_in_inbox`") # noqa: E501
# verify the required parameter 'timeout_millis' is set
if self.api_client.client_side_validation and ('timeout_millis' not in local_var_params or # noqa: E501
local_var_params['timeout_millis'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `timeout_millis` when calling `get_latest_email_in_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
if 'timeout_millis' in local_var_params and local_var_params['timeout_millis'] is not None: # noqa: E501
query_params.append(('timeoutMillis', local_var_params['timeout_millis'])) # 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(
'/inboxes/getLatestEmail', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Email', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_organization_inboxes(self, **kwargs): # noqa: E501
"""List Organization Inboxes Paginated # noqa: E501
List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_organization_inboxes(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageOrganizationInboxProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_organization_inboxes_with_http_info(**kwargs) # noqa: E501
def get_organization_inboxes_with_http_info(self, **kwargs): # noqa: E501
"""List Organization Inboxes Paginated # noqa: E501
List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_organization_inboxes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageOrganizationInboxProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_organization_inboxes" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/organization', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageOrganizationInboxProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_scheduled_job(self, job_id, **kwargs): # noqa: E501
"""Get a scheduled email job # noqa: E501
Get a scheduled email job details. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_job(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str job_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: ScheduledJobDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_scheduled_job_with_http_info(job_id, **kwargs) # noqa: E501
def get_scheduled_job_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Get a scheduled email job # noqa: E501
Get a scheduled email job details. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_job_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str job_id: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'job_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_scheduled_job" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'job_id' is set
if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501
local_var_params['job_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `job_id` when calling `get_scheduled_job`") # noqa: E501
collection_formats = {}
path_params = {}
if 'job_id' in local_var_params:
path_params['jobId'] = local_var_params['job_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/scheduled-jobs/{jobId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ScheduledJobDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_scheduled_jobs_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501
"""Get all scheduled email sending jobs for the inbox # noqa: E501
Schedule sending of emails using scheduled jobs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_jobs_by_inbox_id(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in scheduled job list pagination
:param int size: Optional page size in scheduled job list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageScheduledJobs
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_scheduled_jobs_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get all scheduled email sending jobs for the inbox # noqa: E501
Schedule sending of emails using scheduled jobs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in scheduled job list pagination
:param int size: Optional page size in scheduled job list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_scheduled_jobs_by_inbox_id" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_scheduled_jobs_by_inbox_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/scheduled-jobs', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageScheduledJobs', # 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 list_inbox_rulesets(self, inbox_id, **kwargs): # noqa: E501
"""List inbox rulesets # noqa: E501
List all rulesets attached to an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_rulesets(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in inbox ruleset list pagination
:param int size: Optional page size in inbox ruleset list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageInboxRulesetDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.list_inbox_rulesets_with_http_info(inbox_id, **kwargs) # noqa: E501
def list_inbox_rulesets_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""List inbox rulesets # noqa: E501
List all rulesets attached to an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_rulesets_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in inbox ruleset list pagination
:param int size: Optional page size in inbox ruleset list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageInboxRulesetDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method list_inbox_rulesets" % 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 `list_inbox_rulesets`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/rulesets', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxRulesetDto', # 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 list_inbox_tracking_pixels(self, inbox_id, **kwargs): # noqa: E501
"""List inbox tracking pixels # noqa: E501
List all tracking pixels sent from an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_tracking_pixels(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in inbox tracking pixel list pagination
:param int size: Optional page size in inbox tracking pixel list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageTrackingPixelProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.list_inbox_tracking_pixels_with_http_info(inbox_id, **kwargs) # noqa: E501
def list_inbox_tracking_pixels_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""List inbox tracking pixels # noqa: E501
List all tracking pixels sent from an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_tracking_pixels_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in inbox tracking pixel list pagination
:param int size: Optional page size in inbox tracking pixel list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Optional filter by created after given date time
:param datetime before: Optional filter by created before given date time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageTrackingPixelProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'search_filter',
'since',
'before'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method list_inbox_tracking_pixels" % 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 `list_inbox_tracking_pixels`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/tracking-pixels', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageTrackingPixelProjection', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def search_inboxes(self, search_inboxes_options, **kwargs): # noqa: E501
"""Search all inboxes and return matching inboxes # noqa: E501
Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_inboxes(search_inboxes_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SearchInboxesOptions search_inboxes_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: PageInboxProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.search_inboxes_with_http_info(search_inboxes_options, **kwargs) # noqa: E501
def search_inboxes_with_http_info(self, search_inboxes_options, **kwargs): # noqa: E501
"""Search all inboxes and return matching inboxes # noqa: E501
Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_inboxes_with_http_info(search_inboxes_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SearchInboxesOptions search_inboxes_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'search_inboxes_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method search_inboxes" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'search_inboxes_options' is set
if self.api_client.client_side_validation and ('search_inboxes_options' not in local_var_params or # noqa: E501
local_var_params['search_inboxes_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `search_inboxes_options` when calling `search_inboxes`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'search_inboxes_options' in local_var_params:
body_params = local_var_params['search_inboxes_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/search', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxProjection', # 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(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Send Email # noqa: E501
Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. # 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(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_email_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501
def send_email_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Send Email # noqa: E501
Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. # 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_with_http_info(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'send_email_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method send_email" % 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 `send_email`") # noqa: E501
# verify the required parameter 'send_email_options' is set
if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501
local_var_params['send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_email_options' in local_var_params:
body_params = local_var_params['send_email_options']
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}', '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_and_confirm(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Send email and return sent confirmation # noqa: E501
Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: SentEmailDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_email_and_confirm_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501
def send_email_and_confirm_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Send email and return sent confirmation # noqa: E501
Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm_with_http_info(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'send_email_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method send_email_and_confirm" % 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 `send_email_and_confirm`") # noqa: E501
# verify the required parameter 'send_email_options' is set
if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501
local_var_params['send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_and_confirm`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_email_options' in local_var_params:
body_params = local_var_params['send_email_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/confirm', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentEmailDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def send_email_with_queue(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs): # noqa: E501
"""Send email with queue # noqa: E501
Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue(inbox_id, validate_before_enqueue, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param bool validate_before_enqueue: Validate before adding to queue (required)
:param SendEmailOptions send_email_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, **kwargs) # noqa: E501
def send_email_with_queue_with_http_info(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs): # noqa: E501
"""Send email with queue # noqa: E501
Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param bool validate_before_enqueue: Validate before adding to queue (required)
:param SendEmailOptions send_email_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'validate_before_enqueue',
'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_with_queue" % 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 `send_email_with_queue`") # noqa: E501
# verify the required parameter 'validate_before_enqueue' is set
if self.api_client.client_side_validation and ('validate_before_enqueue' not in local_var_params or # noqa: E501
local_var_params['validate_before_enqueue'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `validate_before_enqueue` when calling `send_email_with_queue`") # noqa: E501
# verify the required parameter 'send_email_options' is set
if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501
local_var_params['send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_with_queue`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'validate_before_enqueue' in local_var_params and local_var_params['validate_before_enqueue'] is not None: # noqa: E501
query_params.append(('validateBeforeEnqueue', local_var_params['validate_before_enqueue'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_email_options' in local_var_params:
body_params = local_var_params['send_email_options']
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/with-queue', '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_smtp_envelope(self, inbox_id, send_smtp_envelope_options, **kwargs): # noqa: E501
"""Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501
Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_smtp_envelope(inbox_id, send_smtp_envelope_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: SentEmailDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, **kwargs) # noqa: E501
def send_smtp_envelope_with_http_info(self, inbox_id, send_smtp_envelope_options, **kwargs): # noqa: E501
"""Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501
Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'send_smtp_envelope_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_smtp_envelope" % 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 `send_smtp_envelope`") # noqa: E501
# verify the required parameter 'send_smtp_envelope_options' is set
if self.api_client.client_side_validation and ('send_smtp_envelope_options' not in local_var_params or # noqa: E501
local_var_params['send_smtp_envelope_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_smtp_envelope_options` when calling `send_smtp_envelope`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_smtp_envelope_options' in local_var_params:
body_params = local_var_params['send_smtp_envelope_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/smtp-envelope', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentEmailDto', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def send_test_email(self, inbox_id, **kwargs): # noqa: E501
"""Send a test email to inbox # noqa: E501
Send an inbox a test email to test email receiving is working # 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_test_email(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.send_test_email_with_http_info(inbox_id, **kwargs) # noqa: E501
def send_test_email_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Send a test email to inbox # noqa: E501
Send an inbox a test email to test email receiving is working # 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_test_email_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 send_test_email" % 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 `send_test_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/send-test-email', '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_with_schedule(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Send email with with delay or schedule # noqa: E501
Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param datetime send_at_timestamp: Sending timestamp
:param int send_at_now_plus_seconds: Send after n seconds
:param bool validate_before_enqueue: Validate before adding to queue
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ScheduledJobDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_with_schedule_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501
def send_with_schedule_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501
"""Send email with with delay or schedule # noqa: E501
Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule_with_http_info(inbox_id, send_email_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of the inbox you want to send the email from (required)
:param SendEmailOptions send_email_options: (required)
:param datetime send_at_timestamp: Sending timestamp
:param int send_at_now_plus_seconds: Send after n seconds
:param bool validate_before_enqueue: Validate before adding to queue
: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(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'send_email_options',
'send_at_timestamp',
'send_at_now_plus_seconds',
'validate_before_enqueue'
]
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_with_schedule" % 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 `send_with_schedule`") # noqa: E501
# verify the required parameter 'send_email_options' is set
if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501
local_var_params['send_email_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_with_schedule`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'send_at_timestamp' in local_var_params and local_var_params['send_at_timestamp'] is not None: # noqa: E501
query_params.append(('sendAtTimestamp', local_var_params['send_at_timestamp'])) # noqa: E501
if 'send_at_now_plus_seconds' in local_var_params and local_var_params['send_at_now_plus_seconds'] is not None: # noqa: E501
query_params.append(('sendAtNowPlusSeconds', local_var_params['send_at_now_plus_seconds'])) # noqa: E501
if 'validate_before_enqueue' in local_var_params and local_var_params['validate_before_enqueue'] is not None: # noqa: E501
query_params.append(('validateBeforeEnqueue', local_var_params['validate_before_enqueue'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_email_options' in local_var_params:
body_params = local_var_params['send_email_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/with-schedule', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ScheduledJobDto', # 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 set_inbox_favourited(self, inbox_id, set_inbox_favourited_options, **kwargs): # noqa: E501
"""Set inbox favourited state # noqa: E501
Set and return new favourite state for an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_inbox_favourited(inbox_id, set_inbox_favourited_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of inbox to set favourite state (required)
:param SetInboxFavouritedOptions set_inbox_favourited_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: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, **kwargs) # noqa: E501
def set_inbox_favourited_with_http_info(self, inbox_id, set_inbox_favourited_options, **kwargs): # noqa: E501
"""Set inbox favourited state # noqa: E501
Set and return new favourite state for an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of inbox to set favourite state (required)
:param SetInboxFavouritedOptions set_inbox_favourited_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'set_inbox_favourited_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 set_inbox_favourited" % 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 `set_inbox_favourited`") # noqa: E501
# verify the required parameter 'set_inbox_favourited_options' is set
if self.api_client.client_side_validation and ('set_inbox_favourited_options' not in local_var_params or # noqa: E501
local_var_params['set_inbox_favourited_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `set_inbox_favourited_options` when calling `set_inbox_favourited`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'set_inbox_favourited_options' in local_var_params:
body_params = local_var_params['set_inbox_favourited_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/favourite', 'PUT',
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 update_inbox(self, inbox_id, update_inbox_options, **kwargs): # noqa: E501
"""Update Inbox. Change name and description. Email address is not editable. # noqa: E501
Update editable fields on an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_inbox(inbox_id, update_inbox_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param UpdateInboxOptions update_inbox_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: InboxDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.update_inbox_with_http_info(inbox_id, update_inbox_options, **kwargs) # noqa: E501
def update_inbox_with_http_info(self, inbox_id, update_inbox_options, **kwargs): # noqa: E501
"""Update Inbox. Change name and description. Email address is not editable. # noqa: E501
Update editable fields on an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_inbox_with_http_info(inbox_id, update_inbox_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param UpdateInboxOptions update_inbox_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'update_inbox_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 update_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 `update_inbox`") # noqa: E501
# verify the required parameter 'update_inbox_options' is set
if self.api_client.client_side_validation and ('update_inbox_options' not in local_var_params or # noqa: E501
local_var_params['update_inbox_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `update_inbox_options` when calling `update_inbox`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_inbox_options' in local_var_params:
body_params = local_var_params['update_inbox_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}', 'PATCH',
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)Classes
class InboxControllerApi (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 InboxControllerApi(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 cancel_scheduled_job(self, job_id, **kwargs): # noqa: E501 """Cancel a scheduled email job # noqa: E501 Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_scheduled_job(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_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: ScheduledJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.cancel_scheduled_job_with_http_info(job_id, **kwargs) # noqa: E501 def cancel_scheduled_job_with_http_info(self, job_id, **kwargs): # noqa: E501 """Cancel a scheduled email job # noqa: E501 Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_scheduled_job_with_http_info(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'job_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 cancel_scheduled_job" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'job_id' is set if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501 local_var_params['job_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `job_id` when calling `cancel_scheduled_job`") # noqa: E501 collection_formats = {} path_params = {} if 'job_id' in local_var_params: path_params['jobId'] = local_var_params['job_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/scheduled-jobs/{jobId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ScheduledJobDto', # 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_inbox(self, **kwargs): # noqa: E501 """Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. # noqa: E501 Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. :param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. :param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. :param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with :param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. :param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering :param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. :param int expires_in: Number of milliseconds that inbox should exist for :param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. :param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. :param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. :param bool use_short_address: Use a shorter email address under 31 characters :param str domain_id: ID of custom domain to use for email address. :param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. :param str prefix: Prefix to add before the email address for easier labelling or identification. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_inbox_with_http_info(**kwargs) # noqa: E501 def create_inbox_with_http_info(self, **kwargs): # noqa: E501 """Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. # noqa: E501 Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. :param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. :param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. :param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with :param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. :param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering :param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. :param int expires_in: Number of milliseconds that inbox should exist for :param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. :param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. :param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. :param bool use_short_address: Use a shorter email address under 31 characters :param str domain_id: ID of custom domain to use for email address. :param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. :param str prefix: Prefix to add before the email address for easier labelling or identification. :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 = [ 'email_address', 'tags', 'name', 'description', 'use_domain_pool', 'favourite', 'expires_at', 'expires_in', 'allow_team_access', 'inbox_type', 'virtual_inbox', 'use_short_address', 'domain_id', 'domain_name', '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_inbox" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 if '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 '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 '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 '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 '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 '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 '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 '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 '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_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 '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 '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( '/inboxes', '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_inbox_ruleset(self, inbox_id, create_inbox_ruleset_options, **kwargs): # noqa: E501 """Create an inbox ruleset # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset(inbox_id, create_inbox_ruleset_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: inboxId (required) :param CreateInboxRulesetOptions create_inbox_ruleset_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: InboxRulesetDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, **kwargs) # noqa: E501 def create_inbox_ruleset_with_http_info(self, inbox_id, create_inbox_ruleset_options, **kwargs): # noqa: E501 """Create an inbox ruleset # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: inboxId (required) :param CreateInboxRulesetOptions create_inbox_ruleset_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxRulesetDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'create_inbox_ruleset_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 create_inbox_ruleset" % 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 `create_inbox_ruleset`") # noqa: E501 # verify the required parameter 'create_inbox_ruleset_options' is set if self.api_client.client_side_validation and ('create_inbox_ruleset_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_ruleset_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_ruleset_options` when calling `create_inbox_ruleset`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_ruleset_options' in local_var_params: body_params = local_var_params['create_inbox_ruleset_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/rulesets', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRulesetDto', # 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_inbox_with_defaults(self, **kwargs): # noqa: E501 """Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_with_defaults_with_http_info(**kwargs) # noqa: E501 def create_inbox_with_defaults_with_http_info(self, **kwargs): # noqa: E501 """Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_inbox_with_defaults" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/withDefaults', '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_inbox_with_options(self, create_inbox_dto, **kwargs): # noqa: E501 """Create an inbox with options. Extended options for inbox creation. # noqa: E501 Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options(create_inbox_dto, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxDto create_inbox_dto: (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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_with_options_with_http_info(create_inbox_dto, **kwargs) # noqa: E501 def create_inbox_with_options_with_http_info(self, create_inbox_dto, **kwargs): # noqa: E501 """Create an inbox with options. Extended options for inbox creation. # noqa: E501 Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options_with_http_info(create_inbox_dto, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxDto create_inbox_dto: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_inbox_dto' ] 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_inbox_with_options" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_inbox_dto' is set if self.api_client.client_side_validation and ('create_inbox_dto' not in local_var_params or # noqa: E501 local_var_params['create_inbox_dto'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_dto` when calling `create_inbox_with_options`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_dto' in local_var_params: body_params = local_var_params['create_inbox_dto'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/withOptions', '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_all_inbox_emails(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in a given inboxes. # noqa: E501 Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inbox_emails(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_all_inbox_emails_with_http_info(inbox_id, **kwargs) # noqa: E501 def delete_all_inbox_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in a given inboxes. # noqa: E501 Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inbox_emails_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_all_inbox_emails" % 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_all_inbox_emails`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/deleteAllInboxEmails', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes(self, **kwargs): # noqa: E501 """Delete all inboxes # noqa: E501 Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_all_inboxes_with_http_info(**kwargs) # noqa: E501 def delete_all_inboxes_with_http_info(self, **kwargs): # noqa: E501 """Delete all inboxes # noqa: E501 Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes_by_description(self, description, **kwargs): # noqa: E501 """Delete inboxes by description # noqa: E501 Permanently delete all inboxes by description # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_description(description, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str description: (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_all_inboxes_by_description_with_http_info(description, **kwargs) # noqa: E501 def delete_all_inboxes_by_description_with_http_info(self, description, **kwargs): # noqa: E501 """Delete inboxes by description # noqa: E501 Permanently delete all inboxes by description # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_description_with_http_info(description, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str description: (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 = [ 'description' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes_by_description" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'description' is set if self.api_client.client_side_validation and ('description' not in local_var_params or # noqa: E501 local_var_params['description'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `description` when calling `delete_all_inboxes_by_description`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/by-description', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes_by_name(self, name, **kwargs): # noqa: E501 """Delete inboxes by name # noqa: E501 Permanently delete all inboxes by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_name(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (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_all_inboxes_by_name_with_http_info(name, **kwargs) # noqa: E501 def delete_all_inboxes_by_name_with_http_info(self, name, **kwargs): # noqa: E501 """Delete inboxes by name # noqa: E501 Permanently delete all inboxes by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_name_with_http_info(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (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 = [ 'name' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes_by_name" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'name' is set if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501 local_var_params['name'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `name` when calling `delete_all_inboxes_by_name`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/by-name', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes_by_tag(self, tag, **kwargs): # noqa: E501 """Delete inboxes by tag # noqa: E501 Permanently delete all inboxes by tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_tag(tag, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str tag: (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_all_inboxes_by_tag_with_http_info(tag, **kwargs) # noqa: E501 def delete_all_inboxes_by_tag_with_http_info(self, tag, **kwargs): # noqa: E501 """Delete inboxes by tag # noqa: E501 Permanently delete all inboxes by tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_tag_with_http_info(tag, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str tag: (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 = [ 'tag' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes_by_tag" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'tag' is set if self.api_client.client_side_validation and ('tag' not in local_var_params or # noqa: E501 local_var_params['tag'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `tag` when calling `delete_all_inboxes_by_tag`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501 query_params.append(('tag', local_var_params['tag'])) # 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( '/inboxes/by-tag', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_inbox(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox # noqa: E501 Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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.delete_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501 def delete_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox # noqa: E501 Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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 delete_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 `delete_inbox`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', '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 does_inbox_exist(self, email_address, **kwargs): # noqa: E501 """Does inbox exist # noqa: E501 Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.does_inbox_exist(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: Email address (required) :param bool allow_catch_all: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxExistsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.does_inbox_exist_with_http_info(email_address, **kwargs) # noqa: E501 def does_inbox_exist_with_http_info(self, email_address, **kwargs): # noqa: E501 """Does inbox exist # noqa: E501 Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.does_inbox_exist_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: Email address (required) :param bool allow_catch_all: :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(InboxExistsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address', 'allow_catch_all' ] 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 does_inbox_exist" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `does_inbox_exist`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 if 'allow_catch_all' in local_var_params and local_var_params['allow_catch_all'] is not None: # noqa: E501 query_params.append(('allowCatchAll', local_var_params['allow_catch_all'])) # 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( '/inboxes/exists', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxExistsDto', # 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 flush_expired(self, **kwargs): # noqa: E501 """Remove expired inboxes # noqa: E501 Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.flush_expired(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: FlushExpiredInboxesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.flush_expired_with_http_info(**kwargs) # noqa: E501 def flush_expired_with_http_info(self, **kwargs): # noqa: E501 """Remove expired inboxes # noqa: E501 Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.flush_expired_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(FlushExpiredInboxesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method flush_expired" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/expired', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='FlushExpiredInboxesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_inboxes(self, **kwargs): # noqa: E501 """List All Inboxes Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inboxes_with_http_info(**kwargs) # noqa: E501 def get_all_inboxes_with_http_info(self, **kwargs): # noqa: E501 """List All Inboxes Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'favourite', 'search', 'tag', 'team_access', 'since', 'before', 'inbox_type', 'inbox_function', 'domain_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if '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 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501 query_params.append(('search', local_var_params['search'])) # noqa: E501 if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501 query_params.append(('tag', local_var_params['tag'])) # noqa: E501 if 'team_access' in local_var_params and local_var_params['team_access'] is not None: # noqa: E501 query_params.append(('teamAccess', local_var_params['team_access'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 'inbox_function' in local_var_params and local_var_params['inbox_function'] is not None: # noqa: E501 query_params.append(('inboxFunction', local_var_params['inbox_function'])) # 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 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( '/inboxes/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_inboxes_offset_paginated(self, **kwargs): # noqa: E501 """List All Inboxes Offset Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes_offset_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inboxes_offset_paginated_with_http_info(**kwargs) # noqa: E501 def get_all_inboxes_offset_paginated_with_http_info(self, **kwargs): # noqa: E501 """List All Inboxes Offset Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes_offset_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'favourite', 'search', 'tag', 'team_access', 'since', 'before', 'inbox_type', 'inbox_function', 'domain_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_inboxes_offset_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if '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 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501 query_params.append(('search', local_var_params['search'])) # noqa: E501 if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501 query_params.append(('tag', local_var_params['tag'])) # noqa: E501 if 'team_access' in local_var_params and local_var_params['team_access'] is not None: # noqa: E501 query_params.append(('teamAccess', local_var_params['team_access'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 'inbox_function' in local_var_params and local_var_params['inbox_function'] is not None: # noqa: E501 query_params.append(('inboxFunction', local_var_params['inbox_function'])) # 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 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( '/inboxes/offset-paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_scheduled_jobs(self, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for account # noqa: E501 Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_scheduled_jobs(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageScheduledJobs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_scheduled_jobs_with_http_info(**kwargs) # noqa: E501 def get_all_scheduled_jobs_with_http_info(self, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for account # noqa: E501 Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_scheduled_jobs_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_scheduled_jobs" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/scheduled-jobs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageScheduledJobs', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_delivery_statuses_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501 """get_delivery_statuses_by_inbox_id # noqa: E501 Get all email delivery statuses for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_delivery_statuses_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in delivery status list pagination :param int size: Optional page size in delivery status list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageDeliveryStatus If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_delivery_statuses_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """get_delivery_statuses_by_inbox_id # noqa: E501 Get all email delivery statuses for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in delivery status list pagination :param int size: Optional page size in delivery status list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageDeliveryStatus, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_delivery_statuses_by_inbox_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_delivery_statuses_by_inbox_id`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/delivery-status', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageDeliveryStatus', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_emails(self, inbox_id, **kwargs): # noqa: E501 """Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501 List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int size: Alias for limit. Assessed first before assessing any passed limit. :param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller :param str sort: Sort the results by received date and direction ASC or DESC :param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned :param int delay_timeout: :param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. :param bool unread_only: :param datetime before: Exclude emails received after this ISO 8601 date time :param datetime since: Exclude emails received before this ISO 8601 date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[EmailPreview] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_emails_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501 List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int size: Alias for limit. Assessed first before assessing any passed limit. :param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller :param str sort: Sort the results by received date and direction ASC or DESC :param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned :param int delay_timeout: :param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. :param bool unread_only: :param datetime before: Exclude emails received after this ISO 8601 date time :param datetime since: Exclude emails received before this ISO 8601 date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[EmailPreview], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'size', 'limit', 'sort', 'retry_timeout', 'delay_timeout', 'min_count', 'unread_only', 'before', 'since' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_emails`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_emails`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `limit` when calling `get_emails`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 query_params.append(('limit', local_var_params['limit'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'retry_timeout' in local_var_params and local_var_params['retry_timeout'] is not None: # noqa: E501 query_params.append(('retryTimeout', local_var_params['retry_timeout'])) # noqa: E501 if 'delay_timeout' in local_var_params and local_var_params['delay_timeout'] is not None: # noqa: E501 query_params.append(('delayTimeout', local_var_params['delay_timeout'])) # noqa: E501 if 'min_count' in local_var_params and local_var_params['min_count'] is not None: # noqa: E501 query_params.append(('minCount', local_var_params['min_count'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 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( '/inboxes/{inboxId}/emails', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[EmailPreview]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_imap_smtp_access(self, **kwargs): # noqa: E501 """get_imap_smtp_access # noqa: E501 Get IMAP and SMTP access usernames and passwords # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_imap_smtp_access(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapSmtpAccessDetails If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_imap_smtp_access_with_http_info(**kwargs) # noqa: E501 def get_imap_smtp_access_with_http_info(self, **kwargs): # noqa: E501 """get_imap_smtp_access # noqa: E501 Get IMAP and SMTP access usernames and passwords # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_imap_smtp_access_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapSmtpAccessDetails, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_imap_smtp_access" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/imap-smtp-access', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapSmtpAccessDetails', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox. Returns properties of an inbox. # noqa: E501 Returns an inbox's properties, including its email address and ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox. Returns properties of an inbox. # noqa: E501 Returns an inbox's properties, including its email address and ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_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: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_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 `get_inbox`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', 'GET', 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 get_inbox_by_email_address(self, email_address, **kwargs): # noqa: E501 """Search for an inbox with the provided email address # noqa: E501 Get a inbox result by email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (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: InboxByEmailAddressResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_by_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_inbox_by_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """Search for an inbox with the provided email address # noqa: E501 Get a inbox result by email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param _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(InboxByEmailAddressResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_by_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `get_inbox_by_email_address`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 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( '/inboxes/byEmailAddress', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxByEmailAddressResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_by_name(self, name, **kwargs): # noqa: E501 """Search for an inbox with the given name # noqa: E501 Get a inbox result by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_name(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (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: InboxByNameResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_by_name_with_http_info(name, **kwargs) # noqa: E501 def get_inbox_by_name_with_http_info(self, name, **kwargs): # noqa: E501 """Search for an inbox with the given name # noqa: E501 Get a inbox result by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_name_with_http_info(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxByNameResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'name' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_by_name" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'name' is set if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501 local_var_params['name'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `name` when calling `get_inbox_by_name`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 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( '/inboxes/byName', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxByNameResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_count(self, **kwargs): # noqa: E501 """Get total inbox count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_count_with_http_info(**kwargs) # noqa: E501 def get_inbox_count_with_http_info(self, **kwargs): # noqa: E501 """Get total inbox count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_email_count(self, inbox_id, **kwargs): # noqa: E501 """Get email count in inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_email_count(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (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: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_email_count_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_email_count_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get email count in inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_email_count_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_email_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_email_count`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/emails/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_emails_paginated(self, inbox_id, **kwargs): # noqa: E501 """Get inbox emails paginated # noqa: E501 Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_emails_paginated(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int page: Optional page index in inbox emails list pagination :param int size: Optional page size in inbox emails list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by received after given date time :param datetime before: Optional filter by received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailPreview If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_emails_paginated_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_emails_paginated_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get inbox emails paginated # noqa: E501 Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_emails_paginated_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int page: Optional page index in inbox emails list pagination :param int size: Optional page size in inbox emails list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by received after given date time :param datetime before: Optional filter by received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_emails_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_emails_paginated`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/emails/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailPreview', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_ids(self, **kwargs): # noqa: E501 """Get all inbox IDs # noqa: E501 Get list of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_ids(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxIdsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_ids_with_http_info(**kwargs) # noqa: E501 def get_inbox_ids_with_http_info(self, **kwargs): # noqa: E501 """Get all inbox IDs # noqa: E501 Get list of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_ids_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxIdsResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_ids" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/ids', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxIdsResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_sent_emails(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox Sent Emails # noqa: E501 Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_sent_emails(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox sent email list pagination :param int size: Optional page size in inbox sent email list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional sent email search :param datetime since: Optional filter by sent after given date time :param datetime before: Optional filter by sent before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageSentEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_sent_emails_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_sent_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox Sent Emails # noqa: E501 Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_sent_emails_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox sent email list pagination :param int size: Optional page size in inbox sent email list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional sent email search :param datetime since: Optional filter by sent after given date time :param datetime before: Optional filter by sent before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageSentEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_sent_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_sent_emails`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/sent', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageSentEmailProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_tags(self, **kwargs): # noqa: E501 """Get inbox tags # noqa: E501 Get all inbox tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_tags(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[str] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_tags_with_http_info(**kwargs) # noqa: E501 def get_inbox_tags_with_http_info(self, **kwargs): # noqa: E501 """Get inbox tags # noqa: E501 Get all inbox tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_tags_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[str], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_tags" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/tags', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[str]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inboxes(self, **kwargs): # noqa: E501 """List Inboxes and email addresses # noqa: E501 List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by created after given date time :param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[InboxDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inboxes_with_http_info(**kwargs) # noqa: E501 def get_inboxes_with_http_info(self, **kwargs): # noqa: E501 """List Inboxes and email addresses # noqa: E501 List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by created after given date time :param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[InboxDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'size', 'sort', 'since', 'exclude_catch_all_inboxes', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_inboxes`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'exclude_catch_all_inboxes' in local_var_params and local_var_params['exclude_catch_all_inboxes'] is not None: # noqa: E501 query_params.append(('excludeCatchAllInboxes', local_var_params['exclude_catch_all_inboxes'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[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 get_latest_email_in_inbox(self, inbox_id, timeout_millis, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in an inbox or wait for one to arrive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox(inbox_id, timeout_millis, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param int timeout_millis: Timeout milliseconds to wait for latest email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, **kwargs) # noqa: E501 def get_latest_email_in_inbox_with_http_info(self, inbox_id, timeout_millis, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in an inbox or wait for one to arrive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param int timeout_millis: Timeout milliseconds to wait for latest email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'timeout_millis' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_latest_email_in_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 `get_latest_email_in_inbox`") # noqa: E501 # verify the required parameter 'timeout_millis' is set if self.api_client.client_side_validation and ('timeout_millis' not in local_var_params or # noqa: E501 local_var_params['timeout_millis'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `timeout_millis` when calling `get_latest_email_in_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 if 'timeout_millis' in local_var_params and local_var_params['timeout_millis'] is not None: # noqa: E501 query_params.append(('timeoutMillis', local_var_params['timeout_millis'])) # 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( '/inboxes/getLatestEmail', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_organization_inboxes(self, **kwargs): # noqa: E501 """List Organization Inboxes Paginated # noqa: E501 List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageOrganizationInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_organization_inboxes_with_http_info(**kwargs) # noqa: E501 def get_organization_inboxes_with_http_info(self, **kwargs): # noqa: E501 """List Organization Inboxes Paginated # noqa: E501 List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageOrganizationInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_organization_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/organization', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageOrganizationInboxProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_scheduled_job(self, job_id, **kwargs): # noqa: E501 """Get a scheduled email job # noqa: E501 Get a scheduled email job details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_job(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_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: ScheduledJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_scheduled_job_with_http_info(job_id, **kwargs) # noqa: E501 def get_scheduled_job_with_http_info(self, job_id, **kwargs): # noqa: E501 """Get a scheduled email job # noqa: E501 Get a scheduled email job details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_job_with_http_info(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'job_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_scheduled_job" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'job_id' is set if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501 local_var_params['job_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `job_id` when calling `get_scheduled_job`") # noqa: E501 collection_formats = {} path_params = {} if 'job_id' in local_var_params: path_params['jobId'] = local_var_params['job_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/scheduled-jobs/{jobId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ScheduledJobDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_scheduled_jobs_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for the inbox # noqa: E501 Schedule sending of emails using scheduled jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_jobs_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageScheduledJobs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_scheduled_jobs_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for the inbox # noqa: E501 Schedule sending of emails using scheduled jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_scheduled_jobs_by_inbox_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_scheduled_jobs_by_inbox_id`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/scheduled-jobs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageScheduledJobs', # 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 list_inbox_rulesets(self, inbox_id, **kwargs): # noqa: E501 """List inbox rulesets # noqa: E501 List all rulesets attached to an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_rulesets(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox ruleset list pagination :param int size: Optional page size in inbox ruleset list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxRulesetDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.list_inbox_rulesets_with_http_info(inbox_id, **kwargs) # noqa: E501 def list_inbox_rulesets_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """List inbox rulesets # noqa: E501 List all rulesets attached to an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_rulesets_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox ruleset list pagination :param int size: Optional page size in inbox ruleset list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxRulesetDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method list_inbox_rulesets" % 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 `list_inbox_rulesets`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/rulesets', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxRulesetDto', # 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 list_inbox_tracking_pixels(self, inbox_id, **kwargs): # noqa: E501 """List inbox tracking pixels # noqa: E501 List all tracking pixels sent from an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_tracking_pixels(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox tracking pixel list pagination :param int size: Optional page size in inbox tracking pixel list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageTrackingPixelProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.list_inbox_tracking_pixels_with_http_info(inbox_id, **kwargs) # noqa: E501 def list_inbox_tracking_pixels_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """List inbox tracking pixels # noqa: E501 List all tracking pixels sent from an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_tracking_pixels_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox tracking pixel list pagination :param int size: Optional page size in inbox tracking pixel list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageTrackingPixelProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method list_inbox_tracking_pixels" % 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 `list_inbox_tracking_pixels`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/tracking-pixels', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageTrackingPixelProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def search_inboxes(self, search_inboxes_options, **kwargs): # noqa: E501 """Search all inboxes and return matching inboxes # noqa: E501 Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_inboxes(search_inboxes_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchInboxesOptions search_inboxes_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: PageInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.search_inboxes_with_http_info(search_inboxes_options, **kwargs) # noqa: E501 def search_inboxes_with_http_info(self, search_inboxes_options, **kwargs): # noqa: E501 """Search all inboxes and return matching inboxes # noqa: E501 Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_inboxes_with_http_info(search_inboxes_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchInboxesOptions search_inboxes_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'search_inboxes_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method search_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'search_inboxes_options' is set if self.api_client.client_side_validation and ('search_inboxes_options' not in local_var_params or # noqa: E501 local_var_params['search_inboxes_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `search_inboxes_options` when calling `search_inboxes`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'search_inboxes_options' in local_var_params: body_params = local_var_params['search_inboxes_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/search', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxProjection', # 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(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send Email # noqa: E501 Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. # 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(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def send_email_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send Email # noqa: E501 Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. # 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_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email" % 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 `send_email`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', '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_and_confirm(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email and return sent confirmation # noqa: E501 Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_and_confirm_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def send_email_and_confirm_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email and return sent confirmation # noqa: E501 Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email_and_confirm" % 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 `send_email_and_confirm`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_and_confirm`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/confirm', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_email_with_queue(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs): # noqa: E501 """Send email with queue # noqa: E501 Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue(inbox_id, validate_before_enqueue, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param bool validate_before_enqueue: Validate before adding to queue (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, **kwargs) # noqa: E501 def send_email_with_queue_with_http_info(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs): # noqa: E501 """Send email with queue # noqa: E501 Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param bool validate_before_enqueue: Validate before adding to queue (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'validate_before_enqueue', '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_with_queue" % 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 `send_email_with_queue`") # noqa: E501 # verify the required parameter 'validate_before_enqueue' is set if self.api_client.client_side_validation and ('validate_before_enqueue' not in local_var_params or # noqa: E501 local_var_params['validate_before_enqueue'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `validate_before_enqueue` when calling `send_email_with_queue`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_with_queue`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'validate_before_enqueue' in local_var_params and local_var_params['validate_before_enqueue'] is not None: # noqa: E501 query_params.append(('validateBeforeEnqueue', local_var_params['validate_before_enqueue'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/with-queue', '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_smtp_envelope(self, inbox_id, send_smtp_envelope_options, **kwargs): # noqa: E501 """Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501 Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_smtp_envelope(inbox_id, send_smtp_envelope_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, **kwargs) # noqa: E501 def send_smtp_envelope_with_http_info(self, inbox_id, send_smtp_envelope_options, **kwargs): # noqa: E501 """Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501 Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_smtp_envelope_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_smtp_envelope" % 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 `send_smtp_envelope`") # noqa: E501 # verify the required parameter 'send_smtp_envelope_options' is set if self.api_client.client_side_validation and ('send_smtp_envelope_options' not in local_var_params or # noqa: E501 local_var_params['send_smtp_envelope_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_smtp_envelope_options` when calling `send_smtp_envelope`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_smtp_envelope_options' in local_var_params: body_params = local_var_params['send_smtp_envelope_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/smtp-envelope', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_test_email(self, inbox_id, **kwargs): # noqa: E501 """Send a test email to inbox # noqa: E501 Send an inbox a test email to test email receiving is working # 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_test_email(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.send_test_email_with_http_info(inbox_id, **kwargs) # noqa: E501 def send_test_email_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Send a test email to inbox # noqa: E501 Send an inbox a test email to test email receiving is working # 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_test_email_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 send_test_email" % 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 `send_test_email`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/send-test-email', '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_with_schedule(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email with with delay or schedule # noqa: E501 Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param datetime send_at_timestamp: Sending timestamp :param int send_at_now_plus_seconds: Send after n seconds :param bool validate_before_enqueue: Validate before adding to queue :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ScheduledJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_with_schedule_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def send_with_schedule_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email with with delay or schedule # noqa: E501 Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param datetime send_at_timestamp: Sending timestamp :param int send_at_now_plus_seconds: Send after n seconds :param bool validate_before_enqueue: Validate before adding to queue :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(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options', 'send_at_timestamp', 'send_at_now_plus_seconds', 'validate_before_enqueue' ] 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_with_schedule" % 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 `send_with_schedule`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_with_schedule`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'send_at_timestamp' in local_var_params and local_var_params['send_at_timestamp'] is not None: # noqa: E501 query_params.append(('sendAtTimestamp', local_var_params['send_at_timestamp'])) # noqa: E501 if 'send_at_now_plus_seconds' in local_var_params and local_var_params['send_at_now_plus_seconds'] is not None: # noqa: E501 query_params.append(('sendAtNowPlusSeconds', local_var_params['send_at_now_plus_seconds'])) # noqa: E501 if 'validate_before_enqueue' in local_var_params and local_var_params['validate_before_enqueue'] is not None: # noqa: E501 query_params.append(('validateBeforeEnqueue', local_var_params['validate_before_enqueue'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/with-schedule', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ScheduledJobDto', # 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 set_inbox_favourited(self, inbox_id, set_inbox_favourited_options, **kwargs): # noqa: E501 """Set inbox favourited state # noqa: E501 Set and return new favourite state for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_inbox_favourited(inbox_id, set_inbox_favourited_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox to set favourite state (required) :param SetInboxFavouritedOptions set_inbox_favourited_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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, **kwargs) # noqa: E501 def set_inbox_favourited_with_http_info(self, inbox_id, set_inbox_favourited_options, **kwargs): # noqa: E501 """Set inbox favourited state # noqa: E501 Set and return new favourite state for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox to set favourite state (required) :param SetInboxFavouritedOptions set_inbox_favourited_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'set_inbox_favourited_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 set_inbox_favourited" % 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 `set_inbox_favourited`") # noqa: E501 # verify the required parameter 'set_inbox_favourited_options' is set if self.api_client.client_side_validation and ('set_inbox_favourited_options' not in local_var_params or # noqa: E501 local_var_params['set_inbox_favourited_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `set_inbox_favourited_options` when calling `set_inbox_favourited`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'set_inbox_favourited_options' in local_var_params: body_params = local_var_params['set_inbox_favourited_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/favourite', 'PUT', 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 update_inbox(self, inbox_id, update_inbox_options, **kwargs): # noqa: E501 """Update Inbox. Change name and description. Email address is not editable. # noqa: E501 Update editable fields on an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_inbox(inbox_id, update_inbox_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param UpdateInboxOptions update_inbox_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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_inbox_with_http_info(inbox_id, update_inbox_options, **kwargs) # noqa: E501 def update_inbox_with_http_info(self, inbox_id, update_inbox_options, **kwargs): # noqa: E501 """Update Inbox. Change name and description. Email address is not editable. # noqa: E501 Update editable fields on an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_inbox_with_http_info(inbox_id, update_inbox_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param UpdateInboxOptions update_inbox_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'update_inbox_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 update_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 `update_inbox`") # noqa: E501 # verify the required parameter 'update_inbox_options' is set if self.api_client.client_side_validation and ('update_inbox_options' not in local_var_params or # noqa: E501 local_var_params['update_inbox_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_inbox_options` when calling `update_inbox`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_inbox_options' in local_var_params: body_params = local_var_params['update_inbox_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', 'PATCH', 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)Methods
def cancel_scheduled_job(self, job_id, **kwargs)-
Cancel a scheduled email job # noqa: E501
Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_scheduled_job(job_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str job_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: ScheduledJobDto If the method is called asynchronously, returns the request thread.
Expand source code
def cancel_scheduled_job(self, job_id, **kwargs): # noqa: E501 """Cancel a scheduled email job # noqa: E501 Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_scheduled_job(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_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: ScheduledJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.cancel_scheduled_job_with_http_info(job_id, **kwargs) # noqa: E501 def cancel_scheduled_job_with_http_info(self, job_id, **kwargs)-
Cancel a scheduled email job # noqa: E501
Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_scheduled_job_with_http_info(job_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str job_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def cancel_scheduled_job_with_http_info(self, job_id, **kwargs): # noqa: E501 """Cancel a scheduled email job # noqa: E501 Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_scheduled_job_with_http_info(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'job_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 cancel_scheduled_job" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'job_id' is set if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501 local_var_params['job_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `job_id` when calling `cancel_scheduled_job`") # noqa: E501 collection_formats = {} path_params = {} if 'job_id' in local_var_params: path_params['jobId'] = local_var_params['job_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/scheduled-jobs/{jobId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ScheduledJobDto', # 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_inbox(self, **kwargs)-
Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either
SMTPorHTTPinboxes. # noqa: E501Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as
123@mailslurp.com. If you use theuseDomainPooloption when the email address is null it will generate an email address with a more varied domain ending such as123@mailslurp.infoor123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - soSMTPinboxes will only work withSMTPtype domains. AvoidSMTPinboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. :param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. :param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. :param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with :param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default@mailslurp.comemail addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in@mailslurp.{world,info,xyz,...}. This means a TLD is randomly selecting from a list of.biz,.info,.xyzetc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of@mailslurp.comor custom email address provided by the emailAddress field. Note this feature is only available forHTTPinbox types. :param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering :param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. :param int expires_in: Number of milliseconds that inbox should exist for :param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. :param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running atmx.mailslurp.com. :param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. :param bool use_short_address: Use a shorter email address under 31 characters :param str domain_id: ID of custom domain to use for email address. :param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use theemailAddressoption instead to specify the full custom inbox. :param str prefix: Prefix to add before the email address for easier labelling or identification. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_inbox(self, **kwargs): # noqa: E501 """Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. # noqa: E501 Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. :param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. :param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. :param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with :param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. :param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering :param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. :param int expires_in: Number of milliseconds that inbox should exist for :param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. :param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. :param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. :param bool use_short_address: Use a shorter email address under 31 characters :param str domain_id: ID of custom domain to use for email address. :param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. :param str prefix: Prefix to add before the email address for easier labelling or identification. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_inbox_with_http_info(**kwargs) # noqa: E501 def create_inbox_ruleset(self, inbox_id, create_inbox_ruleset_options, **kwargs)-
Create an inbox ruleset # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset(inbox_id, create_inbox_ruleset_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: inboxId (required) :param CreateInboxRulesetOptions create_inbox_ruleset_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: InboxRulesetDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_inbox_ruleset(self, inbox_id, create_inbox_ruleset_options, **kwargs): # noqa: E501 """Create an inbox ruleset # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset(inbox_id, create_inbox_ruleset_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: inboxId (required) :param CreateInboxRulesetOptions create_inbox_ruleset_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: InboxRulesetDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, **kwargs) # noqa: E501 def create_inbox_ruleset_with_http_info(self, inbox_id, create_inbox_ruleset_options, **kwargs)-
Create an inbox ruleset # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: inboxId (required) :param CreateInboxRulesetOptions create_inbox_ruleset_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxRulesetDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_inbox_ruleset_with_http_info(self, inbox_id, create_inbox_ruleset_options, **kwargs): # noqa: E501 """Create an inbox ruleset # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: inboxId (required) :param CreateInboxRulesetOptions create_inbox_ruleset_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxRulesetDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'create_inbox_ruleset_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 create_inbox_ruleset" % 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 `create_inbox_ruleset`") # noqa: E501 # verify the required parameter 'create_inbox_ruleset_options' is set if self.api_client.client_side_validation and ('create_inbox_ruleset_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_ruleset_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_ruleset_options` when calling `create_inbox_ruleset`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_ruleset_options' in local_var_params: body_params = local_var_params['create_inbox_ruleset_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/rulesets', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRulesetDto', # 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_inbox_with_defaults(self, **kwargs)-
Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_inbox_with_defaults(self, **kwargs): # noqa: E501 """Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_with_defaults_with_http_info(**kwargs) # noqa: E501 def create_inbox_with_defaults_with_http_info(self, **kwargs)-
Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_inbox_with_defaults_with_http_info(self, **kwargs): # noqa: E501 """Create an inbox with default options. Uses MailSlurp domain pool address and is private. # 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_inbox_with_defaults_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_inbox_with_defaults" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/withDefaults', '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_inbox_with_http_info(self, **kwargs)-
Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either
SMTPorHTTPinboxes. # noqa: E501Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as
123@mailslurp.com. If you use theuseDomainPooloption when the email address is null it will generate an email address with a more varied domain ending such as123@mailslurp.infoor123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - soSMTPinboxes will only work withSMTPtype domains. AvoidSMTPinboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. :param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. :param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. :param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with :param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default@mailslurp.comemail addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in@mailslurp.{world,info,xyz,...}. This means a TLD is randomly selecting from a list of.biz,.info,.xyzetc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of@mailslurp.comor custom email address provided by the emailAddress field. Note this feature is only available forHTTPinbox types. :param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering :param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. :param int expires_in: Number of milliseconds that inbox should exist for :param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. :param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running atmx.mailslurp.com. :param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. :param bool use_short_address: Use a shorter email address under 31 characters :param str domain_id: ID of custom domain to use for email address. :param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use theemailAddressoption instead to specify the full custom inbox. :param str prefix: Prefix to add before the email address for easier labelling or identification. :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_inbox_with_http_info(self, **kwargs): # noqa: E501 """Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. # noqa: E501 Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. # 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_inbox_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. :param list[str] tags: Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. :param str name: Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. :param str description: Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with :param bool use_domain_pool: Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. :param bool favourite: Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering :param datetime expires_at: Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. :param int expires_in: Number of milliseconds that inbox should exist for :param bool allow_team_access: DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. :param str inbox_type: HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. :param bool virtual_inbox: Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. :param bool use_short_address: Use a shorter email address under 31 characters :param str domain_id: ID of custom domain to use for email address. :param str domain_name: FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. :param str prefix: Prefix to add before the email address for easier labelling or identification. :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 = [ 'email_address', 'tags', 'name', 'description', 'use_domain_pool', 'favourite', 'expires_at', 'expires_in', 'allow_team_access', 'inbox_type', 'virtual_inbox', 'use_short_address', 'domain_id', 'domain_name', '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_inbox" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 if '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 '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 '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 '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 '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 '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 '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 '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 '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_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 '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 '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( '/inboxes', '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_inbox_with_options(self, create_inbox_dto, **kwargs)-
Create an inbox with options. Extended options for inbox creation. # noqa: E501
Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options(create_inbox_dto, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxDto create_inbox_dto: (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: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_inbox_with_options(self, create_inbox_dto, **kwargs): # noqa: E501 """Create an inbox with options. Extended options for inbox creation. # noqa: E501 Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options(create_inbox_dto, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxDto create_inbox_dto: (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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_with_options_with_http_info(create_inbox_dto, **kwargs) # noqa: E501 def create_inbox_with_options_with_http_info(self, create_inbox_dto, **kwargs)-
Create an inbox with options. Extended options for inbox creation. # noqa: E501
Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options_with_http_info(create_inbox_dto, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxDto create_inbox_dto: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_inbox_with_options_with_http_info(self, create_inbox_dto, **kwargs): # noqa: E501 """Create an inbox with options. Extended options for inbox creation. # noqa: E501 Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. # 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_inbox_with_options_with_http_info(create_inbox_dto, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxDto create_inbox_dto: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_inbox_dto' ] 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_inbox_with_options" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_inbox_dto' is set if self.api_client.client_side_validation and ('create_inbox_dto' not in local_var_params or # noqa: E501 local_var_params['create_inbox_dto'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_dto` when calling `create_inbox_with_options`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_dto' in local_var_params: body_params = local_var_params['create_inbox_dto'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/withOptions', '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_all_inbox_emails(self, inbox_id, **kwargs)-
Delete all emails in a given inboxes. # noqa: E501
Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inbox_emails(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_all_inbox_emails(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in a given inboxes. # noqa: E501 Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inbox_emails(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_all_inbox_emails_with_http_info(inbox_id, **kwargs) # noqa: E501 def delete_all_inbox_emails_with_http_info(self, inbox_id, **kwargs)-
Delete all emails in a given inboxes. # noqa: E501
Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inbox_emails_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_all_inbox_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete all emails in a given inboxes. # noqa: E501 Deletes all emails in an inbox. Be careful as emails cannot be recovered # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inbox_emails_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_all_inbox_emails" % 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_all_inbox_emails`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/deleteAllInboxEmails', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes(self, **kwargs)-
Delete all inboxes # noqa: E501
Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_all_inboxes(self, **kwargs): # noqa: E501 """Delete all inboxes # noqa: E501 Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_all_inboxes_with_http_info(**kwargs) # noqa: E501 def delete_all_inboxes_by_description(self, description, **kwargs)-
Delete inboxes by description # noqa: E501
Permanently delete all inboxes by description # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_description(description, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str description: (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_all_inboxes_by_description(self, description, **kwargs): # noqa: E501 """Delete inboxes by description # noqa: E501 Permanently delete all inboxes by description # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_description(description, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str description: (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_all_inboxes_by_description_with_http_info(description, **kwargs) # noqa: E501 def delete_all_inboxes_by_description_with_http_info(self, description, **kwargs)-
Delete inboxes by description # noqa: E501
Permanently delete all inboxes by description # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_description_with_http_info(description, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str description: (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_all_inboxes_by_description_with_http_info(self, description, **kwargs): # noqa: E501 """Delete inboxes by description # noqa: E501 Permanently delete all inboxes by description # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_description_with_http_info(description, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str description: (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 = [ 'description' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes_by_description" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'description' is set if self.api_client.client_side_validation and ('description' not in local_var_params or # noqa: E501 local_var_params['description'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `description` when calling `delete_all_inboxes_by_description`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/by-description', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes_by_name(self, name, **kwargs)-
Delete inboxes by name # noqa: E501
Permanently delete all inboxes by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_name(name, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str name: (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_all_inboxes_by_name(self, name, **kwargs): # noqa: E501 """Delete inboxes by name # noqa: E501 Permanently delete all inboxes by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_name(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (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_all_inboxes_by_name_with_http_info(name, **kwargs) # noqa: E501 def delete_all_inboxes_by_name_with_http_info(self, name, **kwargs)-
Delete inboxes by name # noqa: E501
Permanently delete all inboxes by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_name_with_http_info(name, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str name: (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_all_inboxes_by_name_with_http_info(self, name, **kwargs): # noqa: E501 """Delete inboxes by name # noqa: E501 Permanently delete all inboxes by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_name_with_http_info(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (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 = [ 'name' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes_by_name" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'name' is set if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501 local_var_params['name'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `name` when calling `delete_all_inboxes_by_name`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/by-name', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes_by_tag(self, tag, **kwargs)-
Delete inboxes by tag # noqa: E501
Permanently delete all inboxes by tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_tag(tag, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str tag: (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_all_inboxes_by_tag(self, tag, **kwargs): # noqa: E501 """Delete inboxes by tag # noqa: E501 Permanently delete all inboxes by tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_tag(tag, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str tag: (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_all_inboxes_by_tag_with_http_info(tag, **kwargs) # noqa: E501 def delete_all_inboxes_by_tag_with_http_info(self, tag, **kwargs)-
Delete inboxes by tag # noqa: E501
Permanently delete all inboxes by tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_by_tag_with_http_info(tag, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str tag: (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_all_inboxes_by_tag_with_http_info(self, tag, **kwargs): # noqa: E501 """Delete inboxes by tag # noqa: E501 Permanently delete all inboxes by tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_by_tag_with_http_info(tag, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str tag: (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 = [ 'tag' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes_by_tag" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'tag' is set if self.api_client.client_side_validation and ('tag' not in local_var_params or # noqa: E501 local_var_params['tag'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `tag` when calling `delete_all_inboxes_by_tag`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501 query_params.append(('tag', local_var_params['tag'])) # 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( '/inboxes/by-tag', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_inboxes_with_http_info(self, **kwargs)-
Delete all inboxes # noqa: E501
Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_inboxes_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def delete_all_inboxes_with_http_info(self, **kwargs): # noqa: E501 """Delete all inboxes # noqa: E501 Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_inbox(self, inbox_id, **kwargs)-
Delete inbox # noqa: E501
Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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 delete_inbox(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox # noqa: E501 Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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.delete_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501 def delete_inbox_with_http_info(self, inbox_id, **kwargs)-
Delete inbox # noqa: E501
Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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 delete_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Delete inbox # noqa: E501 Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. # 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_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 delete_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 `delete_inbox`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', '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 does_inbox_exist(self, email_address, **kwargs)-
Does inbox exist # noqa: E501
Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.does_inbox_exist(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: Email address (required) :param bool allow_catch_all: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxExistsDto If the method is called asynchronously, returns the request thread.
Expand source code
def does_inbox_exist(self, email_address, **kwargs): # noqa: E501 """Does inbox exist # noqa: E501 Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.does_inbox_exist(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: Email address (required) :param bool allow_catch_all: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxExistsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.does_inbox_exist_with_http_info(email_address, **kwargs) # noqa: E501 def does_inbox_exist_with_http_info(self, email_address, **kwargs)-
Does inbox exist # noqa: E501
Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.does_inbox_exist_with_http_info(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: Email address (required) :param bool allow_catch_all: :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(InboxExistsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def does_inbox_exist_with_http_info(self, email_address, **kwargs): # noqa: E501 """Does inbox exist # noqa: E501 Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.does_inbox_exist_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: Email address (required) :param bool allow_catch_all: :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(InboxExistsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address', 'allow_catch_all' ] 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 does_inbox_exist" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `does_inbox_exist`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 if 'allow_catch_all' in local_var_params and local_var_params['allow_catch_all'] is not None: # noqa: E501 query_params.append(('allowCatchAll', local_var_params['allow_catch_all'])) # 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( '/inboxes/exists', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxExistsDto', # 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 flush_expired(self, **kwargs)-
Remove expired inboxes # noqa: E501
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.flush_expired(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: FlushExpiredInboxesResult If the method is called asynchronously, returns the request thread.
Expand source code
def flush_expired(self, **kwargs): # noqa: E501 """Remove expired inboxes # noqa: E501 Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.flush_expired(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: FlushExpiredInboxesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.flush_expired_with_http_info(**kwargs) # noqa: E501 def flush_expired_with_http_info(self, **kwargs)-
Remove expired inboxes # noqa: E501
Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.flush_expired_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(FlushExpiredInboxesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def flush_expired_with_http_info(self, **kwargs): # noqa: E501 """Remove expired inboxes # noqa: E501 Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.flush_expired_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: Optional expired at before flag to flush expired inboxes that have expired before the given time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(FlushExpiredInboxesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method flush_expired" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/expired', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='FlushExpiredInboxesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_inboxes(self, **kwargs)-
List All Inboxes Paginated # noqa: E501
List inboxes in paginated form. The results are available on the
contentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternativegetInboxesmethod returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_all_inboxes(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_inboxes(self, **kwargs): # noqa: E501 """List All Inboxes Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inboxes_with_http_info(**kwargs) # noqa: E501 def get_all_inboxes_offset_paginated(self, **kwargs)-
List All Inboxes Offset Paginated # noqa: E501
List inboxes in paginated form. The results are available on the
contentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternativegetInboxesmethod returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_all_inboxes_offset_paginated(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_inboxes_offset_paginated(self, **kwargs): # noqa: E501 """List All Inboxes Offset Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes_offset_paginated(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inboxes_offset_paginated_with_http_info(**kwargs) # noqa: E501 def get_all_inboxes_offset_paginated_with_http_info(self, **kwargs)-
List All Inboxes Offset Paginated # noqa: E501
List inboxes in paginated form. The results are available on the
contentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternativegetInboxesmethod returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_all_inboxes_offset_paginated_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_inboxes_offset_paginated_with_http_info(self, **kwargs): # noqa: E501 """List All Inboxes Offset Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes_offset_paginated_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'favourite', 'search', 'tag', 'team_access', 'since', 'before', 'inbox_type', 'inbox_function', 'domain_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_inboxes_offset_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if '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 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501 query_params.append(('search', local_var_params['search'])) # noqa: E501 if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501 query_params.append(('tag', local_var_params['tag'])) # noqa: E501 if 'team_access' in local_var_params and local_var_params['team_access'] is not None: # noqa: E501 query_params.append(('teamAccess', local_var_params['team_access'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 'inbox_function' in local_var_params and local_var_params['inbox_function'] is not None: # noqa: E501 query_params.append(('inboxFunction', local_var_params['inbox_function'])) # 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 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( '/inboxes/offset-paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_inboxes_with_http_info(self, **kwargs)-
List All Inboxes Paginated # noqa: E501
List inboxes in paginated form. The results are available on the
contentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternativegetInboxesmethod returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_all_inboxes_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_inboxes_with_http_info(self, **kwargs): # noqa: E501 """List All Inboxes Paginated # noqa: E501 List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param bool favourite: Optionally filter results for favourites only :param str search: Optionally filter by search words partial matching ID, tags, name, and email address :param str tag: Optionally filter by tags. Will return inboxes that include given tags :param bool team_access: DEPRECATED. Optionally filter by team access. :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param str inbox_type: Optional filter by inbox type :param str inbox_function: Optional filter by inbox function :param str domain_id: Optional domain ID filter :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'favourite', 'search', 'tag', 'team_access', 'since', 'before', 'inbox_type', 'inbox_function', 'domain_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if '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 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501 query_params.append(('search', local_var_params['search'])) # noqa: E501 if 'tag' in local_var_params and local_var_params['tag'] is not None: # noqa: E501 query_params.append(('tag', local_var_params['tag'])) # noqa: E501 if 'team_access' in local_var_params and local_var_params['team_access'] is not None: # noqa: E501 query_params.append(('teamAccess', local_var_params['team_access'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 'inbox_function' in local_var_params and local_var_params['inbox_function'] is not None: # noqa: E501 query_params.append(('inboxFunction', local_var_params['inbox_function'])) # 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 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( '/inboxes/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_scheduled_jobs(self, **kwargs)-
Get all scheduled email sending jobs for account # noqa: E501
Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_scheduled_jobs(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageScheduledJobs If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_scheduled_jobs(self, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for account # noqa: E501 Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_scheduled_jobs(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageScheduledJobs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_scheduled_jobs_with_http_info(**kwargs) # noqa: E501 def get_all_scheduled_jobs_with_http_info(self, **kwargs)-
Get all scheduled email sending jobs for account # noqa: E501
Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_scheduled_jobs_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_scheduled_jobs_with_http_info(self, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for account # noqa: E501 Schedule sending of emails using scheduled jobs. These can be inbox or account level. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_scheduled_jobs_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_scheduled_jobs" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/scheduled-jobs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageScheduledJobs', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_delivery_statuses_by_inbox_id(self, inbox_id, **kwargs)-
get_delivery_statuses_by_inbox_id # noqa: E501
Get all email delivery statuses for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_delivery_statuses_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in delivery status list pagination :param int size: Optional page size in delivery status list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageDeliveryStatus If the method is called asynchronously, returns the request thread.
Expand source code
def get_delivery_statuses_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501 """get_delivery_statuses_by_inbox_id # noqa: E501 Get all email delivery statuses for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_delivery_statuses_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in delivery status list pagination :param int size: Optional page size in delivery status list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageDeliveryStatus If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_delivery_statuses_by_inbox_id_with_http_info(self, inbox_id, **kwargs)-
get_delivery_statuses_by_inbox_id # noqa: E501
Get all email delivery statuses for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in delivery status list pagination :param int size: Optional page size in delivery status list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageDeliveryStatus, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_delivery_statuses_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """get_delivery_statuses_by_inbox_id # noqa: E501 Get all email delivery statuses for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in delivery status list pagination :param int size: Optional page size in delivery status list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageDeliveryStatus, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_delivery_statuses_by_inbox_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_delivery_statuses_by_inbox_id`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/delivery-status', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageDeliveryStatus', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_emails(self, inbox_id, **kwargs)-
Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501
List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the
minCountparameter. The server will retry the inbox database until theminCountis satisfied or theretryTimeoutis reached # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_emails(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int size: Alias for limit. Assessed first before assessing any passed limit. :param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller :param str sort: Sort the results by received date and direction ASC or DESC :param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned :param int delay_timeout: :param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. :param bool unread_only: :param datetime before: Exclude emails received after this ISO 8601 date time :param datetime since: Exclude emails received before this ISO 8601 date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[EmailPreview] If the method is called asynchronously, returns the request thread.
Expand source code
def get_emails(self, inbox_id, **kwargs): # noqa: E501 """Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501 List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int size: Alias for limit. Assessed first before assessing any passed limit. :param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller :param str sort: Sort the results by received date and direction ASC or DESC :param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned :param int delay_timeout: :param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. :param bool unread_only: :param datetime before: Exclude emails received after this ISO 8601 date time :param datetime since: Exclude emails received before this ISO 8601 date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[EmailPreview] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_emails_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_emails_with_http_info(self, inbox_id, **kwargs)-
Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501
List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the
minCountparameter. The server will retry the inbox database until theminCountis satisfied or theretryTimeoutis reached # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_emails_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int size: Alias for limit. Assessed first before assessing any passed limit. :param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller :param str sort: Sort the results by received date and direction ASC or DESC :param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned :param int delay_timeout: :param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. :param bool unread_only: :param datetime before: Exclude emails received after this ISO 8601 date time :param datetime since: Exclude emails received before this ISO 8601 date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[EmailPreview], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. # noqa: E501 List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_emails_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int size: Alias for limit. Assessed first before assessing any passed limit. :param int limit: Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller :param str sort: Sort the results by received date and direction ASC or DESC :param int retry_timeout: Maximum milliseconds to spend retrying inbox database until minCount emails are returned :param int delay_timeout: :param int min_count: Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. :param bool unread_only: :param datetime before: Exclude emails received after this ISO 8601 date time :param datetime since: Exclude emails received before this ISO 8601 date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[EmailPreview], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'size', 'limit', 'sort', 'retry_timeout', 'delay_timeout', 'min_count', 'unread_only', 'before', 'since' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_emails`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_emails`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `limit` when calling `get_emails`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 query_params.append(('limit', local_var_params['limit'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'retry_timeout' in local_var_params and local_var_params['retry_timeout'] is not None: # noqa: E501 query_params.append(('retryTimeout', local_var_params['retry_timeout'])) # noqa: E501 if 'delay_timeout' in local_var_params and local_var_params['delay_timeout'] is not None: # noqa: E501 query_params.append(('delayTimeout', local_var_params['delay_timeout'])) # noqa: E501 if 'min_count' in local_var_params and local_var_params['min_count'] is not None: # noqa: E501 query_params.append(('minCount', local_var_params['min_count'])) # noqa: E501 if 'unread_only' in local_var_params and local_var_params['unread_only'] is not None: # noqa: E501 query_params.append(('unreadOnly', local_var_params['unread_only'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 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( '/inboxes/{inboxId}/emails', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[EmailPreview]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_imap_smtp_access(self, **kwargs)-
get_imap_smtp_access # noqa: E501
Get IMAP and SMTP access usernames and passwords # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_imap_smtp_access(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapSmtpAccessDetails If the method is called asynchronously, returns the request thread.
Expand source code
def get_imap_smtp_access(self, **kwargs): # noqa: E501 """get_imap_smtp_access # noqa: E501 Get IMAP and SMTP access usernames and passwords # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_imap_smtp_access(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapSmtpAccessDetails If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_imap_smtp_access_with_http_info(**kwargs) # noqa: E501 def get_imap_smtp_access_with_http_info(self, **kwargs)-
get_imap_smtp_access # noqa: E501
Get IMAP and SMTP access usernames and passwords # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_imap_smtp_access_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapSmtpAccessDetails, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_imap_smtp_access_with_http_info(self, **kwargs): # noqa: E501 """get_imap_smtp_access # noqa: E501 Get IMAP and SMTP access usernames and passwords # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_imap_smtp_access_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapSmtpAccessDetails, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_imap_smtp_access" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/imap-smtp-access', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapSmtpAccessDetails', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox(self, inbox_id, **kwargs)-
Get Inbox. Returns properties of an inbox. # noqa: E501
Returns an inbox's properties, including its email address and ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_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: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox. Returns properties of an inbox. # noqa: E501 Returns an inbox's properties, including its email address and ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_by_email_address(self, email_address, **kwargs)-
Search for an inbox with the provided email address # noqa: E501
Get a inbox result by email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_email_address(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (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: InboxByEmailAddressResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_by_email_address(self, email_address, **kwargs): # noqa: E501 """Search for an inbox with the provided email address # noqa: E501 Get a inbox result by email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (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: InboxByEmailAddressResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_by_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_inbox_by_email_address_with_http_info(self, email_address, **kwargs)-
Search for an inbox with the provided email address # noqa: E501
Get a inbox result by email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param _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(InboxByEmailAddressResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_by_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """Search for an inbox with the provided email address # noqa: E501 Get a inbox result by email address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param _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(InboxByEmailAddressResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_by_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `get_inbox_by_email_address`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 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( '/inboxes/byEmailAddress', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxByEmailAddressResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_by_name(self, name, **kwargs)-
Search for an inbox with the given name # noqa: E501
Get a inbox result by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_name(name, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str name: (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: InboxByNameResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_by_name(self, name, **kwargs): # noqa: E501 """Search for an inbox with the given name # noqa: E501 Get a inbox result by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_name(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (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: InboxByNameResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_by_name_with_http_info(name, **kwargs) # noqa: E501 def get_inbox_by_name_with_http_info(self, name, **kwargs)-
Search for an inbox with the given name # noqa: E501
Get a inbox result by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_by_name_with_http_info(name, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str name: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxByNameResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_by_name_with_http_info(self, name, **kwargs): # noqa: E501 """Search for an inbox with the given name # noqa: E501 Get a inbox result by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_by_name_with_http_info(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxByNameResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'name' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_by_name" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'name' is set if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501 local_var_params['name'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `name` when calling `get_inbox_by_name`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 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( '/inboxes/byName', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxByNameResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_count(self, **kwargs)-
Get total inbox count # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_count(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CountDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_count(self, **kwargs): # noqa: E501 """Get total inbox count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_count_with_http_info(**kwargs) # noqa: E501 def get_inbox_count_with_http_info(self, **kwargs)-
Get total inbox count # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_count_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_count_with_http_info(self, **kwargs): # noqa: E501 """Get total inbox count # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_email_count(self, inbox_id, **kwargs)-
Get email count in inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_email_count(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (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: CountDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_email_count(self, inbox_id, **kwargs): # noqa: E501 """Get email count in inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_email_count(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (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: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_email_count_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_email_count_with_http_info(self, inbox_id, **kwargs)-
Get email count in inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_email_count_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_email_count_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get email count in inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_email_count_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_email_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_email_count`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/emails/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_emails_paginated(self, inbox_id, **kwargs)-
Get inbox emails paginated # noqa: E501
Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_emails_paginated(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int page: Optional page index in inbox emails list pagination :param int size: Optional page size in inbox emails list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by received after given date time :param datetime before: Optional filter by received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailPreview If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_emails_paginated(self, inbox_id, **kwargs): # noqa: E501 """Get inbox emails paginated # noqa: E501 Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_emails_paginated(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int page: Optional page index in inbox emails list pagination :param int size: Optional page size in inbox emails list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by received after given date time :param datetime before: Optional filter by received before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageEmailPreview If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_emails_paginated_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_emails_paginated_with_http_info(self, inbox_id, **kwargs)-
Get inbox emails paginated # noqa: E501
Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_emails_paginated_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int page: Optional page index in inbox emails list pagination :param int size: Optional page size in inbox emails list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by received after given date time :param datetime before: Optional filter by received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_emails_paginated_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get inbox emails paginated # noqa: E501 Get a paginated list of emails in an inbox. Does not hold connections open. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_emails_paginated_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Id of inbox that emails belongs to (required) :param int page: Optional page index in inbox emails list pagination :param int size: Optional page size in inbox emails list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by received after given date time :param datetime before: Optional filter by received before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageEmailPreview, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_emails_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_emails_paginated`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/emails/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEmailPreview', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_ids(self, **kwargs)-
Get all inbox IDs # noqa: E501
Get list of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_ids(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxIdsResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_ids(self, **kwargs): # noqa: E501 """Get all inbox IDs # noqa: E501 Get list of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_ids(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: InboxIdsResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_ids_with_http_info(**kwargs) # noqa: E501 def get_inbox_ids_with_http_info(self, **kwargs)-
Get all inbox IDs # noqa: E501
Get list of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_ids_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxIdsResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_ids_with_http_info(self, **kwargs): # noqa: E501 """Get all inbox IDs # noqa: E501 Get list of inbox IDs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_ids_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxIdsResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_ids" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/ids', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxIdsResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_sent_emails(self, inbox_id, **kwargs)-
Get Inbox Sent Emails # noqa: E501
Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_sent_emails(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox sent email list pagination :param int size: Optional page size in inbox sent email list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional sent email search :param datetime since: Optional filter by sent after given date time :param datetime before: Optional filter by sent before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageSentEmailProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_sent_emails(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox Sent Emails # noqa: E501 Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_sent_emails(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox sent email list pagination :param int size: Optional page size in inbox sent email list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional sent email search :param datetime since: Optional filter by sent after given date time :param datetime before: Optional filter by sent before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageSentEmailProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_sent_emails_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_sent_emails_with_http_info(self, inbox_id, **kwargs)-
Get Inbox Sent Emails # noqa: E501
Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_sent_emails_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox sent email list pagination :param int size: Optional page size in inbox sent email list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional sent email search :param datetime since: Optional filter by sent after given date time :param datetime before: Optional filter by sent before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageSentEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_sent_emails_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox Sent Emails # noqa: E501 Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_sent_emails_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox sent email list pagination :param int size: Optional page size in inbox sent email list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional sent email search :param datetime since: Optional filter by sent after given date time :param datetime before: Optional filter by sent before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageSentEmailProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_sent_emails" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_sent_emails`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/sent', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageSentEmailProjection', # 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) -
Get inbox tags # noqa: E501
Get all inbox tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_tags(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[str] If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_tags(self, **kwargs): # noqa: E501 """Get inbox tags # noqa: E501 Get all inbox tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_tags(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[str] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_tags_with_http_info(**kwargs) # noqa: E501 -
Get inbox tags # noqa: E501
Get all inbox tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_tags_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[str], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_tags_with_http_info(self, **kwargs): # noqa: E501 """Get inbox tags # noqa: E501 Get all inbox tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_tags_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[str], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inbox_tags" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # 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( '/inboxes/tags', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[str]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_inbox_with_http_info(self, inbox_id, **kwargs)-
Get Inbox. Returns properties of an inbox. # noqa: E501
Returns an inbox's properties, including its email address and ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_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: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get Inbox. Returns properties of an inbox. # noqa: E501 Returns an inbox's properties, including its email address and ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_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: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_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 `get_inbox`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', 'GET', 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 get_inboxes(self, **kwargs)-
List Inboxes and email addresses # noqa: E501
List the inboxes you have created. Note use of the more advanced
getAllInboxesis recommended and allows paginated access using a limit and sort parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_inboxes(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated
getAllEmailsfor larger queries. :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by created after given date time :param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[InboxDto] If the method is called asynchronously, returns the request thread.Expand source code
def get_inboxes(self, **kwargs): # noqa: E501 """List Inboxes and email addresses # noqa: E501 List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by created after given date time :param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[InboxDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inboxes_with_http_info(**kwargs) # noqa: E501 def get_inboxes_with_http_info(self, **kwargs)-
List Inboxes and email addresses # noqa: E501
List the inboxes you have created. Note use of the more advanced
getAllInboxesis recommended and allows paginated access using a limit and sort parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_inboxes_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated
getAllEmailsfor larger queries. :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by created after given date time :param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[InboxDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.Expand source code
def get_inboxes_with_http_info(self, **kwargs): # noqa: E501 """List Inboxes and email addresses # noqa: E501 List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Optional filter by created after given date time :param bool exclude_catch_all_inboxes: Optional exclude catch all inboxes :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[InboxDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'size', 'sort', 'since', 'exclude_catch_all_inboxes', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_inboxes`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'exclude_catch_all_inboxes' in local_var_params and local_var_params['exclude_catch_all_inboxes'] is not None: # noqa: E501 query_params.append(('excludeCatchAllInboxes', local_var_params['exclude_catch_all_inboxes'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[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 get_latest_email_in_inbox(self, inbox_id, timeout_millis, **kwargs)-
Get latest email in an inbox. Use
WaitForControllerto get emails that may not have arrived yet. # noqa: E501Get the newest email in an inbox or wait for one to arrive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox(inbox_id, timeout_millis, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param int timeout_millis: Timeout milliseconds to wait for latest email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread.
Expand source code
def get_latest_email_in_inbox(self, inbox_id, timeout_millis, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in an inbox or wait for one to arrive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox(inbox_id, timeout_millis, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param int timeout_millis: Timeout milliseconds to wait for latest email (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Email If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, **kwargs) # noqa: E501 def get_latest_email_in_inbox_with_http_info(self, inbox_id, timeout_millis, **kwargs)-
Get latest email in an inbox. Use
WaitForControllerto get emails that may not have arrived yet. # noqa: E501Get the newest email in an inbox or wait for one to arrive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param int timeout_millis: Timeout milliseconds to wait for latest email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_latest_email_in_inbox_with_http_info(self, inbox_id, timeout_millis, **kwargs): # noqa: E501 """Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. # noqa: E501 Get the newest email in an inbox or wait for one to arrive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to get the latest email from (required) :param int timeout_millis: Timeout milliseconds to wait for latest email (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Email, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'timeout_millis' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_latest_email_in_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 `get_latest_email_in_inbox`") # noqa: E501 # verify the required parameter 'timeout_millis' is set if self.api_client.client_side_validation and ('timeout_millis' not in local_var_params or # noqa: E501 local_var_params['timeout_millis'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `timeout_millis` when calling `get_latest_email_in_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 if 'timeout_millis' in local_var_params and local_var_params['timeout_millis'] is not None: # noqa: E501 query_params.append(('timeoutMillis', local_var_params['timeout_millis'])) # 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( '/inboxes/getLatestEmail', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Email', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_organization_inboxes(self, **kwargs)-
List Organization Inboxes Paginated # noqa: E501
List organization inboxes in paginated form. These are inboxes created with
allowTeamAccessflag enabled. Organization inboxes arereadOnlyfor non-admin users. The results are available on thecontentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_organization_inboxes(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageOrganizationInboxProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_organization_inboxes(self, **kwargs): # noqa: E501 """List Organization Inboxes Paginated # noqa: E501 List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_inboxes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageOrganizationInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_organization_inboxes_with_http_info(**kwargs) # noqa: E501 def get_organization_inboxes_with_http_info(self, **kwargs)-
List Organization Inboxes Paginated # noqa: E501
List organization inboxes in paginated form. These are inboxes created with
allowTeamAccessflag enabled. Organization inboxes arereadOnlyfor non-admin users. The results are available on thecontentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.get_organization_inboxes_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageOrganizationInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_organization_inboxes_with_http_info(self, **kwargs): # noqa: E501 """List Organization Inboxes Paginated # noqa: E501 List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_organization_inboxes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageOrganizationInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_organization_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/organization', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageOrganizationInboxProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_scheduled_job(self, job_id, **kwargs)-
Get a scheduled email job # noqa: E501
Get a scheduled email job details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_job(job_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str job_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: ScheduledJobDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_scheduled_job(self, job_id, **kwargs): # noqa: E501 """Get a scheduled email job # noqa: E501 Get a scheduled email job details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_job(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_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: ScheduledJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_scheduled_job_with_http_info(job_id, **kwargs) # noqa: E501 def get_scheduled_job_with_http_info(self, job_id, **kwargs)-
Get a scheduled email job # noqa: E501
Get a scheduled email job details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_job_with_http_info(job_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str job_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_scheduled_job_with_http_info(self, job_id, **kwargs): # noqa: E501 """Get a scheduled email job # noqa: E501 Get a scheduled email job details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_job_with_http_info(job_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str job_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'job_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_scheduled_job" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'job_id' is set if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501 local_var_params['job_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `job_id` when calling `get_scheduled_job`") # noqa: E501 collection_formats = {} path_params = {} if 'job_id' in local_var_params: path_params['jobId'] = local_var_params['job_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/scheduled-jobs/{jobId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ScheduledJobDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_scheduled_jobs_by_inbox_id(self, inbox_id, **kwargs)-
Get all scheduled email sending jobs for the inbox # noqa: E501
Schedule sending of emails using scheduled jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_jobs_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageScheduledJobs If the method is called asynchronously, returns the request thread.
Expand source code
def get_scheduled_jobs_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for the inbox # noqa: E501 Schedule sending of emails using scheduled jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_jobs_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageScheduledJobs If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_scheduled_jobs_by_inbox_id_with_http_info(self, inbox_id, **kwargs)-
Get all scheduled email sending jobs for the inbox # noqa: E501
Schedule sending of emails using scheduled jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_scheduled_jobs_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get all scheduled email sending jobs for the inbox # noqa: E501 Schedule sending of emails using scheduled jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in scheduled job list pagination :param int size: Optional page size in scheduled job list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageScheduledJobs, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_scheduled_jobs_by_inbox_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_scheduled_jobs_by_inbox_id`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/scheduled-jobs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageScheduledJobs', # 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 list_inbox_rulesets(self, inbox_id, **kwargs)-
List inbox rulesets # noqa: E501
List all rulesets attached to an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_rulesets(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox ruleset list pagination :param int size: Optional page size in inbox ruleset list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxRulesetDto If the method is called asynchronously, returns the request thread.
Expand source code
def list_inbox_rulesets(self, inbox_id, **kwargs): # noqa: E501 """List inbox rulesets # noqa: E501 List all rulesets attached to an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_rulesets(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox ruleset list pagination :param int size: Optional page size in inbox ruleset list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxRulesetDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.list_inbox_rulesets_with_http_info(inbox_id, **kwargs) # noqa: E501 def list_inbox_rulesets_with_http_info(self, inbox_id, **kwargs)-
List inbox rulesets # noqa: E501
List all rulesets attached to an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_rulesets_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox ruleset list pagination :param int size: Optional page size in inbox ruleset list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxRulesetDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def list_inbox_rulesets_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """List inbox rulesets # noqa: E501 List all rulesets attached to an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_rulesets_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox ruleset list pagination :param int size: Optional page size in inbox ruleset list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxRulesetDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method list_inbox_rulesets" % 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 `list_inbox_rulesets`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/rulesets', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxRulesetDto', # 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 list_inbox_tracking_pixels(self, inbox_id, **kwargs)-
List inbox tracking pixels # noqa: E501
List all tracking pixels sent from an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_tracking_pixels(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox tracking pixel list pagination :param int size: Optional page size in inbox tracking pixel list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageTrackingPixelProjection If the method is called asynchronously, returns the request thread.
Expand source code
def list_inbox_tracking_pixels(self, inbox_id, **kwargs): # noqa: E501 """List inbox tracking pixels # noqa: E501 List all tracking pixels sent from an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_tracking_pixels(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox tracking pixel list pagination :param int size: Optional page size in inbox tracking pixel list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageTrackingPixelProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.list_inbox_tracking_pixels_with_http_info(inbox_id, **kwargs) # noqa: E501 def list_inbox_tracking_pixels_with_http_info(self, inbox_id, **kwargs)-
List inbox tracking pixels # noqa: E501
List all tracking pixels sent from an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_tracking_pixels_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox tracking pixel list pagination :param int size: Optional page size in inbox tracking pixel list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageTrackingPixelProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def list_inbox_tracking_pixels_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """List inbox tracking pixels # noqa: E501 List all tracking pixels sent from an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_tracking_pixels_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in inbox tracking pixel list pagination :param int size: Optional page size in inbox tracking pixel list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Optional filter by created after given date time :param datetime before: Optional filter by created before given date time :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageTrackingPixelProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method list_inbox_tracking_pixels" % 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 `list_inbox_tracking_pixels`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/tracking-pixels', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageTrackingPixelProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def search_inboxes(self, search_inboxes_options, **kwargs)-
Search all inboxes and return matching inboxes # noqa: E501
Search inboxes and return in paginated form. The results are available on the
contentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternativegetInboxesmethod returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.search_inboxes(search_inboxes_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SearchInboxesOptions search_inboxes_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: PageInboxProjection If the method is called asynchronously, returns the request thread.
Expand source code
def search_inboxes(self, search_inboxes_options, **kwargs): # noqa: E501 """Search all inboxes and return matching inboxes # noqa: E501 Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_inboxes(search_inboxes_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchInboxesOptions search_inboxes_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: PageInboxProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.search_inboxes_with_http_info(search_inboxes_options, **kwargs) # noqa: E501 def search_inboxes_with_http_info(self, search_inboxes_options, **kwargs)-
Search all inboxes and return matching inboxes # noqa: E501
Search inboxes and return in paginated form. The results are available on the
contentproperty of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternativegetInboxesmethod returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True>>> thread = api.search_inboxes_with_http_info(search_inboxes_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param SearchInboxesOptions search_inboxes_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def search_inboxes_with_http_info(self, search_inboxes_options, **kwargs): # noqa: E501 """Search all inboxes and return matching inboxes # noqa: E501 Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.search_inboxes_with_http_info(search_inboxes_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SearchInboxesOptions search_inboxes_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageInboxProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'search_inboxes_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method search_inboxes" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'search_inboxes_options' is set if self.api_client.client_side_validation and ('search_inboxes_options' not in local_var_params or # noqa: E501 local_var_params['search_inboxes_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `search_inboxes_options` when calling `search_inboxes`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'search_inboxes_options' in local_var_params: body_params = local_var_params['search_inboxes_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/search', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxProjection', # 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(self, inbox_id, send_email_options, **kwargs)-
Send Email # noqa: E501
Send an email from an inbox's email address. The request body should contain the
SendEmailOptionsthat include recipients, attachments, body etc. SeeSendEmailOptionsfor all available properties. Note theinboxIdrefers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister methodsendEmailAndConfirm. # 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(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send Email # noqa: E501 Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. # 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(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def send_email_and_confirm(self, inbox_id, send_email_options, **kwargs)-
Send email and return sent confirmation # noqa: E501
Sister method for standard
sendEmailmethod with the benefit of returning aSentEmailentity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_and_confirm(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email and return sent confirmation # noqa: E501 Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_and_confirm_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def send_email_and_confirm_with_http_info(self, inbox_id, send_email_options, **kwargs)-
Send email and return sent confirmation # noqa: E501
Sister method for standard
sendEmailmethod with the benefit of returning aSentEmailentity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_and_confirm_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email and return sent confirmation # noqa: E501 Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it. # 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_and_confirm_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email_and_confirm" % 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 `send_email_and_confirm`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_and_confirm`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/confirm', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_email_with_http_info(self, inbox_id, send_email_options, **kwargs)-
Send Email # noqa: E501
Send an email from an inbox's email address. The request body should contain the
SendEmailOptionsthat include recipients, attachments, body etc. SeeSendEmailOptionsfor all available properties. Note theinboxIdrefers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister methodsendEmailAndConfirm. # 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_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send Email # noqa: E501 Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`. # 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_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email" % 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 `send_email`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', '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_with_queue(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs)-
Send email with queue # noqa: E501
Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue(inbox_id, validate_before_enqueue, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param bool validate_before_enqueue: Validate before adding to queue (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_with_queue(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs): # noqa: E501 """Send email with queue # noqa: E501 Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue(inbox_id, validate_before_enqueue, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param bool validate_before_enqueue: Validate before adding to queue (required) :param SendEmailOptions send_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, **kwargs) # noqa: E501 def send_email_with_queue_with_http_info(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs)-
Send email with queue # noqa: E501
Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param bool validate_before_enqueue: Validate before adding to queue (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code
def send_email_with_queue_with_http_info(self, inbox_id, validate_before_enqueue, send_email_options, **kwargs): # noqa: E501 """Send email with queue # noqa: E501 Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. # 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_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param bool validate_before_enqueue: Validate before adding to queue (required) :param SendEmailOptions send_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'validate_before_enqueue', '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_with_queue" % 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 `send_email_with_queue`") # noqa: E501 # verify the required parameter 'validate_before_enqueue' is set if self.api_client.client_side_validation and ('validate_before_enqueue' not in local_var_params or # noqa: E501 local_var_params['validate_before_enqueue'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `validate_before_enqueue` when calling `send_email_with_queue`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_with_queue`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'validate_before_enqueue' in local_var_params and local_var_params['validate_before_enqueue'] is not None: # noqa: E501 query_params.append(('validateBeforeEnqueue', local_var_params['validate_before_enqueue'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/with-queue', '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_smtp_envelope(self, inbox_id, send_smtp_envelope_options, **kwargs)-
Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501
Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_smtp_envelope(inbox_id, send_smtp_envelope_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread.
Expand source code
def send_smtp_envelope(self, inbox_id, send_smtp_envelope_options, **kwargs): # noqa: E501 """Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501 Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_smtp_envelope(inbox_id, send_smtp_envelope_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, **kwargs) # noqa: E501 def send_smtp_envelope_with_http_info(self, inbox_id, send_smtp_envelope_options, **kwargs)-
Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501
Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def send_smtp_envelope_with_http_info(self, inbox_id, send_smtp_envelope_options, **kwargs): # noqa: E501 """Send email using an SMTP mail envelope and message body and return sent confirmation # noqa: E501 Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendSMTPEnvelopeOptions send_smtp_envelope_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_smtp_envelope_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_smtp_envelope" % 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 `send_smtp_envelope`") # noqa: E501 # verify the required parameter 'send_smtp_envelope_options' is set if self.api_client.client_side_validation and ('send_smtp_envelope_options' not in local_var_params or # noqa: E501 local_var_params['send_smtp_envelope_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_smtp_envelope_options` when calling `send_smtp_envelope`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_smtp_envelope_options' in local_var_params: body_params = local_var_params['send_smtp_envelope_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/smtp-envelope', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_test_email(self, inbox_id, **kwargs)-
Send a test email to inbox # noqa: E501
Send an inbox a test email to test email receiving is working # 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_test_email(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 send_test_email(self, inbox_id, **kwargs): # noqa: E501 """Send a test email to inbox # noqa: E501 Send an inbox a test email to test email receiving is working # 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_test_email(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.send_test_email_with_http_info(inbox_id, **kwargs) # noqa: E501 def send_test_email_with_http_info(self, inbox_id, **kwargs)-
Send a test email to inbox # noqa: E501
Send an inbox a test email to test email receiving is working # 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_test_email_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 send_test_email_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Send a test email to inbox # noqa: E501 Send an inbox a test email to test email receiving is working # 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_test_email_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 send_test_email" % 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 `send_test_email`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/send-test-email', '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_with_schedule(self, inbox_id, send_email_options, **kwargs)-
Send email with with delay or schedule # noqa: E501
Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param datetime send_at_timestamp: Sending timestamp :param int send_at_now_plus_seconds: Send after n seconds :param bool validate_before_enqueue: Validate before adding to queue :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ScheduledJobDto If the method is called asynchronously, returns the request thread.
Expand source code
def send_with_schedule(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email with with delay or schedule # noqa: E501 Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param datetime send_at_timestamp: Sending timestamp :param int send_at_now_plus_seconds: Send after n seconds :param bool validate_before_enqueue: Validate before adding to queue :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ScheduledJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_with_schedule_with_http_info(inbox_id, send_email_options, **kwargs) # noqa: E501 def send_with_schedule_with_http_info(self, inbox_id, send_email_options, **kwargs)-
Send email with with delay or schedule # noqa: E501
Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param datetime send_at_timestamp: Sending timestamp :param int send_at_now_plus_seconds: Send after n seconds :param bool validate_before_enqueue: Validate before adding to queue :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(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def send_with_schedule_with_http_info(self, inbox_id, send_email_options, **kwargs): # noqa: E501 """Send email with with delay or schedule # noqa: E501 Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. # 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_with_schedule_with_http_info(inbox_id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of the inbox you want to send the email from (required) :param SendEmailOptions send_email_options: (required) :param datetime send_at_timestamp: Sending timestamp :param int send_at_now_plus_seconds: Send after n seconds :param bool validate_before_enqueue: Validate before adding to queue :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(ScheduledJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'send_email_options', 'send_at_timestamp', 'send_at_now_plus_seconds', 'validate_before_enqueue' ] 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_with_schedule" % 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 `send_with_schedule`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_with_schedule`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'send_at_timestamp' in local_var_params and local_var_params['send_at_timestamp'] is not None: # noqa: E501 query_params.append(('sendAtTimestamp', local_var_params['send_at_timestamp'])) # noqa: E501 if 'send_at_now_plus_seconds' in local_var_params and local_var_params['send_at_now_plus_seconds'] is not None: # noqa: E501 query_params.append(('sendAtNowPlusSeconds', local_var_params['send_at_now_plus_seconds'])) # noqa: E501 if 'validate_before_enqueue' in local_var_params and local_var_params['validate_before_enqueue'] is not None: # noqa: E501 query_params.append(('validateBeforeEnqueue', local_var_params['validate_before_enqueue'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/with-schedule', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ScheduledJobDto', # 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 set_inbox_favourited(self, inbox_id, set_inbox_favourited_options, **kwargs)-
Set inbox favourited state # noqa: E501
Set and return new favourite state for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_inbox_favourited(inbox_id, set_inbox_favourited_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox to set favourite state (required) :param SetInboxFavouritedOptions set_inbox_favourited_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: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def set_inbox_favourited(self, inbox_id, set_inbox_favourited_options, **kwargs): # noqa: E501 """Set inbox favourited state # noqa: E501 Set and return new favourite state for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_inbox_favourited(inbox_id, set_inbox_favourited_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox to set favourite state (required) :param SetInboxFavouritedOptions set_inbox_favourited_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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, **kwargs) # noqa: E501 def set_inbox_favourited_with_http_info(self, inbox_id, set_inbox_favourited_options, **kwargs)-
Set inbox favourited state # noqa: E501
Set and return new favourite state for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox to set favourite state (required) :param SetInboxFavouritedOptions set_inbox_favourited_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def set_inbox_favourited_with_http_info(self, inbox_id, set_inbox_favourited_options, **kwargs): # noqa: E501 """Set inbox favourited state # noqa: E501 Set and return new favourite state for an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox to set favourite state (required) :param SetInboxFavouritedOptions set_inbox_favourited_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'set_inbox_favourited_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 set_inbox_favourited" % 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 `set_inbox_favourited`") # noqa: E501 # verify the required parameter 'set_inbox_favourited_options' is set if self.api_client.client_side_validation and ('set_inbox_favourited_options' not in local_var_params or # noqa: E501 local_var_params['set_inbox_favourited_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `set_inbox_favourited_options` when calling `set_inbox_favourited`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'set_inbox_favourited_options' in local_var_params: body_params = local_var_params['set_inbox_favourited_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/favourite', 'PUT', 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 update_inbox(self, inbox_id, update_inbox_options, **kwargs)-
Update Inbox. Change name and description. Email address is not editable. # noqa: E501
Update editable fields on an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_inbox(inbox_id, update_inbox_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param UpdateInboxOptions update_inbox_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: InboxDto If the method is called asynchronously, returns the request thread.
Expand source code
def update_inbox(self, inbox_id, update_inbox_options, **kwargs): # noqa: E501 """Update Inbox. Change name and description. Email address is not editable. # noqa: E501 Update editable fields on an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_inbox(inbox_id, update_inbox_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param UpdateInboxOptions update_inbox_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: InboxDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_inbox_with_http_info(inbox_id, update_inbox_options, **kwargs) # noqa: E501 def update_inbox_with_http_info(self, inbox_id, update_inbox_options, **kwargs)-
Update Inbox. Change name and description. Email address is not editable. # noqa: E501
Update editable fields on an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_inbox_with_http_info(inbox_id, update_inbox_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param UpdateInboxOptions update_inbox_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def update_inbox_with_http_info(self, inbox_id, update_inbox_options, **kwargs): # noqa: E501 """Update Inbox. Change name and description. Email address is not editable. # noqa: E501 Update editable fields on an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_inbox_with_http_info(inbox_id, update_inbox_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param UpdateInboxOptions update_inbox_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InboxDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'update_inbox_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 update_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 `update_inbox`") # noqa: E501 # verify the required parameter 'update_inbox_options' is set if self.api_client.client_side_validation and ('update_inbox_options' not in local_var_params or # noqa: E501 local_var_params['update_inbox_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_inbox_options` when calling `update_inbox`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_inbox_options' in local_var_params: body_params = local_var_params['update_inbox_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}', 'PATCH', 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)