Module mailslurp_client.api.tools_controller_api
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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
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 analyze_dmarc_report(self, analyze_dmarc_report_options, **kwargs): # noqa: E501 """Parse and summarize a DMARC aggregate XML report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.analyze_dmarc_report(analyze_dmarc_report_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AnalyzeDmarcReportOptions analyze_dmarc_report_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: AnalyzeDmarcReportResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, **kwargs) # noqa: E501 def analyze_dmarc_report_with_http_info(self, analyze_dmarc_report_options, **kwargs): # noqa: E501 """Parse and summarize a DMARC aggregate XML report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AnalyzeDmarcReportOptions analyze_dmarc_report_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(AnalyzeDmarcReportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'analyze_dmarc_report_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 analyze_dmarc_report" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'analyze_dmarc_report_options' is set if self.api_client.client_side_validation and ('analyze_dmarc_report_options' not in local_var_params or # noqa: E501 local_var_params['analyze_dmarc_report_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `analyze_dmarc_report_options` when calling `analyze_dmarc_report`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'analyze_dmarc_report_options' in local_var_params: body_params = local_var_params['analyze_dmarc_report_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/analyze-dmarc-report', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AnalyzeDmarcReportResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def analyze_email_headers(self, analyze_email_headers_options, **kwargs): # noqa: E501 """Analyze email headers for auth results and delivery path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.analyze_email_headers(analyze_email_headers_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AnalyzeEmailHeadersOptions analyze_email_headers_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: AnalyzeEmailHeadersResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.analyze_email_headers_with_http_info(analyze_email_headers_options, **kwargs) # noqa: E501 def analyze_email_headers_with_http_info(self, analyze_email_headers_options, **kwargs): # noqa: E501 """Analyze email headers for auth results and delivery path # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.analyze_email_headers_with_http_info(analyze_email_headers_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AnalyzeEmailHeadersOptions analyze_email_headers_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(AnalyzeEmailHeadersResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'analyze_email_headers_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 analyze_email_headers" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'analyze_email_headers_options' is set if self.api_client.client_side_validation and ('analyze_email_headers_options' not in local_var_params or # noqa: E501 local_var_params['analyze_email_headers_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `analyze_email_headers_options` when calling `analyze_email_headers`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'analyze_email_headers_options' in local_var_params: body_params = local_var_params['analyze_email_headers_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/analyze-email-headers', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AnalyzeEmailHeadersResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_campaign_probe(self, check_campaign_probe_options, **kwargs): # noqa: E501 """Run a one-shot free campaign probe preflight check # 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_campaign_probe(check_campaign_probe_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckCampaignProbeOptions check_campaign_probe_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: CheckCampaignProbeResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_campaign_probe_with_http_info(check_campaign_probe_options, **kwargs) # noqa: E501 def check_campaign_probe_with_http_info(self, check_campaign_probe_options, **kwargs): # noqa: E501 """Run a one-shot free campaign probe preflight check # 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_campaign_probe_with_http_info(check_campaign_probe_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckCampaignProbeOptions check_campaign_probe_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(CheckCampaignProbeResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_campaign_probe_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_campaign_probe" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_campaign_probe_options' is set if self.api_client.client_side_validation and ('check_campaign_probe_options' not in local_var_params or # noqa: E501 local_var_params['check_campaign_probe_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_campaign_probe_options` when calling `check_campaign_probe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_campaign_probe_options' in local_var_params: body_params = local_var_params['check_campaign_probe_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-campaign-probe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckCampaignProbeResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_dns_propagation(self, check_dns_propagation_options, **kwargs): # noqa: E501 """Check DNS propagation for a host and record type across configured resolvers # 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_dns_propagation(check_dns_propagation_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckDnsPropagationOptions check_dns_propagation_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: CheckDnsPropagationResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_dns_propagation_with_http_info(check_dns_propagation_options, **kwargs) # noqa: E501 def check_dns_propagation_with_http_info(self, check_dns_propagation_options, **kwargs): # noqa: E501 """Check DNS propagation for a host and record type across configured resolvers # 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_dns_propagation_with_http_info(check_dns_propagation_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckDnsPropagationOptions check_dns_propagation_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(CheckDnsPropagationResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_dns_propagation_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_dns_propagation" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_dns_propagation_options' is set if self.api_client.client_side_validation and ('check_dns_propagation_options' not in local_var_params or # noqa: E501 local_var_params['check_dns_propagation_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_dns_propagation_options` when calling `check_dns_propagation`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_dns_propagation_options' in local_var_params: body_params = local_var_params['check_dns_propagation_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-dns-propagation', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckDnsPropagationResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_domain_monitor(self, check_domain_monitor_options, **kwargs): # noqa: E501 """Run a one-shot free domain monitor posture check # 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_domain_monitor(check_domain_monitor_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckDomainMonitorOptions check_domain_monitor_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: CheckDomainMonitorResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_domain_monitor_with_http_info(check_domain_monitor_options, **kwargs) # noqa: E501 def check_domain_monitor_with_http_info(self, check_domain_monitor_options, **kwargs): # noqa: E501 """Run a one-shot free domain monitor posture check # 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_domain_monitor_with_http_info(check_domain_monitor_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckDomainMonitorOptions check_domain_monitor_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(CheckDomainMonitorResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_domain_monitor_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_domain_monitor" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_domain_monitor_options' is set if self.api_client.client_side_validation and ('check_domain_monitor_options' not in local_var_params or # noqa: E501 local_var_params['check_domain_monitor_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_domain_monitor_options` when calling `check_domain_monitor`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_domain_monitor_options' in local_var_params: body_params = local_var_params['check_domain_monitor_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-domain-monitor', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckDomainMonitorResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_audit(self, check_email_audit_options, **kwargs): # noqa: E501 """Run a one-shot free email audit across links, images, HTML, and client support # 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_audit(check_email_audit_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailAuditOptions check_email_audit_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: EmailAuditAnalysisResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_audit_with_http_info(check_email_audit_options, **kwargs) # noqa: E501 def check_email_audit_with_http_info(self, check_email_audit_options, **kwargs): # noqa: E501 """Run a one-shot free email audit across links, images, HTML, and client support # 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_audit_with_http_info(check_email_audit_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailAuditOptions check_email_audit_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(EmailAuditAnalysisResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_audit_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_audit" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_audit_options' is set if self.api_client.client_side_validation and ('check_email_audit_options' not in local_var_params or # noqa: E501 local_var_params['check_email_audit_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_audit_options` when calling `check_email_audit`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_audit_options' in local_var_params: body_params = local_var_params['check_email_audit_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-audit', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailAuditAnalysisResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_auth_stack(self, check_email_auth_stack_options, **kwargs): # noqa: E501 """Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check # 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_auth_stack(check_email_auth_stack_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailAuthStackOptions check_email_auth_stack_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: CheckEmailAuthStackResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_auth_stack_with_http_info(check_email_auth_stack_options, **kwargs) # noqa: E501 def check_email_auth_stack_with_http_info(self, check_email_auth_stack_options, **kwargs): # noqa: E501 """Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check # 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_auth_stack_with_http_info(check_email_auth_stack_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailAuthStackOptions check_email_auth_stack_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(CheckEmailAuthStackResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_auth_stack_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_auth_stack" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_auth_stack_options' is set if self.api_client.client_side_validation and ('check_email_auth_stack_options' not in local_var_params or # noqa: E501 local_var_params['check_email_auth_stack_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_auth_stack_options` when calling `check_email_auth_stack`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_auth_stack_options' in local_var_params: body_params = local_var_params['check_email_auth_stack_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-auth-stack', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailAuthStackResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_blacklist(self, check_email_blacklist_options, **kwargs): # noqa: E501 """Check whether a domain or IP appears on configured DNS blacklists # 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_blacklist(check_email_blacklist_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailBlacklistOptions check_email_blacklist_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: CheckEmailBlacklistResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.check_email_blacklist_with_http_info(check_email_blacklist_options, **kwargs) # noqa: E501 def check_email_blacklist_with_http_info(self, check_email_blacklist_options, **kwargs): # noqa: E501 """Check whether a domain or IP appears on configured DNS blacklists # 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_blacklist_with_http_info(check_email_blacklist_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CheckEmailBlacklistOptions check_email_blacklist_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(CheckEmailBlacklistResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'check_email_blacklist_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_blacklist" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'check_email_blacklist_options' is set if self.api_client.client_side_validation and ('check_email_blacklist_options' not in local_var_params or # noqa: E501 local_var_params['check_email_blacklist_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `check_email_blacklist_options` when calling `check_email_blacklist`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'check_email_blacklist_options' in local_var_params: body_params = local_var_params['check_email_blacklist_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-blacklists', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CheckEmailBlacklistResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def check_email_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 create_public_device_render_test(self, create_public_device_render_test_options, **kwargs): # noqa: E501 """Create a public email render test # noqa: E501 Creates an unauthenticated free email render test and returns a short-lived generated email address. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_public_device_render_test(create_public_device_render_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePublicDeviceRenderTestOptions create_public_device_render_test_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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_public_device_render_test_with_http_info(create_public_device_render_test_options, **kwargs) # noqa: E501 def create_public_device_render_test_with_http_info(self, create_public_device_render_test_options, **kwargs): # noqa: E501 """Create a public email render test # noqa: E501 Creates an unauthenticated free email render test and returns a short-lived generated email address. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_public_device_render_test_with_http_info(create_public_device_render_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePublicDeviceRenderTestOptions create_public_device_render_test_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_public_device_render_test_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_public_device_render_test" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_public_device_render_test_options' is set if self.api_client.client_side_validation and ('create_public_device_render_test_options' not in local_var_params or # noqa: E501 local_var_params['create_public_device_render_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_public_device_render_test_options` when calling `create_public_device_render_test`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_public_device_render_test_options' in local_var_params: body_params = local_var_params['create_public_device_render_test_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/device-render-test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicDeviceRenderTestDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_public_spam_test(self, create_public_spam_test_options, **kwargs): # noqa: E501 """Create a public spam test # noqa: E501 Create an unauthenticated inbox placement run for public tools users. Returns seed addresses and a tracking token immediately. # 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_public_spam_test(create_public_spam_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePublicSpamTestOptions create_public_spam_test_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: PublicSpamTestRunDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_public_spam_test_with_http_info(create_public_spam_test_options, **kwargs) # noqa: E501 def create_public_spam_test_with_http_info(self, create_public_spam_test_options, **kwargs): # noqa: E501 """Create a public spam test # noqa: E501 Create an unauthenticated inbox placement run for public tools users. Returns seed addresses and a tracking token immediately. # 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_public_spam_test_with_http_info(create_public_spam_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePublicSpamTestOptions create_public_spam_test_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(PublicSpamTestRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_public_spam_test_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_public_spam_test" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_public_spam_test_options' is set if self.api_client.client_side_validation and ('create_public_spam_test_options' not in local_var_params or # noqa: E501 local_var_params['create_public_spam_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_public_spam_test_options` when calling `create_public_spam_test`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_public_spam_test_options' in local_var_params: body_params = local_var_params['create_public_spam_test_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/spam-test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicSpamTestRunDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_new_fake_email_address(self, email_address, **kwargs): # noqa: E501 """Delete a fake email address using the fake email domains # noqa: E501 Delete a fake 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.delete_new_fake_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_new_fake_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def delete_new_fake_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """Delete a fake email address using the fake email domains # noqa: E501 Delete a fake 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.delete_new_fake_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_new_fake_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `delete_new_fake_email_address`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/fake-email', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def 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_spf_record(self, generate_spf_record_options, **kwargs): # noqa: E501 """Create an SPF record # 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_spf_record(generate_spf_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateSpfRecordOptions generate_spf_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: GenerateSpfRecordResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_spf_record_with_http_info(generate_spf_record_options, **kwargs) # noqa: E501 def generate_spf_record_with_http_info(self, generate_spf_record_options, **kwargs): # noqa: E501 """Create an SPF record # 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_spf_record_with_http_info(generate_spf_record_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateSpfRecordOptions generate_spf_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(GenerateSpfRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_spf_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_spf_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_spf_record_options' is set if self.api_client.client_side_validation and ('generate_spf_record_options' not in local_var_params or # noqa: E501 local_var_params['generate_spf_record_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_spf_record_options` when calling `generate_spf_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_spf_record_options' in local_var_params: body_params = local_var_params['generate_spf_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-spf-record', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GenerateSpfRecordResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_email_address(self, email_address, **kwargs): # noqa: E501 """get_fake_email_by_email_address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_fake_email_by_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: FakeEmailResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_fake_email_by_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_fake_email_by_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """get_fake_email_by_email_address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_fake_email_by_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(FakeEmailResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_address' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_fake_email_by_email_address" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_address' is set if self.api_client.client_side_validation and ('email_address' not in local_var_params or # noqa: E501 local_var_params['email_address'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_address` when calling `get_fake_email_by_email_address`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_address' in local_var_params and local_var_params['email_address'] is not None: # noqa: E501 query_params.append(('emailAddress', local_var_params['email_address'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/fake-email/byEmailAddress', '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_email_by_id(self, id, **kwargs): # noqa: E501 """Get a fake email by its ID # noqa: E501 Get a fake email by its 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 a fake email by its ID # noqa: E501 Get a fake email by its 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_email_raw(self, id, **kwargs): # noqa: E501 """Get raw fake email content # noqa: E501 Retrieve the raw content of a fake email by its 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_raw(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: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_fake_email_raw_with_http_info(id, **kwargs) # noqa: E501 def get_fake_email_raw_with_http_info(self, id, **kwargs): # noqa: E501 """Get raw fake email content # noqa: E501 Retrieve the raw content of a fake email by its 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_raw_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(str, 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_raw" % 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_raw`") # 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( ['text/plain;charset=utf-8', 'text/html;charset=utf-8', 'text/plain; charset=utf-8', 'text/html; charset=utf-8']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/fake-email/html', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_fake_emails_for_address(self, email_address, **kwargs): # noqa: E501 """Get fake emails for an address # noqa: E501 Get fake emails for an 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 an address # noqa: E501 Get fake emails for an 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 get_public_device_render_targets(self, **kwargs): # noqa: E501 """List available public email render targets # noqa: E501 Returns the currently healthy target choices exposed by the free email render tool. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_device_render_targets(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: PublicDeviceRenderTargetListDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_public_device_render_targets_with_http_info(**kwargs) # noqa: E501 def get_public_device_render_targets_with_http_info(self, **kwargs): # noqa: E501 """List available public email render targets # noqa: E501 Returns the currently healthy target choices exposed by the free email render tool. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_device_render_targets_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(PublicDeviceRenderTargetListDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_public_device_render_targets" % 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/device-render-test/targets', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicDeviceRenderTargetListDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_public_device_render_test(self, id, **kwargs): # noqa: E501 """Get a public email render test # noqa: E501 Returns status for a free email render test and the public share redirect when the render run is ready. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_device_render_test(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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_public_device_render_test_with_http_info(id, **kwargs) # noqa: E501 def get_public_device_render_test_with_http_info(self, id, **kwargs): # noqa: E501 """Get a public email render test # noqa: E501 Returns status for a free email render test and the public share redirect when the render run is ready. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_device_render_test_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(PublicDeviceRenderTestDto, 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_public_device_render_test" % 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_public_device_render_test`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/device-render-test/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicDeviceRenderTestDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_public_email_preview_content(self, id, **kwargs): # noqa: E501 """Get light and dark public email preview content # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_email_preview_content(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: PublicEmailPreviewContentDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_public_email_preview_content_with_http_info(id, **kwargs) # noqa: E501 def get_public_email_preview_content_with_http_info(self, id, **kwargs): # noqa: E501 """Get light and dark public email preview content # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_email_preview_content_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(PublicEmailPreviewContentDto, 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_public_email_preview_content" % 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_public_email_preview_content`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/device-render-test/{id}/content', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicEmailPreviewContentDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_public_spam_test(self, id, **kwargs): # noqa: E501 """Get a public spam test run # noqa: E501 Returns public spam test run status, token, seed addresses, and free-limit state. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_spam_test(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: PublicSpamTestRunDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_public_spam_test_with_http_info(id, **kwargs) # noqa: E501 def get_public_spam_test_with_http_info(self, id, **kwargs): # noqa: E501 """Get a public spam test run # noqa: E501 Returns public spam test run status, token, seed addresses, and free-limit state. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_spam_test_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(PublicSpamTestRunDto, 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_public_spam_test" % 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_public_spam_test`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/spam-test/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicSpamTestRunDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_public_spam_test_results(self, id, **kwargs): # noqa: E501 """Get public spam test results # noqa: E501 Returns public spam test run status and any available inbox placement results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_spam_test_results(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: PublicSpamTestResultsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_public_spam_test_results_with_http_info(id, **kwargs) # noqa: E501 def get_public_spam_test_results_with_http_info(self, id, **kwargs): # noqa: E501 """Get public spam test results # noqa: E501 Returns public spam test run status and any available inbox placement results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_public_spam_test_results_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(PublicSpamTestResultsDto, 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_public_spam_test_results" % 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_public_spam_test_results`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/spam-test/{id}/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicSpamTestResultsDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_dkim_domain(self, lookup_dkim_domain_options, **kwargs): # noqa: E501 """Lookup and validate a DKIM record # 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_dkim_domain(lookup_dkim_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupDkimDomainOptions lookup_dkim_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: LookupDkimDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_dkim_domain_with_http_info(lookup_dkim_domain_options, **kwargs) # noqa: E501 def lookup_dkim_domain_with_http_info(self, lookup_dkim_domain_options, **kwargs): # noqa: E501 """Lookup and validate a DKIM record # 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_dkim_domain_with_http_info(lookup_dkim_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupDkimDomainOptions lookup_dkim_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(LookupDkimDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_dkim_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_dkim_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_dkim_domain_options' is set if self.api_client.client_side_validation and ('lookup_dkim_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_dkim_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_dkim_domain_options` when calling `lookup_dkim_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_dkim_domain_options' in local_var_params: body_params = local_var_params['lookup_dkim_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-dkim-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupDkimDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_mx_record(self, lookup_mx_records_options, **kwargs): # noqa: E501 """Lookup a MX records for a domain # 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_mx_record(lookup_mx_records_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupMxRecordsOptions lookup_mx_records_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: LookupMxRecordsResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_mx_record_with_http_info(lookup_mx_records_options, **kwargs) # noqa: E501 def lookup_mx_record_with_http_info(self, lookup_mx_records_options, **kwargs): # noqa: E501 """Lookup a MX records for a domain # 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_mx_record_with_http_info(lookup_mx_records_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupMxRecordsOptions lookup_mx_records_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(LookupMxRecordsResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_mx_records_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_mx_record" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_mx_records_options' is set if self.api_client.client_side_validation and ('lookup_mx_records_options' not in local_var_params or # noqa: E501 local_var_params['lookup_mx_records_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_mx_records_options` when calling `lookup_mx_record`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_mx_records_options' in local_var_params: body_params = local_var_params['lookup_mx_records_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-mx-records', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupMxRecordsResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_ptr(self, lookup_ptr_options, **kwargs): # noqa: E501 """Lookup PTR records for an IP 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.lookup_ptr(lookup_ptr_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupPtrOptions lookup_ptr_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: LookupPtrResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_ptr_with_http_info(lookup_ptr_options, **kwargs) # noqa: E501 def lookup_ptr_with_http_info(self, lookup_ptr_options, **kwargs): # noqa: E501 """Lookup PTR records for an IP 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.lookup_ptr_with_http_info(lookup_ptr_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupPtrOptions lookup_ptr_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(LookupPtrResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_ptr_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_ptr" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_ptr_options' is set if self.api_client.client_side_validation and ('lookup_ptr_options' not in local_var_params or # noqa: E501 local_var_params['lookup_ptr_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_ptr_options` when calling `lookup_ptr`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_ptr_options' in local_var_params: body_params = local_var_params['lookup_ptr_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-ptr', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupPtrResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_spf_domain(self, lookup_spf_domain_options, **kwargs): # noqa: E501 """Lookup and validate an SPF record # 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_spf_domain(lookup_spf_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupSpfDomainOptions lookup_spf_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: LookupSpfDomainResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.lookup_spf_domain_with_http_info(lookup_spf_domain_options, **kwargs) # noqa: E501 def lookup_spf_domain_with_http_info(self, lookup_spf_domain_options, **kwargs): # noqa: E501 """Lookup and validate an SPF record # 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_spf_domain_with_http_info(lookup_spf_domain_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param LookupSpfDomainOptions lookup_spf_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(LookupSpfDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'lookup_spf_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_spf_domain" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'lookup_spf_domain_options' is set if self.api_client.client_side_validation and ('lookup_spf_domain_options' not in local_var_params or # noqa: E501 local_var_params['lookup_spf_domain_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `lookup_spf_domain_options` when calling `lookup_spf_domain`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'lookup_spf_domain_options' in local_var_params: body_params = local_var_params['lookup_spf_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-spf-domain', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='LookupSpfDomainResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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) def submit_public_device_render_eml(self, id, **kwargs): # noqa: E501 """Submit an EML file to a public email render test # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_device_render_eml(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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.submit_public_device_render_eml_with_http_info(id, **kwargs) # noqa: E501 def submit_public_device_render_eml_with_http_info(self, id, **kwargs): # noqa: E501 """Submit an EML file to a public email render test # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_device_render_eml_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(PublicDeviceRenderTestDto, 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 submit_public_device_render_eml" % 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 `submit_public_device_render_eml`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/device-render-test/{id}/eml', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicDeviceRenderTestDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def submit_public_device_render_html(self, id, submit_public_device_render_html_options, **kwargs): # noqa: E501 """Submit HTML to a public email render test # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_device_render_html(id, submit_public_device_render_html_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicDeviceRenderHtmlOptions submit_public_device_render_html_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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.submit_public_device_render_html_with_http_info(id, submit_public_device_render_html_options, **kwargs) # noqa: E501 def submit_public_device_render_html_with_http_info(self, id, submit_public_device_render_html_options, **kwargs): # noqa: E501 """Submit HTML to a public email render test # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_device_render_html_with_http_info(id, submit_public_device_render_html_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicDeviceRenderHtmlOptions submit_public_device_render_html_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'submit_public_device_render_html_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 submit_public_device_render_html" % 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 `submit_public_device_render_html`") # noqa: E501 # verify the required parameter 'submit_public_device_render_html_options' is set if self.api_client.client_side_validation and ('submit_public_device_render_html_options' not in local_var_params or # noqa: E501 local_var_params['submit_public_device_render_html_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `submit_public_device_render_html_options` when calling `submit_public_device_render_html`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'submit_public_device_render_html_options' in local_var_params: body_params = local_var_params['submit_public_device_render_html_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/device-render-test/{id}/html', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicDeviceRenderTestDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def submit_public_device_render_test(self, id, **kwargs): # noqa: E501 """Mark a public email render test as submitted # noqa: E501 Records that the caller sent an email to the generated address so submission and delivery failures can be distinguished from setup abandonment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_device_render_test(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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.submit_public_device_render_test_with_http_info(id, **kwargs) # noqa: E501 def submit_public_device_render_test_with_http_info(self, id, **kwargs): # noqa: E501 """Mark a public email render test as submitted # noqa: E501 Records that the caller sent an email to the generated address so submission and delivery failures can be distinguished from setup abandonment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_device_render_test_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(PublicDeviceRenderTestDto, 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 submit_public_device_render_test" % 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 `submit_public_device_render_test`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tools/device-render-test/{id}/submit', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicDeviceRenderTestDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def submit_public_spam_test(self, id, submit_public_spam_test_options, **kwargs): # noqa: E501 """Mark a public spam test as submitted # noqa: E501 Marks a previously created public spam test as submitted after the caller has sent the test email to the seed addresses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_spam_test(id, submit_public_spam_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicSpamTestOptions submit_public_spam_test_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: PublicSpamTestRunDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.submit_public_spam_test_with_http_info(id, submit_public_spam_test_options, **kwargs) # noqa: E501 def submit_public_spam_test_with_http_info(self, id, submit_public_spam_test_options, **kwargs): # noqa: E501 """Mark a public spam test as submitted # noqa: E501 Marks a previously created public spam test as submitted after the caller has sent the test email to the seed addresses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.submit_public_spam_test_with_http_info(id, submit_public_spam_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicSpamTestOptions submit_public_spam_test_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(PublicSpamTestRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'submit_public_spam_test_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 submit_public_spam_test" % 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 `submit_public_spam_test`") # noqa: E501 # verify the required parameter 'submit_public_spam_test_options' is set if self.api_client.client_side_validation and ('submit_public_spam_test_options' not in local_var_params or # noqa: E501 local_var_params['submit_public_spam_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `submit_public_spam_test_options` when calling `submit_public_spam_test`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'submit_public_spam_test_options' in local_var_params: body_params = local_var_params['submit_public_spam_test_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/spam-test/{id}/submit', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PublicSpamTestRunDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def test_smtp_server(self, test_smtp_server_options, **kwargs): # noqa: E501 """Run a conservative SMTP connectivity, TLS, and AUTH diagnostic # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_smtp_server(test_smtp_server_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TestSmtpServerOptions test_smtp_server_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: TestSmtpServerResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_smtp_server_with_http_info(test_smtp_server_options, **kwargs) # noqa: E501 def test_smtp_server_with_http_info(self, test_smtp_server_options, **kwargs): # noqa: E501 """Run a conservative SMTP connectivity, TLS, and AUTH diagnostic # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_smtp_server_with_http_info(test_smtp_server_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TestSmtpServerOptions test_smtp_server_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(TestSmtpServerResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'test_smtp_server_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 test_smtp_server" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'test_smtp_server_options' is set if self.api_client.client_side_validation and ('test_smtp_server_options' not in local_var_params or # noqa: E501 local_var_params['test_smtp_server_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `test_smtp_server_options` when calling `test_smtp_server`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'test_smtp_server_options' in local_var_params: body_params = local_var_params['test_smtp_server_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/test-smtp-server', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TestSmtpServerResults', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 analyze_dmarc_report(self, analyze_dmarc_report_options, **kwargs)-
Parse and summarize a DMARC aggregate XML report # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.analyze_dmarc_report(analyze_dmarc_report_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AnalyzeDmarcReportOptions analyze_dmarc_report_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: AnalyzeDmarcReportResults If the method is called asynchronously, returns the request thread.
def analyze_dmarc_report_with_http_info(self, analyze_dmarc_report_options, **kwargs)-
Parse and summarize a DMARC aggregate XML report # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AnalyzeDmarcReportOptions analyze_dmarc_report_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(AnalyzeDmarcReportResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def analyze_email_headers(self, analyze_email_headers_options, **kwargs)-
Analyze email headers for auth results and delivery path # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.analyze_email_headers(analyze_email_headers_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AnalyzeEmailHeadersOptions analyze_email_headers_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: AnalyzeEmailHeadersResults If the method is called asynchronously, returns the request thread.
def analyze_email_headers_with_http_info(self, analyze_email_headers_options, **kwargs)-
Analyze email headers for auth results and delivery path # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.analyze_email_headers_with_http_info(analyze_email_headers_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AnalyzeEmailHeadersOptions analyze_email_headers_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(AnalyzeEmailHeadersResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def check_campaign_probe(self, check_campaign_probe_options, **kwargs)-
Run a one-shot free campaign probe preflight check # 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_campaign_probe(check_campaign_probe_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckCampaignProbeOptions check_campaign_probe_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: CheckCampaignProbeResults If the method is called asynchronously, returns the request thread.
def check_campaign_probe_with_http_info(self, check_campaign_probe_options, **kwargs)-
Run a one-shot free campaign probe preflight check # 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_campaign_probe_with_http_info(check_campaign_probe_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckCampaignProbeOptions check_campaign_probe_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(CheckCampaignProbeResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def check_dns_propagation(self, check_dns_propagation_options, **kwargs)-
Check DNS propagation for a host and record type across configured resolvers # 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_dns_propagation(check_dns_propagation_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckDnsPropagationOptions check_dns_propagation_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: CheckDnsPropagationResults If the method is called asynchronously, returns the request thread.
def check_dns_propagation_with_http_info(self, check_dns_propagation_options, **kwargs)-
Check DNS propagation for a host and record type across configured resolvers # 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_dns_propagation_with_http_info(check_dns_propagation_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckDnsPropagationOptions check_dns_propagation_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(CheckDnsPropagationResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def check_domain_monitor(self, check_domain_monitor_options, **kwargs)-
Run a one-shot free domain monitor posture check # 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_domain_monitor(check_domain_monitor_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckDomainMonitorOptions check_domain_monitor_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: CheckDomainMonitorResults If the method is called asynchronously, returns the request thread.
def check_domain_monitor_with_http_info(self, check_domain_monitor_options, **kwargs)-
Run a one-shot free domain monitor posture check # 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_domain_monitor_with_http_info(check_domain_monitor_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckDomainMonitorOptions check_domain_monitor_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(CheckDomainMonitorResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def check_email_audit(self, check_email_audit_options, **kwargs)-
Run a one-shot free email audit across links, images, HTML, and client support # 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_audit(check_email_audit_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailAuditOptions check_email_audit_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: EmailAuditAnalysisResult If the method is called asynchronously, returns the request thread.
def check_email_audit_with_http_info(self, check_email_audit_options, **kwargs)-
Run a one-shot free email audit across links, images, HTML, and client support # 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_audit_with_http_info(check_email_audit_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailAuditOptions check_email_audit_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(EmailAuditAnalysisResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def check_email_auth_stack(self, check_email_auth_stack_options, **kwargs)-
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check # 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_auth_stack(check_email_auth_stack_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailAuthStackOptions check_email_auth_stack_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: CheckEmailAuthStackResults If the method is called asynchronously, returns the request thread.
def check_email_auth_stack_with_http_info(self, check_email_auth_stack_options, **kwargs)-
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check # 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_auth_stack_with_http_info(check_email_auth_stack_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailAuthStackOptions check_email_auth_stack_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(CheckEmailAuthStackResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def check_email_blacklist(self, check_email_blacklist_options, **kwargs)-
Check whether a domain or IP appears on configured DNS blacklists # 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_blacklist(check_email_blacklist_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailBlacklistOptions check_email_blacklist_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: CheckEmailBlacklistResults If the method is called asynchronously, returns the request thread.
def check_email_blacklist_with_http_info(self, check_email_blacklist_options, **kwargs)-
Check whether a domain or IP appears on configured DNS blacklists # 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_blacklist_with_http_info(check_email_blacklist_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CheckEmailBlacklistOptions check_email_blacklist_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(CheckEmailBlacklistResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
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.
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.
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.
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.
def create_public_device_render_test(self, create_public_device_render_test_options, **kwargs)-
Create a public email render test # noqa: E501
Creates an unauthenticated free email render test and returns a short-lived generated email address. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_public_device_render_test(create_public_device_render_test_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePublicDeviceRenderTestOptions create_public_device_render_test_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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread.
def create_public_device_render_test_with_http_info(self, create_public_device_render_test_options, **kwargs)-
Create a public email render test # noqa: E501
Creates an unauthenticated free email render test and returns a short-lived generated email address. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_public_device_render_test_with_http_info(create_public_device_render_test_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePublicDeviceRenderTestOptions create_public_device_render_test_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_public_spam_test(self, create_public_spam_test_options, **kwargs)-
Create a public spam test # noqa: E501
Create an unauthenticated inbox placement run for public tools users. Returns seed addresses and a tracking token immediately. # 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_public_spam_test(create_public_spam_test_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePublicSpamTestOptions create_public_spam_test_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: PublicSpamTestRunDto If the method is called asynchronously, returns the request thread.
def create_public_spam_test_with_http_info(self, create_public_spam_test_options, **kwargs)-
Create a public spam test # noqa: E501
Create an unauthenticated inbox placement run for public tools users. Returns seed addresses and a tracking token immediately. # 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_public_spam_test_with_http_info(create_public_spam_test_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePublicSpamTestOptions create_public_spam_test_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(PublicSpamTestRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_new_fake_email_address(self, email_address, **kwargs)-
Delete a fake email address using the fake email domains # noqa: E501
Delete a fake 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.delete_new_fake_email_address(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def delete_new_fake_email_address_with_http_info(self, email_address, **kwargs)-
Delete a fake email address using the fake email domains # noqa: E501
Delete a fake 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.delete_new_fake_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
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.
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.
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.
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.
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.
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.
def generate_spf_record(self, generate_spf_record_options, **kwargs)-
Create an SPF record # 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_spf_record(generate_spf_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateSpfRecordOptions generate_spf_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: GenerateSpfRecordResults If the method is called asynchronously, returns the request thread.
def generate_spf_record_with_http_info(self, generate_spf_record_options, **kwargs)-
Create an SPF record # 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_spf_record_with_http_info(generate_spf_record_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateSpfRecordOptions generate_spf_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(GenerateSpfRecordResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
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.
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.
def get_fake_email_by_email_address(self, email_address, **kwargs)-
get_fake_email_by_email_address # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_fake_email_by_email_address(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: FakeEmailResult If the method is called asynchronously, returns the request thread.
def get_fake_email_by_email_address_with_http_info(self, email_address, **kwargs)-
get_fake_email_by_email_address # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_fake_email_by_email_address_with_http_info(email_address, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_address: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(FakeEmailResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_fake_email_by_id(self, id, **kwargs)-
Get a fake email by its ID # noqa: E501
Get a fake email by its 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.
def get_fake_email_by_id_with_http_info(self, id, **kwargs)-
Get a fake email by its ID # noqa: E501
Get a fake email by its 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.
def get_fake_email_raw(self, id, **kwargs)-
Get raw fake email content # noqa: E501
Retrieve the raw content of a fake email by its 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_raw(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: str If the method is called asynchronously, returns the request thread.
def get_fake_email_raw_with_http_info(self, id, **kwargs)-
Get raw fake email content # noqa: E501
Retrieve the raw content of a fake email by its 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_raw_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(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_fake_emails_for_address(self, email_address, **kwargs)-
Get fake emails for an address # noqa: E501
Get fake emails for an 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.
def get_fake_emails_for_address_with_http_info(self, email_address, **kwargs)-
Get fake emails for an address # noqa: E501
Get fake emails for an 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.
def get_public_device_render_targets(self, **kwargs)-
List available public email render targets # noqa: E501
Returns the currently healthy target choices exposed by the free email render tool. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_device_render_targets(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: PublicDeviceRenderTargetListDto If the method is called asynchronously, returns the request thread.
def get_public_device_render_targets_with_http_info(self, **kwargs)-
List available public email render targets # noqa: E501
Returns the currently healthy target choices exposed by the free email render tool. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_device_render_targets_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(PublicDeviceRenderTargetListDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_public_device_render_test(self, id, **kwargs)-
Get a public email render test # noqa: E501
Returns status for a free email render test and the public share redirect when the render run is ready. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_device_render_test(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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread.
def get_public_device_render_test_with_http_info(self, id, **kwargs)-
Get a public email render test # noqa: E501
Returns status for a free email render test and the public share redirect when the render run is ready. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_device_render_test_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_public_email_preview_content(self, id, **kwargs)-
Get light and dark public email preview content # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_email_preview_content(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: PublicEmailPreviewContentDto If the method is called asynchronously, returns the request thread.
def get_public_email_preview_content_with_http_info(self, id, **kwargs)-
Get light and dark public email preview content # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_email_preview_content_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(PublicEmailPreviewContentDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_public_spam_test(self, id, **kwargs)-
Get a public spam test run # noqa: E501
Returns public spam test run status, token, seed addresses, and free-limit state. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_spam_test(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: PublicSpamTestRunDto If the method is called asynchronously, returns the request thread.
def get_public_spam_test_results(self, id, **kwargs)-
Get public spam test results # noqa: E501
Returns public spam test run status and any available inbox placement results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_spam_test_results(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: PublicSpamTestResultsDto If the method is called asynchronously, returns the request thread.
def get_public_spam_test_results_with_http_info(self, id, **kwargs)-
Get public spam test results # noqa: E501
Returns public spam test run status and any available inbox placement results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_spam_test_results_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(PublicSpamTestResultsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_public_spam_test_with_http_info(self, id, **kwargs)-
Get a public spam test run # noqa: E501
Returns public spam test run status, token, seed addresses, and free-limit state. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_public_spam_test_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(PublicSpamTestRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
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.
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.
def lookup_dkim_domain(self, lookup_dkim_domain_options, **kwargs)-
Lookup and validate a DKIM record # 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_dkim_domain(lookup_dkim_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupDkimDomainOptions lookup_dkim_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: LookupDkimDomainResults If the method is called asynchronously, returns the request thread.
def lookup_dkim_domain_with_http_info(self, lookup_dkim_domain_options, **kwargs)-
Lookup and validate a DKIM record # 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_dkim_domain_with_http_info(lookup_dkim_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupDkimDomainOptions lookup_dkim_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(LookupDkimDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
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.
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.
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.
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.
def lookup_mx_record(self, lookup_mx_records_options, **kwargs)-
Lookup a MX records for a domain # 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_mx_record(lookup_mx_records_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupMxRecordsOptions lookup_mx_records_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: LookupMxRecordsResults If the method is called asynchronously, returns the request thread.
def lookup_mx_record_with_http_info(self, lookup_mx_records_options, **kwargs)-
Lookup a MX records for a domain # 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_mx_record_with_http_info(lookup_mx_records_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupMxRecordsOptions lookup_mx_records_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(LookupMxRecordsResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def lookup_ptr(self, lookup_ptr_options, **kwargs)-
Lookup PTR records for an IP 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.lookup_ptr(lookup_ptr_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupPtrOptions lookup_ptr_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: LookupPtrResults If the method is called asynchronously, returns the request thread.
def lookup_ptr_with_http_info(self, lookup_ptr_options, **kwargs)-
Lookup PTR records for an IP 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.lookup_ptr_with_http_info(lookup_ptr_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupPtrOptions lookup_ptr_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(LookupPtrResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def lookup_spf_domain(self, lookup_spf_domain_options, **kwargs)-
Lookup and validate an SPF record # 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_spf_domain(lookup_spf_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupSpfDomainOptions lookup_spf_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: LookupSpfDomainResults If the method is called asynchronously, returns the request thread.
def lookup_spf_domain_with_http_info(self, lookup_spf_domain_options, **kwargs)-
Lookup and validate an SPF record # 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_spf_domain_with_http_info(lookup_spf_domain_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param LookupSpfDomainOptions lookup_spf_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(LookupSpfDomainResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
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.
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.
def submit_public_device_render_eml(self, id, **kwargs)-
Submit an EML file to a public email render test # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_device_render_eml(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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread.
def submit_public_device_render_eml_with_http_info(self, id, **kwargs)-
Submit an EML file to a public email render test # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_device_render_eml_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def submit_public_device_render_html(self, id, submit_public_device_render_html_options, **kwargs)-
Submit HTML to a public email render test # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_device_render_html(id, submit_public_device_render_html_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicDeviceRenderHtmlOptions submit_public_device_render_html_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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread.
def submit_public_device_render_html_with_http_info(self, id, submit_public_device_render_html_options, **kwargs)-
Submit HTML to a public email render test # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_device_render_html_with_http_info(id, submit_public_device_render_html_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicDeviceRenderHtmlOptions submit_public_device_render_html_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def submit_public_device_render_test(self, id, **kwargs)-
Mark a public email render test as submitted # noqa: E501
Records that the caller sent an email to the generated address so submission and delivery failures can be distinguished from setup abandonment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_device_render_test(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: PublicDeviceRenderTestDto If the method is called asynchronously, returns the request thread.
def submit_public_device_render_test_with_http_info(self, id, **kwargs)-
Mark a public email render test as submitted # noqa: E501
Records that the caller sent an email to the generated address so submission and delivery failures can be distinguished from setup abandonment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_device_render_test_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(PublicDeviceRenderTestDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def submit_public_spam_test(self, id, submit_public_spam_test_options, **kwargs)-
Mark a public spam test as submitted # noqa: E501
Marks a previously created public spam test as submitted after the caller has sent the test email to the seed addresses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_spam_test(id, submit_public_spam_test_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicSpamTestOptions submit_public_spam_test_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: PublicSpamTestRunDto If the method is called asynchronously, returns the request thread.
def submit_public_spam_test_with_http_info(self, id, submit_public_spam_test_options, **kwargs)-
Mark a public spam test as submitted # noqa: E501
Marks a previously created public spam test as submitted after the caller has sent the test email to the seed addresses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.submit_public_spam_test_with_http_info(id, submit_public_spam_test_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param SubmitPublicSpamTestOptions submit_public_spam_test_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(PublicSpamTestRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def test_smtp_server(self, test_smtp_server_options, **kwargs)-
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_smtp_server(test_smtp_server_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param TestSmtpServerOptions test_smtp_server_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: TestSmtpServerResults If the method is called asynchronously, returns the request thread.
def test_smtp_server_with_http_info(self, test_smtp_server_options, **kwargs)-
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_smtp_server_with_http_info(test_smtp_server_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param TestSmtpServerOptions test_smtp_server_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(TestSmtpServerResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.