Module mailslurp_client.api.tools_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 ToolsControllerApi(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 check_email_features_client_support(self, check_email_features_client_support_options, **kwargs): # noqa: E501
"""Check email client support for email HTML and CSS features # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_features_client_support(check_email_features_client_support_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: CheckEmailFeaturesClientSupportResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.check_email_features_client_support_with_http_info(check_email_features_client_support_options, **kwargs) # noqa: E501
def check_email_features_client_support_with_http_info(self, check_email_features_client_support_options, **kwargs): # noqa: E501
"""Check email client support for email HTML and CSS features # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_features_client_support_with_http_info(check_email_features_client_support_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CheckEmailFeaturesClientSupportResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'check_email_features_client_support_options'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method check_email_features_client_support" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'check_email_features_client_support_options' is set
if self.api_client.client_side_validation and ('check_email_features_client_support_options' not in local_var_params or # noqa: E501
local_var_params['check_email_features_client_support_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `check_email_features_client_support_options` when calling `check_email_features_client_support`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'check_email_features_client_support_options' in local_var_params:
body_params = local_var_params['check_email_features_client_support_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/tools/check-email-features-client-support', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CheckEmailFeaturesClientSupportResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_new_fake_email_address(self, **kwargs): # noqa: E501
"""Create a new email address using the fake email domains # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_new_fake_email_address(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: NewFakeEmailAddressResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_new_fake_email_address_with_http_info(**kwargs) # noqa: E501
def create_new_fake_email_address_with_http_info(self, **kwargs): # noqa: E501
"""Create a new email address using the fake email domains # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_new_fake_email_address_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(NewFakeEmailAddressResult, 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_new_fake_email_address" % 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(
'/tools/fake-email', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='NewFakeEmailAddressResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def generate_bimi_record(self, generate_bimi_record_options, **kwargs): # noqa: E501
"""Create a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_bimi_record(generate_bimi_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateBimiRecordOptions generate_bimi_record_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: GenerateBimiRecordResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.generate_bimi_record_with_http_info(generate_bimi_record_options, **kwargs) # noqa: E501
def generate_bimi_record_with_http_info(self, generate_bimi_record_options, **kwargs): # noqa: E501
"""Create a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_bimi_record_with_http_info(generate_bimi_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateBimiRecordOptions generate_bimi_record_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(GenerateBimiRecordResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'generate_bimi_record_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 generate_bimi_record" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'generate_bimi_record_options' is set
if self.api_client.client_side_validation and ('generate_bimi_record_options' not in local_var_params or # noqa: E501
local_var_params['generate_bimi_record_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `generate_bimi_record_options` when calling `generate_bimi_record`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'generate_bimi_record_options' in local_var_params:
body_params = local_var_params['generate_bimi_record_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(
'/tools/generate-bimi-record', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GenerateBimiRecordResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def generate_dmarc_record(self, generate_dmarc_record_options, **kwargs): # noqa: E501
"""Create a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_dmarc_record(generate_dmarc_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateDmarcRecordOptions generate_dmarc_record_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: GenerateDmarcRecordResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.generate_dmarc_record_with_http_info(generate_dmarc_record_options, **kwargs) # noqa: E501
def generate_dmarc_record_with_http_info(self, generate_dmarc_record_options, **kwargs): # noqa: E501
"""Create a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_dmarc_record_with_http_info(generate_dmarc_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateDmarcRecordOptions generate_dmarc_record_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(GenerateDmarcRecordResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'generate_dmarc_record_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 generate_dmarc_record" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'generate_dmarc_record_options' is set
if self.api_client.client_side_validation and ('generate_dmarc_record_options' not in local_var_params or # noqa: E501
local_var_params['generate_dmarc_record_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `generate_dmarc_record_options` when calling `generate_dmarc_record`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'generate_dmarc_record_options' in local_var_params:
body_params = local_var_params['generate_dmarc_record_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(
'/tools/generate-dmarc-record', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GenerateDmarcRecordResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def generate_mta_sts_record(self, generate_mta_sts_record_options, **kwargs): # noqa: E501
"""Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_mta_sts_record(generate_mta_sts_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateMtaStsRecordOptions generate_mta_sts_record_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: GenerateMtaStsRecordResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, **kwargs) # noqa: E501
def generate_mta_sts_record_with_http_info(self, generate_mta_sts_record_options, **kwargs): # noqa: E501
"""Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateMtaStsRecordOptions generate_mta_sts_record_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(GenerateMtaStsRecordResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'generate_mta_sts_record_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 generate_mta_sts_record" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'generate_mta_sts_record_options' is set
if self.api_client.client_side_validation and ('generate_mta_sts_record_options' not in local_var_params or # noqa: E501
local_var_params['generate_mta_sts_record_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `generate_mta_sts_record_options` when calling `generate_mta_sts_record`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'generate_mta_sts_record_options' in local_var_params:
body_params = local_var_params['generate_mta_sts_record_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(
'/tools/generate-mta-sts-record', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GenerateMtaStsRecordResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def generate_tls_reporting_record(self, generate_tls_reporting_record_options, **kwargs): # noqa: E501
"""Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_tls_reporting_record(generate_tls_reporting_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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: GenerateTlsReportingRecordResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, **kwargs) # noqa: E501
def generate_tls_reporting_record_with_http_info(self, generate_tls_reporting_record_options, **kwargs): # noqa: E501
"""Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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(GenerateTlsReportingRecordResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'generate_tls_reporting_record_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 generate_tls_reporting_record" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'generate_tls_reporting_record_options' is set
if self.api_client.client_side_validation and ('generate_tls_reporting_record_options' not in local_var_params or # noqa: E501
local_var_params['generate_tls_reporting_record_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `generate_tls_reporting_record_options` when calling `generate_tls_reporting_record`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'generate_tls_reporting_record_options' in local_var_params:
body_params = local_var_params['generate_tls_reporting_record_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(
'/tools/generate-tls-reporting-record', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GenerateTlsReportingRecordResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_fake_email_by_id(self, id, **kwargs): # noqa: E501
"""get_fake_email_by_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_fake_email_by_id(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str 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: FakeEmailResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_fake_email_by_id_with_http_info(id, **kwargs) # noqa: E501
def get_fake_email_by_id_with_http_info(self, id, **kwargs): # noqa: E501
"""get_fake_email_by_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_fake_email_by_id_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str 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(FakeEmailResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'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_fake_email_by_id" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `get_fake_email_by_id`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'id' in local_var_params and local_var_params['id'] is not None: # noqa: E501
query_params.append(('id', local_var_params['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(
'/tools/fake-email', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FakeEmailResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_fake_emails_for_address(self, email_address, **kwargs): # noqa: E501
"""get_fake_emails_for_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_fake_emails_for_address(email_address, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str email_address: (required)
:param int page:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for 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[FakeEmailPreview]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_fake_emails_for_address_with_http_info(email_address, **kwargs) # noqa: E501
def get_fake_emails_for_address_with_http_info(self, email_address, **kwargs): # noqa: E501
"""get_fake_emails_for_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_fake_emails_for_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 int page:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this 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[FakeEmailPreview], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'email_address',
'page'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, 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_fake_emails_for_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_fake_emails_for_address`") # noqa: E501
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 '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(
'/tools/fake-emails', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[FakeEmailPreview]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def lookup_bimi_domain(self, lookup_bimi_domain_options, **kwargs): # noqa: E501
"""Lookup a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_bimi_domain(lookup_bimi_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupBimiDomainOptions lookup_bimi_domain_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: LookupBimiDomainResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, **kwargs) # noqa: E501
def lookup_bimi_domain_with_http_info(self, lookup_bimi_domain_options, **kwargs): # noqa: E501
"""Lookup a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupBimiDomainOptions lookup_bimi_domain_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(LookupBimiDomainResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'lookup_bimi_domain_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 lookup_bimi_domain" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'lookup_bimi_domain_options' is set
if self.api_client.client_side_validation and ('lookup_bimi_domain_options' not in local_var_params or # noqa: E501
local_var_params['lookup_bimi_domain_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `lookup_bimi_domain_options` when calling `lookup_bimi_domain`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'lookup_bimi_domain_options' in local_var_params:
body_params = local_var_params['lookup_bimi_domain_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(
'/tools/lookup-bimi-domain', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LookupBimiDomainResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def lookup_dmarc_domain(self, lookup_dmarc_domain_options, **kwargs): # noqa: E501
"""Lookup a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_dmarc_domain(lookup_dmarc_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupDmarcDomainOptions lookup_dmarc_domain_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: LookupDmarcDomainResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, **kwargs) # noqa: E501
def lookup_dmarc_domain_with_http_info(self, lookup_dmarc_domain_options, **kwargs): # noqa: E501
"""Lookup a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupDmarcDomainOptions lookup_dmarc_domain_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(LookupDmarcDomainResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'lookup_dmarc_domain_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 lookup_dmarc_domain" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'lookup_dmarc_domain_options' is set
if self.api_client.client_side_validation and ('lookup_dmarc_domain_options' not in local_var_params or # noqa: E501
local_var_params['lookup_dmarc_domain_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `lookup_dmarc_domain_options` when calling `lookup_dmarc_domain`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'lookup_dmarc_domain_options' in local_var_params:
body_params = local_var_params['lookup_dmarc_domain_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(
'/tools/lookup-dmarc-domain', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LookupDmarcDomainResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def lookup_mta_sts_domain(self, lookup_mta_sts_domain_options, **kwargs): # noqa: E501
"""Lookup a MTA-STS domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_mta_sts_domain(lookup_mta_sts_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupMtaStsDomainOptions lookup_mta_sts_domain_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: LookupMtaStsDomainResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, **kwargs) # noqa: E501
def lookup_mta_sts_domain_with_http_info(self, lookup_mta_sts_domain_options, **kwargs): # noqa: E501
"""Lookup a MTA-STS domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupMtaStsDomainOptions lookup_mta_sts_domain_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(LookupMtaStsDomainResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'lookup_mta_sts_domain_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 lookup_mta_sts_domain" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'lookup_mta_sts_domain_options' is set
if self.api_client.client_side_validation and ('lookup_mta_sts_domain_options' not in local_var_params or # noqa: E501
local_var_params['lookup_mta_sts_domain_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `lookup_mta_sts_domain_options` when calling `lookup_mta_sts_domain`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'lookup_mta_sts_domain_options' in local_var_params:
body_params = local_var_params['lookup_mta_sts_domain_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(
'/tools/lookup-mta-sts-domain', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LookupMtaStsDomainResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def lookup_tls_reporting_domain(self, lookup_tls_reporting_domain_options, **kwargs): # noqa: E501
"""Lookup a TLS reporting domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_tls_reporting_domain(lookup_tls_reporting_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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: LookupTlsReportingDomainResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, **kwargs) # noqa: E501
def lookup_tls_reporting_domain_with_http_info(self, lookup_tls_reporting_domain_options, **kwargs): # noqa: E501
"""Lookup a TLS reporting domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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(LookupTlsReportingDomainResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'lookup_tls_reporting_domain_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 lookup_tls_reporting_domain" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'lookup_tls_reporting_domain_options' is set
if self.api_client.client_side_validation and ('lookup_tls_reporting_domain_options' not in local_var_params or # noqa: E501
local_var_params['lookup_tls_reporting_domain_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `lookup_tls_reporting_domain_options` when calling `lookup_tls_reporting_domain`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'lookup_tls_reporting_domain_options' in local_var_params:
body_params = local_var_params['lookup_tls_reporting_domain_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(
'/tools/lookup-tls-reporting-domain', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LookupTlsReportingDomainResults', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_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 ToolsControllerApi (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 ToolsControllerApi(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 check_email_features_client_support(self, check_email_features_client_support_options, **kwargs): # noqa: E501 """Check email client support for email HTML and CSS features # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_features_client_support(check_email_features_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailFeaturesClientSupportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_features_client_support_with_http_info(check_email_features_client_support_options, **kwargs) # noqa: E501 def check_email_features_client_support_with_http_info(self, check_email_features_client_support_options, **kwargs): # noqa: E501 """Check email client support for email HTML and CSS features # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_features_client_support_with_http_info(check_email_features_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailFeaturesClientSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_features_client_support_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_features_client_support" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_features_client_support_options' is set if self.api_client.client_side_validation and ('check_email_features_client_support_options' not in local_var_params or # noqa: E501 local_var_params['check_email_features_client_support_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_features_client_support_options` when calling `check_email_features_client_support`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_features_client_support_options' in local_var_params: body_params = local_var_params['check_email_features_client_support_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/check-email-features-client-support', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailFeaturesClientSupportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_new_fake_email_address(self, **kwargs): # noqa: E501 """Create a new email address using the fake email domains # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_fake_email_address(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: NewFakeEmailAddressResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_fake_email_address_with_http_info(**kwargs) # noqa: E501 def create_new_fake_email_address_with_http_info(self, **kwargs): # noqa: E501 """Create a new email address using the fake email domains # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_fake_email_address_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(NewFakeEmailAddressResult, 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_new_fake_email_address" % 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( '/tools/fake-email', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NewFakeEmailAddressResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_bimi_record(self, generate_bimi_record_options, **kwargs): # noqa: E501 """Create a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_bimi_record(generate_bimi_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateBimiRecordOptions generate_bimi_record_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: GenerateBimiRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_bimi_record_with_http_info(generate_bimi_record_options, **kwargs) # noqa: E501 def generate_bimi_record_with_http_info(self, generate_bimi_record_options, **kwargs): # noqa: E501 """Create a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_bimi_record_with_http_info(generate_bimi_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateBimiRecordOptions generate_bimi_record_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(GenerateBimiRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_bimi_record_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 generate_bimi_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_bimi_record_options' is set if self.api_client.client_side_validation and ('generate_bimi_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_bimi_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_bimi_record_options` when calling `generate_bimi_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_bimi_record_options' in local_var_params: body_params = local_var_params['generate_bimi_record_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( '/tools/generate-bimi-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateBimiRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_dmarc_record(self, generate_dmarc_record_options, **kwargs): # noqa: E501 """Create a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_dmarc_record(generate_dmarc_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateDmarcRecordOptions generate_dmarc_record_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: GenerateDmarcRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_dmarc_record_with_http_info(generate_dmarc_record_options, **kwargs) # noqa: E501 def generate_dmarc_record_with_http_info(self, generate_dmarc_record_options, **kwargs): # noqa: E501 """Create a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_dmarc_record_with_http_info(generate_dmarc_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateDmarcRecordOptions generate_dmarc_record_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(GenerateDmarcRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_dmarc_record_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 generate_dmarc_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_dmarc_record_options' is set if self.api_client.client_side_validation and ('generate_dmarc_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_dmarc_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_dmarc_record_options` when calling `generate_dmarc_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_dmarc_record_options' in local_var_params: body_params = local_var_params['generate_dmarc_record_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( '/tools/generate-dmarc-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateDmarcRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_mta_sts_record(self, generate_mta_sts_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_mta_sts_record(generate_mta_sts_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateMtaStsRecordOptions generate_mta_sts_record_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: GenerateMtaStsRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, **kwargs) # noqa: E501 def generate_mta_sts_record_with_http_info(self, generate_mta_sts_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateMtaStsRecordOptions generate_mta_sts_record_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(GenerateMtaStsRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_mta_sts_record_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 generate_mta_sts_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_mta_sts_record_options' is set if self.api_client.client_side_validation and ('generate_mta_sts_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_mta_sts_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_mta_sts_record_options` when calling `generate_mta_sts_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_mta_sts_record_options' in local_var_params: body_params = local_var_params['generate_mta_sts_record_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( '/tools/generate-mta-sts-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateMtaStsRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_tls_reporting_record(self, generate_tls_reporting_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_tls_reporting_record(generate_tls_reporting_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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: GenerateTlsReportingRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, **kwargs) # noqa: E501 def generate_tls_reporting_record_with_http_info(self, generate_tls_reporting_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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(GenerateTlsReportingRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_tls_reporting_record_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 generate_tls_reporting_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_tls_reporting_record_options' is set if self.api_client.client_side_validation and ('generate_tls_reporting_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_tls_reporting_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_tls_reporting_record_options` when calling `generate_tls_reporting_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_tls_reporting_record_options' in local_var_params: body_params = local_var_params['generate_tls_reporting_record_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( '/tools/generate-tls-reporting-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateTlsReportingRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_fake_email_by_id(self, id, **kwargs): # noqa: E501 """get_fake_email_by_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_fake_email_by_id(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str 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: FakeEmailResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_fake_email_by_id_with_http_info(id, **kwargs) # noqa: E501 def get_fake_email_by_id_with_http_info(self, id, **kwargs): # noqa: E501 """get_fake_email_by_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_fake_email_by_id_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str 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(FakeEmailResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '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_fake_email_by_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_fake_email_by_id`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'id' in local_var_params and local_var_params['id'] is not None: # noqa: E501 query_params.append(('id', local_var_params['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( '/tools/fake-email', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='FakeEmailResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_fake_emails_for_address(self, email_address, **kwargs): # noqa: E501 """get_fake_emails_for_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_fake_emails_for_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param int page: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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[FakeEmailPreview] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_fake_emails_for_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_fake_emails_for_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """get_fake_emails_for_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_fake_emails_for_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 int page: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this 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[FakeEmailPreview], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address', 'page' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, 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_fake_emails_for_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_fake_emails_for_address`") # noqa: E501 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 '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( '/tools/fake-emails', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[FakeEmailPreview]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_bimi_domain(self, lookup_bimi_domain_options, **kwargs): # noqa: E501 """Lookup a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_bimi_domain(lookup_bimi_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupBimiDomainOptions lookup_bimi_domain_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: LookupBimiDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, **kwargs) # noqa: E501 def lookup_bimi_domain_with_http_info(self, lookup_bimi_domain_options, **kwargs): # noqa: E501 """Lookup a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupBimiDomainOptions lookup_bimi_domain_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(LookupBimiDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_bimi_domain_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 lookup_bimi_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_bimi_domain_options' is set if self.api_client.client_side_validation and ('lookup_bimi_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_bimi_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_bimi_domain_options` when calling `lookup_bimi_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_bimi_domain_options' in local_var_params: body_params = local_var_params['lookup_bimi_domain_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( '/tools/lookup-bimi-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupBimiDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_dmarc_domain(self, lookup_dmarc_domain_options, **kwargs): # noqa: E501 """Lookup a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_dmarc_domain(lookup_dmarc_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupDmarcDomainOptions lookup_dmarc_domain_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: LookupDmarcDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, **kwargs) # noqa: E501 def lookup_dmarc_domain_with_http_info(self, lookup_dmarc_domain_options, **kwargs): # noqa: E501 """Lookup a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupDmarcDomainOptions lookup_dmarc_domain_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(LookupDmarcDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_dmarc_domain_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 lookup_dmarc_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_dmarc_domain_options' is set if self.api_client.client_side_validation and ('lookup_dmarc_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_dmarc_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_dmarc_domain_options` when calling `lookup_dmarc_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_dmarc_domain_options' in local_var_params: body_params = local_var_params['lookup_dmarc_domain_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( '/tools/lookup-dmarc-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupDmarcDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_mta_sts_domain(self, lookup_mta_sts_domain_options, **kwargs): # noqa: E501 """Lookup a MTA-STS domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_mta_sts_domain(lookup_mta_sts_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupMtaStsDomainOptions lookup_mta_sts_domain_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: LookupMtaStsDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, **kwargs) # noqa: E501 def lookup_mta_sts_domain_with_http_info(self, lookup_mta_sts_domain_options, **kwargs): # noqa: E501 """Lookup a MTA-STS domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupMtaStsDomainOptions lookup_mta_sts_domain_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(LookupMtaStsDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_mta_sts_domain_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 lookup_mta_sts_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_mta_sts_domain_options' is set if self.api_client.client_side_validation and ('lookup_mta_sts_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_mta_sts_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_mta_sts_domain_options` when calling `lookup_mta_sts_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_mta_sts_domain_options' in local_var_params: body_params = local_var_params['lookup_mta_sts_domain_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( '/tools/lookup-mta-sts-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupMtaStsDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_tls_reporting_domain(self, lookup_tls_reporting_domain_options, **kwargs): # noqa: E501 """Lookup a TLS reporting domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_tls_reporting_domain(lookup_tls_reporting_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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: LookupTlsReportingDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, **kwargs) # noqa: E501 def lookup_tls_reporting_domain_with_http_info(self, lookup_tls_reporting_domain_options, **kwargs): # noqa: E501 """Lookup a TLS reporting domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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(LookupTlsReportingDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_tls_reporting_domain_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 lookup_tls_reporting_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_tls_reporting_domain_options' is set if self.api_client.client_side_validation and ('lookup_tls_reporting_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_tls_reporting_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_tls_reporting_domain_options` when calling `lookup_tls_reporting_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_tls_reporting_domain_options' in local_var_params: body_params = local_var_params['lookup_tls_reporting_domain_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( '/tools/lookup-tls-reporting-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupTlsReportingDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 check_email_features_client_support(self, check_email_features_client_support_options, **kwargs)-
Check email client support for email HTML and CSS features # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_features_client_support(check_email_features_client_support_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailFeaturesClientSupportResults If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_features_client_support(self, check_email_features_client_support_options, **kwargs): # noqa: E501 """Check email client support for email HTML and CSS features # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_features_client_support(check_email_features_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CheckEmailFeaturesClientSupportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_features_client_support_with_http_info(check_email_features_client_support_options, **kwargs) # noqa: E501 def check_email_features_client_support_with_http_info(self, check_email_features_client_support_options, **kwargs)-
Check email client support for email HTML and CSS features # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.check_email_features_client_support_with_http_info(check_email_features_client_support_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailFeaturesClientSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def check_email_features_client_support_with_http_info(self, check_email_features_client_support_options, **kwargs): # noqa: E501 """Check email client support for email HTML and CSS features # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_email_features_client_support_with_http_info(check_email_features_client_support_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailFeaturesClientSupportOptions check_email_features_client_support_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CheckEmailFeaturesClientSupportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_features_client_support_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method check_email_features_client_support" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_features_client_support_options' is set if self.api_client.client_side_validation and ('check_email_features_client_support_options' not in local_var_params or # noqa: E501 local_var_params['check_email_features_client_support_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_features_client_support_options` when calling `check_email_features_client_support`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_features_client_support_options' in local_var_params: body_params = local_var_params['check_email_features_client_support_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/check-email-features-client-support', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailFeaturesClientSupportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_new_fake_email_address(self, **kwargs)-
Create a new email address using the fake email domains # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_new_fake_email_address(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: NewFakeEmailAddressResult If the method is called asynchronously, returns the request thread.
Expand source code
def create_new_fake_email_address(self, **kwargs): # noqa: E501 """Create a new email address using the fake email domains # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_fake_email_address(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: NewFakeEmailAddressResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_fake_email_address_with_http_info(**kwargs) # noqa: E501 def create_new_fake_email_address_with_http_info(self, **kwargs)-
Create a new email address using the fake email domains # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_new_fake_email_address_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(NewFakeEmailAddressResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_new_fake_email_address_with_http_info(self, **kwargs): # noqa: E501 """Create a new email address using the fake email domains # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_new_fake_email_address_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(NewFakeEmailAddressResult, 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_new_fake_email_address" % 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( '/tools/fake-email', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NewFakeEmailAddressResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_bimi_record(self, generate_bimi_record_options, **kwargs)-
Create a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_bimi_record(generate_bimi_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateBimiRecordOptions generate_bimi_record_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: GenerateBimiRecordResults If the method is called asynchronously, returns the request thread.
Expand source code
def generate_bimi_record(self, generate_bimi_record_options, **kwargs): # noqa: E501 """Create a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_bimi_record(generate_bimi_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateBimiRecordOptions generate_bimi_record_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: GenerateBimiRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_bimi_record_with_http_info(generate_bimi_record_options, **kwargs) # noqa: E501 def generate_bimi_record_with_http_info(self, generate_bimi_record_options, **kwargs)-
Create a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_bimi_record_with_http_info(generate_bimi_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateBimiRecordOptions generate_bimi_record_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(GenerateBimiRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def generate_bimi_record_with_http_info(self, generate_bimi_record_options, **kwargs): # noqa: E501 """Create a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_bimi_record_with_http_info(generate_bimi_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateBimiRecordOptions generate_bimi_record_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(GenerateBimiRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_bimi_record_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 generate_bimi_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_bimi_record_options' is set if self.api_client.client_side_validation and ('generate_bimi_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_bimi_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_bimi_record_options` when calling `generate_bimi_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_bimi_record_options' in local_var_params: body_params = local_var_params['generate_bimi_record_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( '/tools/generate-bimi-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateBimiRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_dmarc_record(self, generate_dmarc_record_options, **kwargs)-
Create a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_dmarc_record(generate_dmarc_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateDmarcRecordOptions generate_dmarc_record_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: GenerateDmarcRecordResults If the method is called asynchronously, returns the request thread.
Expand source code
def generate_dmarc_record(self, generate_dmarc_record_options, **kwargs): # noqa: E501 """Create a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_dmarc_record(generate_dmarc_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateDmarcRecordOptions generate_dmarc_record_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: GenerateDmarcRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_dmarc_record_with_http_info(generate_dmarc_record_options, **kwargs) # noqa: E501 def generate_dmarc_record_with_http_info(self, generate_dmarc_record_options, **kwargs)-
Create a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_dmarc_record_with_http_info(generate_dmarc_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateDmarcRecordOptions generate_dmarc_record_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(GenerateDmarcRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def generate_dmarc_record_with_http_info(self, generate_dmarc_record_options, **kwargs): # noqa: E501 """Create a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_dmarc_record_with_http_info(generate_dmarc_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateDmarcRecordOptions generate_dmarc_record_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(GenerateDmarcRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_dmarc_record_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 generate_dmarc_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_dmarc_record_options' is set if self.api_client.client_side_validation and ('generate_dmarc_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_dmarc_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_dmarc_record_options` when calling `generate_dmarc_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_dmarc_record_options' in local_var_params: body_params = local_var_params['generate_dmarc_record_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( '/tools/generate-dmarc-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateDmarcRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_mta_sts_record(self, generate_mta_sts_record_options, **kwargs)-
Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_mta_sts_record(generate_mta_sts_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateMtaStsRecordOptions generate_mta_sts_record_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: GenerateMtaStsRecordResults If the method is called asynchronously, returns the request thread.
Expand source code
def generate_mta_sts_record(self, generate_mta_sts_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_mta_sts_record(generate_mta_sts_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateMtaStsRecordOptions generate_mta_sts_record_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: GenerateMtaStsRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, **kwargs) # noqa: E501 def generate_mta_sts_record_with_http_info(self, generate_mta_sts_record_options, **kwargs)-
Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateMtaStsRecordOptions generate_mta_sts_record_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(GenerateMtaStsRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def generate_mta_sts_record_with_http_info(self, generate_mta_sts_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateMtaStsRecordOptions generate_mta_sts_record_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(GenerateMtaStsRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_mta_sts_record_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 generate_mta_sts_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_mta_sts_record_options' is set if self.api_client.client_side_validation and ('generate_mta_sts_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_mta_sts_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_mta_sts_record_options` when calling `generate_mta_sts_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_mta_sts_record_options' in local_var_params: body_params = local_var_params['generate_mta_sts_record_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( '/tools/generate-mta-sts-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateMtaStsRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_tls_reporting_record(self, generate_tls_reporting_record_options, **kwargs)-
Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_tls_reporting_record(generate_tls_reporting_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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: GenerateTlsReportingRecordResults If the method is called asynchronously, returns the request thread.
Expand source code
def generate_tls_reporting_record(self, generate_tls_reporting_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_tls_reporting_record(generate_tls_reporting_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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: GenerateTlsReportingRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, **kwargs) # noqa: E501 def generate_tls_reporting_record_with_http_info(self, generate_tls_reporting_record_options, **kwargs)-
Create a TLS reporting record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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(GenerateTlsReportingRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def generate_tls_reporting_record_with_http_info(self, generate_tls_reporting_record_options, **kwargs): # noqa: E501 """Create a TLS reporting record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateTlsReportingRecordOptions generate_tls_reporting_record_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(GenerateTlsReportingRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_tls_reporting_record_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 generate_tls_reporting_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_tls_reporting_record_options' is set if self.api_client.client_side_validation and ('generate_tls_reporting_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_tls_reporting_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_tls_reporting_record_options` when calling `generate_tls_reporting_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_tls_reporting_record_options' in local_var_params: body_params = local_var_params['generate_tls_reporting_record_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( '/tools/generate-tls-reporting-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateTlsReportingRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_fake_email_by_id(self, id, **kwargs)-
get_fake_email_by_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_fake_email_by_id(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str 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: FakeEmailResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_fake_email_by_id(self, id, **kwargs): # noqa: E501 """get_fake_email_by_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_fake_email_by_id(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str 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: FakeEmailResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_fake_email_by_id_with_http_info(id, **kwargs) # noqa: E501 def get_fake_email_by_id_with_http_info(self, id, **kwargs)-
get_fake_email_by_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_fake_email_by_id_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str 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(FakeEmailResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_fake_email_by_id_with_http_info(self, id, **kwargs): # noqa: E501 """get_fake_email_by_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_fake_email_by_id_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str 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(FakeEmailResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '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_fake_email_by_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_fake_email_by_id`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'id' in local_var_params and local_var_params['id'] is not None: # noqa: E501 query_params.append(('id', local_var_params['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( '/tools/fake-email', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='FakeEmailResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_fake_emails_for_address(self, email_address, **kwargs)-
get_fake_emails_for_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_fake_emails_for_address(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param int page: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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[FakeEmailPreview] If the method is called asynchronously, returns the request thread.
Expand source code
def get_fake_emails_for_address(self, email_address, **kwargs): # noqa: E501 """get_fake_emails_for_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_fake_emails_for_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param int page: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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[FakeEmailPreview] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_fake_emails_for_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_fake_emails_for_address_with_http_info(self, email_address, **kwargs)-
get_fake_emails_for_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_fake_emails_for_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 int page: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this 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[FakeEmailPreview], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_fake_emails_for_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """get_fake_emails_for_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_fake_emails_for_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 int page: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this 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[FakeEmailPreview], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address', 'page' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, 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_fake_emails_for_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_fake_emails_for_address`") # noqa: E501 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 '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( '/tools/fake-emails', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[FakeEmailPreview]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_bimi_domain(self, lookup_bimi_domain_options, **kwargs)-
Lookup a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_bimi_domain(lookup_bimi_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupBimiDomainOptions lookup_bimi_domain_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: LookupBimiDomainResults If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_bimi_domain(self, lookup_bimi_domain_options, **kwargs): # noqa: E501 """Lookup a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_bimi_domain(lookup_bimi_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupBimiDomainOptions lookup_bimi_domain_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: LookupBimiDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, **kwargs) # noqa: E501 def lookup_bimi_domain_with_http_info(self, lookup_bimi_domain_options, **kwargs)-
Lookup a BIMI record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupBimiDomainOptions lookup_bimi_domain_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(LookupBimiDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_bimi_domain_with_http_info(self, lookup_bimi_domain_options, **kwargs): # noqa: E501 """Lookup a BIMI record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupBimiDomainOptions lookup_bimi_domain_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(LookupBimiDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_bimi_domain_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 lookup_bimi_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_bimi_domain_options' is set if self.api_client.client_side_validation and ('lookup_bimi_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_bimi_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_bimi_domain_options` when calling `lookup_bimi_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_bimi_domain_options' in local_var_params: body_params = local_var_params['lookup_bimi_domain_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( '/tools/lookup-bimi-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupBimiDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_dmarc_domain(self, lookup_dmarc_domain_options, **kwargs)-
Lookup a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_dmarc_domain(lookup_dmarc_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupDmarcDomainOptions lookup_dmarc_domain_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: LookupDmarcDomainResults If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_dmarc_domain(self, lookup_dmarc_domain_options, **kwargs): # noqa: E501 """Lookup a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_dmarc_domain(lookup_dmarc_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupDmarcDomainOptions lookup_dmarc_domain_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: LookupDmarcDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, **kwargs) # noqa: E501 def lookup_dmarc_domain_with_http_info(self, lookup_dmarc_domain_options, **kwargs)-
Lookup a DMARC record policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupDmarcDomainOptions lookup_dmarc_domain_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(LookupDmarcDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_dmarc_domain_with_http_info(self, lookup_dmarc_domain_options, **kwargs): # noqa: E501 """Lookup a DMARC record policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupDmarcDomainOptions lookup_dmarc_domain_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(LookupDmarcDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_dmarc_domain_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 lookup_dmarc_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_dmarc_domain_options' is set if self.api_client.client_side_validation and ('lookup_dmarc_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_dmarc_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_dmarc_domain_options` when calling `lookup_dmarc_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_dmarc_domain_options' in local_var_params: body_params = local_var_params['lookup_dmarc_domain_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( '/tools/lookup-dmarc-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupDmarcDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_mta_sts_domain(self, lookup_mta_sts_domain_options, **kwargs)-
Lookup a MTA-STS domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_mta_sts_domain(lookup_mta_sts_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupMtaStsDomainOptions lookup_mta_sts_domain_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: LookupMtaStsDomainResults If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_mta_sts_domain(self, lookup_mta_sts_domain_options, **kwargs): # noqa: E501 """Lookup a MTA-STS domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_mta_sts_domain(lookup_mta_sts_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupMtaStsDomainOptions lookup_mta_sts_domain_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: LookupMtaStsDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, **kwargs) # noqa: E501 def lookup_mta_sts_domain_with_http_info(self, lookup_mta_sts_domain_options, **kwargs)-
Lookup a MTA-STS domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupMtaStsDomainOptions lookup_mta_sts_domain_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(LookupMtaStsDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_mta_sts_domain_with_http_info(self, lookup_mta_sts_domain_options, **kwargs): # noqa: E501 """Lookup a MTA-STS domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupMtaStsDomainOptions lookup_mta_sts_domain_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(LookupMtaStsDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_mta_sts_domain_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 lookup_mta_sts_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_mta_sts_domain_options' is set if self.api_client.client_side_validation and ('lookup_mta_sts_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_mta_sts_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_mta_sts_domain_options` when calling `lookup_mta_sts_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_mta_sts_domain_options' in local_var_params: body_params = local_var_params['lookup_mta_sts_domain_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( '/tools/lookup-mta-sts-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupMtaStsDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def lookup_tls_reporting_domain(self, lookup_tls_reporting_domain_options, **kwargs)-
Lookup a TLS reporting domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_tls_reporting_domain(lookup_tls_reporting_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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: LookupTlsReportingDomainResults If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_tls_reporting_domain(self, lookup_tls_reporting_domain_options, **kwargs): # noqa: E501 """Lookup a TLS reporting domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_tls_reporting_domain(lookup_tls_reporting_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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: LookupTlsReportingDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, **kwargs) # noqa: E501 def lookup_tls_reporting_domain_with_http_info(self, lookup_tls_reporting_domain_options, **kwargs)-
Lookup a TLS reporting domain policy # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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(LookupTlsReportingDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def lookup_tls_reporting_domain_with_http_info(self, lookup_tls_reporting_domain_options, **kwargs): # noqa: E501 """Lookup a TLS reporting domain policy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupTlsReportingDomainOptions lookup_tls_reporting_domain_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(LookupTlsReportingDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_tls_reporting_domain_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 lookup_tls_reporting_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_tls_reporting_domain_options' is set if self.api_client.client_side_validation and ('lookup_tls_reporting_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_tls_reporting_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_tls_reporting_domain_options` when calling `lookup_tls_reporting_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_tls_reporting_domain_options' in local_var_params: body_params = local_var_params['lookup_tls_reporting_domain_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( '/tools/lookup-tls-reporting-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupTlsReportingDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)