Module mailslurp_client.api.connector_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 ConnectorControllerApi (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 ConnectorControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def create_connector(self, create_connector_options, **kwargs): # noqa: E501 """Create an inbox connector # noqa: E501 Sync emails between external mailboxes and MailSlurp inboxes # 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_connector(create_connector_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorOptions create_connector_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_connector_with_http_info(create_connector_options, **kwargs) # noqa: E501 def create_connector_with_http_info(self, create_connector_options, **kwargs): # noqa: E501 """Create an inbox connector # noqa: E501 Sync emails between external mailboxes and MailSlurp inboxes # 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_connector_with_http_info(create_connector_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorOptions create_connector_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_connector_options', 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_connector" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_connector_options' is set if self.api_client.client_side_validation and ('create_connector_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_options` when calling `create_connector`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_connector_options' in local_var_params: body_params = local_var_params['create_connector_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( '/connectors', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_imap_connection(self, id, create_connector_imap_connection_options, **kwargs): # noqa: E501 """Create an inbox connector IMAP connection # noqa: E501 Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_connector_imap_connection(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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: ConnectorImapConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, **kwargs) # noqa: E501 def create_connector_imap_connection_with_http_info(self, id, create_connector_imap_connection_options, **kwargs): # noqa: E501 """Create an inbox connector IMAP connection # noqa: E501 Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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(ConnectorImapConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_imap_connection_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_connector_imap_connection" % 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 `create_connector_imap_connection`") # noqa: E501 # verify the required parameter 'create_connector_imap_connection_options' is set if self.api_client.client_side_validation and ('create_connector_imap_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_imap_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_imap_connection_options` when calling `create_connector_imap_connection`") # 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 'create_connector_imap_connection_options' in local_var_params: body_params = local_var_params['create_connector_imap_connection_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( '/connectors/{id}/imap', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorImapConnectionDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_smtp_connection(self, id, create_connector_smtp_connection_options, **kwargs): # noqa: E501 """Create an inbox connector SMTP connection # noqa: E501 Allows sending via connector and email is routed to connected inbox and sent via SMTP # 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_connector_smtp_connection(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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: ConnectorSmtpConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, **kwargs) # noqa: E501 def create_connector_smtp_connection_with_http_info(self, id, create_connector_smtp_connection_options, **kwargs): # noqa: E501 """Create an inbox connector SMTP connection # noqa: E501 Allows sending via connector and email is routed to connected inbox and sent via SMTP # 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_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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(ConnectorSmtpConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_smtp_connection_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_connector_smtp_connection" % 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 `create_connector_smtp_connection`") # noqa: E501 # verify the required parameter 'create_connector_smtp_connection_options' is set if self.api_client.client_side_validation and ('create_connector_smtp_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_smtp_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_smtp_connection_options` when calling `create_connector_smtp_connection`") # 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 'create_connector_smtp_connection_options' in local_var_params: body_params = local_var_params['create_connector_smtp_connection_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( '/connectors/{id}/smtp', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorSmtpConnectionDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_sync_settings(self, id, create_connector_sync_settings_options, **kwargs): # noqa: E501 """Create an inbox connector sync settings # noqa: E501 Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings(id, create_connector_sync_settings_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSyncSettingsOptions create_connector_sync_settings_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: ConnectorSyncSettingsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_connector_sync_settings_with_http_info(id, create_connector_sync_settings_options, **kwargs) # noqa: E501 def create_connector_sync_settings_with_http_info(self, id, create_connector_sync_settings_options, **kwargs): # noqa: E501 """Create an inbox connector sync settings # noqa: E501 Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings_with_http_info(id, create_connector_sync_settings_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSyncSettingsOptions create_connector_sync_settings_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(ConnectorSyncSettingsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_sync_settings_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_connector_sync_settings" % 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 `create_connector_sync_settings`") # noqa: E501 # verify the required parameter 'create_connector_sync_settings_options' is set if self.api_client.client_side_validation and ('create_connector_sync_settings_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_sync_settings_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_sync_settings_options` when calling `create_connector_sync_settings`") # 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 'create_connector_sync_settings_options' in local_var_params: body_params = local_var_params['create_connector_sync_settings_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( '/connectors/{id}/sync-settings', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorSyncSettingsDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_with_options(self, create_connector_with_options, **kwargs): # noqa: E501 """Create an inbox connector with options # noqa: E501 Sync emails between external mailboxes and MailSlurp inboxes # 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_connector_with_options(create_connector_with_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorWithOptions create_connector_with_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_connector_with_options_with_http_info(create_connector_with_options, **kwargs) # noqa: E501 def create_connector_with_options_with_http_info(self, create_connector_with_options, **kwargs): # noqa: E501 """Create an inbox connector with options # noqa: E501 Sync emails between external mailboxes and MailSlurp inboxes # 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_connector_with_options_with_http_info(create_connector_with_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorWithOptions create_connector_with_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_connector_with_options', 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_connector_with_options" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_connector_with_options' is set if self.api_client.client_side_validation and ('create_connector_with_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_with_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_with_options` when calling `create_connector_with_options`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_connector_with_options' in local_var_params: body_params = local_var_params['create_connector_with_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( '/connectors/withOptions', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_connector(self, **kwargs): # noqa: E501 """Delete all inbox connectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_connector(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_all_connector_with_http_info(**kwargs) # noqa: E501 def delete_all_connector_with_http_info(self, **kwargs): # noqa: E501 """Delete all inbox connectors # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_connector_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_connector" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_connector(self, id, **kwargs): # noqa: E501 """Delete an inbox connector # 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_connector(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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_connector_with_http_info(id, **kwargs) # noqa: E501 def delete_connector_with_http_info(self, id, **kwargs): # noqa: E501 """Delete an inbox connector # 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_connector_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: None 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 delete_connector" % 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 `delete_connector`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/{id}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_connector_imap_connection(self, id, **kwargs): # noqa: E501 """Delete an inbox connector IMAP connection # noqa: E501 Delete IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_connector_imap_connection(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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_connector_imap_connection_with_http_info(id, **kwargs) # noqa: E501 def delete_connector_imap_connection_with_http_info(self, id, **kwargs): # noqa: E501 """Delete an inbox connector IMAP connection # noqa: E501 Delete IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_connector_imap_connection_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: None 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 delete_connector_imap_connection" % 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 `delete_connector_imap_connection`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/{id}/imap', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_connector_smtp_connection(self, id, **kwargs): # noqa: E501 """Delete an inbox connector SMTP connection # noqa: E501 Delete SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_connector_smtp_connection(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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_connector_smtp_connection_with_http_info(id, **kwargs) # noqa: E501 def delete_connector_smtp_connection_with_http_info(self, id, **kwargs): # noqa: E501 """Delete an inbox connector SMTP connection # noqa: E501 Delete SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_connector_smtp_connection_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: None 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 delete_connector_smtp_connection" % 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 `delete_connector_smtp_connection`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/{id}/smtp', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_connector_sync_settings(self, id, **kwargs): # noqa: E501 """Create an inbox connector sync settings # noqa: E501 Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings(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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_connector_sync_settings_with_http_info(id, **kwargs) # noqa: E501 def delete_connector_sync_settings_with_http_info(self, id, **kwargs): # noqa: E501 """Create an inbox connector sync settings # noqa: E501 Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings_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: None 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 delete_connector_sync_settings" % 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 `delete_connector_sync_settings`") # 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/{id}/sync-settings', '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 get_all_connector_events(self, **kwargs): # noqa: E501 """Get all inbox connector events # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_connector_events(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: Optional connector ID :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageConnectorEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_connector_events_with_http_info(**kwargs) # noqa: E501 def get_all_connector_events_with_http_info(self, **kwargs): # noqa: E501 """Get all inbox connector events # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_connector_events_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: Optional connector ID :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageConnectorEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'page', 'size', 'sort', 'since', 'before', 'event_type' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all_connector_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] 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 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'event_type' in local_var_params and local_var_params['event_type'] is not None: # noqa: E501 query_params.append(('eventType', local_var_params['event_type'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageConnectorEvents', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector(self, id, **kwargs): # noqa: E501 """Get an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector(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: ConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_with_http_info(id, **kwargs) # noqa: E501 def get_connector_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_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(ConnectorDto, 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_connector" % 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_connector`") # 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( '/connectors/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_by_email_address(self, email_address, **kwargs): # noqa: E501 """Get connector by email address # noqa: E501 Find an inbox connector 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_connector_by_email_address(email_address, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_address: Email address to search for connector by (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: OptionalConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_by_email_address_with_http_info(email_address, **kwargs) # noqa: E501 def get_connector_by_email_address_with_http_info(self, email_address, **kwargs): # noqa: E501 """Get connector by email address # noqa: E501 Find an inbox connector 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_connector_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: Email address to search for connector by (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(OptionalConnectorDto, 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_connector_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_connector_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( '/connectors/by-email-address', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OptionalConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_by_inbox_id(self, inbox_id, **kwargs): # noqa: E501 """Get connector by inbox ID # noqa: E501 Find an inbox connector by inbox 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_connector_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID to search for connector by (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: OptionalConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_by_inbox_id_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_connector_by_inbox_id_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get connector by inbox ID # noqa: E501 Find an inbox connector by inbox 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_connector_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID to search for connector by (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(OptionalConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_connector_by_inbox_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_connector_by_inbox_id`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/by-inbox-id', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OptionalConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_by_name(self, name, **kwargs): # noqa: E501 """Get connector by name # noqa: E501 Find an inbox connector by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_by_name(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: Name to search for connector by (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: OptionalConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_by_name_with_http_info(name, **kwargs) # noqa: E501 def get_connector_by_name_with_http_info(self, name, **kwargs): # noqa: E501 """Get connector by name # noqa: E501 Find an inbox connector by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_by_name_with_http_info(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: Name to search for connector by (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(OptionalConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'name' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_connector_by_name" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'name' is set if self.api_client.client_side_validation and ('name' not in local_var_params or # noqa: E501 local_var_params['name'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `name` when calling `get_connector_by_name`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501 query_params.append(('name', local_var_params['name'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/by-name', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OptionalConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_event(self, id, **kwargs): # noqa: E501 """Get an inbox connector event # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_event(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: ConnectorEventDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_event_with_http_info(id, **kwargs) # noqa: E501 def get_connector_event_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox connector event # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_event_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(ConnectorEventDto, 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_connector_event" % 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_connector_event`") # 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( '/connectors/events/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorEventDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_events(self, id, **kwargs): # noqa: E501 """Get an inbox connector events # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_events(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageConnectorEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_events_with_http_info(id, **kwargs) # noqa: E501 def get_connector_events_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox connector events # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_events_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageConnectorEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'page', 'size', 'sort', 'since', 'before', 'event_type' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_connector_events" % 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_connector_events`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'event_type' in local_var_params and local_var_params['event_type'] is not None: # noqa: E501 query_params.append(('eventType', local_var_params['event_type'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/{id}/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageConnectorEvents', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_imap_connection(self, id, **kwargs): # noqa: E501 """Get an inbox connector IMAP connection # noqa: E501 Get IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_imap_connection(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: OptionalConnectorImapConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_imap_connection_with_http_info(id, **kwargs) # noqa: E501 def get_connector_imap_connection_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox connector IMAP connection # noqa: E501 Get IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_imap_connection_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(OptionalConnectorImapConnectionDto, 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_connector_imap_connection" % 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_connector_imap_connection`") # 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( '/connectors/{id}/imap', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OptionalConnectorImapConnectionDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_provider_settings(self, **kwargs): # noqa: E501 """Get SMTP and IMAP connection settings for common mail providers # noqa: E501 Get common mail provider SMTP and IMAP connection settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_provider_settings(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: ConnectorProviderSettingsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_provider_settings_with_http_info(**kwargs) # noqa: E501 def get_connector_provider_settings_with_http_info(self, **kwargs): # noqa: E501 """Get SMTP and IMAP connection settings for common mail providers # noqa: E501 Get common mail provider SMTP and IMAP connection settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_provider_settings_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(ConnectorProviderSettingsDto, 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_connector_provider_settings" % 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( '/connectors/provider-settings', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorProviderSettingsDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_smtp_connection(self, id, **kwargs): # noqa: E501 """Get an inbox connector SMTP connection # noqa: E501 Get SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_smtp_connection(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: OptionalConnectorSmtpConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_smtp_connection_with_http_info(id, **kwargs) # noqa: E501 def get_connector_smtp_connection_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox connector SMTP connection # noqa: E501 Get SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_smtp_connection_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(OptionalConnectorSmtpConnectionDto, 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_connector_smtp_connection" % 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_connector_smtp_connection`") # 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( '/connectors/{id}/smtp', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OptionalConnectorSmtpConnectionDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_sync_settings(self, id, **kwargs): # noqa: E501 """Get an inbox connector sync settings # noqa: E501 Get sync settings for connection with external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_sync_settings(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: OptionalConnectorSyncSettingsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connector_sync_settings_with_http_info(id, **kwargs) # noqa: E501 def get_connector_sync_settings_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox connector sync settings # noqa: E501 Get sync settings for connection with external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connector_sync_settings_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(OptionalConnectorSyncSettingsDto, 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_connector_sync_settings" % 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_connector_sync_settings`") # 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( '/connectors/{id}/sync-settings', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OptionalConnectorSyncSettingsDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connectors(self, **kwargs): # noqa: E501 """Get inbox connectors # noqa: E501 List inbox connectors that sync external emails to MailSlurp inboxes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connectors(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageConnector If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_connectors_with_http_info(**kwargs) # noqa: E501 def get_connectors_with_http_info(self, **kwargs): # noqa: E501 """Get inbox connectors # noqa: E501 List inbox connectors that sync external emails to MailSlurp inboxes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_connectors_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageConnector, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_connectors" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageConnector', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def send_email_from_connector(self, id, send_email_options, **kwargs): # noqa: E501 """Send from an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_from_connector(id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param SendEmailOptions send_email_options: (required) :param bool use_fallback: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_email_from_connector_with_http_info(id, send_email_options, **kwargs) # noqa: E501 def send_email_from_connector_with_http_info(self, id, send_email_options, **kwargs): # noqa: E501 """Send from an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_from_connector_with_http_info(id, send_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param SendEmailOptions send_email_options: (required) :param bool use_fallback: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'send_email_options', 'use_fallback' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method send_email_from_connector" % 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 `send_email_from_connector`") # noqa: E501 # verify the required parameter 'send_email_options' is set if self.api_client.client_side_validation and ('send_email_options' not in local_var_params or # noqa: E501 local_var_params['send_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `send_email_options` when calling `send_email_from_connector`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'use_fallback' in local_var_params and local_var_params['use_fallback'] is not None: # noqa: E501 query_params.append(('useFallback', local_var_params['use_fallback'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_email_options' in local_var_params: body_params = local_var_params['send_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/connectors/{id}/send', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SentEmailDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def sync_connector(self, id, **kwargs): # noqa: E501 """Sync an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sync_connector(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param datetime since: Date to request emails since :param str folder: Which folder to sync emails with :param bool logging: Enable or disable logging for the sync operation :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorSyncRequestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sync_connector_with_http_info(id, **kwargs) # noqa: E501 def sync_connector_with_http_info(self, id, **kwargs): # noqa: E501 """Sync an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sync_connector_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param datetime since: Date to request emails since :param str folder: Which folder to sync emails with :param bool logging: Enable or disable logging for the sync operation :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorSyncRequestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'since', 'folder', 'logging' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method sync_connector" % 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 `sync_connector`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'folder' in local_var_params and local_var_params['folder'] is not None: # noqa: E501 query_params.append(('folder', local_var_params['folder'])) # noqa: E501 if 'logging' in local_var_params and local_var_params['logging'] is not None: # noqa: E501 query_params.append(('logging', local_var_params['logging'])) # 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( '/connectors/{id}/sync', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorSyncRequestResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_imap_connection(self, id, **kwargs): # noqa: E501 """Test an inbox connector IMAP connection # noqa: E501 Test the IMAP connection for a connector # 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_connector_imap_connection(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_options: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorImapConnectionTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_connector_imap_connection_with_http_info(id, **kwargs) # noqa: E501 def test_connector_imap_connection_with_http_info(self, id, **kwargs): # noqa: E501 """Test an inbox connector IMAP connection # noqa: E501 Test the IMAP connection for a connector # 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_connector_imap_connection_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_options: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorImapConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_imap_connection_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_connector_imap_connection" % 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 `test_connector_imap_connection`") # 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 'create_connector_imap_connection_options' in local_var_params: body_params = local_var_params['create_connector_imap_connection_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( '/connectors/{id}/imap/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorImapConnectionTestResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_imap_connection_options(self, create_connector_imap_connection_options, **kwargs): # noqa: E501 """Test an inbox connector IMAP connection options # noqa: E501 Test the IMAP connection options for a connector # 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_connector_imap_connection_options(create_connector_imap_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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: ConnectorImapConnectionTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_connector_imap_connection_options_with_http_info(create_connector_imap_connection_options, **kwargs) # noqa: E501 def test_connector_imap_connection_options_with_http_info(self, create_connector_imap_connection_options, **kwargs): # noqa: E501 """Test an inbox connector IMAP connection options # noqa: E501 Test the IMAP connection options for a connector # 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_connector_imap_connection_options_with_http_info(create_connector_imap_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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(ConnectorImapConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_connector_imap_connection_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_connector_imap_connection_options" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_connector_imap_connection_options' is set if self.api_client.client_side_validation and ('create_connector_imap_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_imap_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_imap_connection_options` when calling `test_connector_imap_connection_options`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_connector_imap_connection_options' in local_var_params: body_params = local_var_params['create_connector_imap_connection_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( '/connectors/connections/imap/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorImapConnectionTestResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_smtp_connection(self, id, **kwargs): # noqa: E501 """Test an inbox connector SMTP connection # noqa: E501 Test the SMTP connection for a connector # 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_connector_smtp_connection(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_options: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorSmtpConnectionTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_connector_smtp_connection_with_http_info(id, **kwargs) # noqa: E501 def test_connector_smtp_connection_with_http_info(self, id, **kwargs): # noqa: E501 """Test an inbox connector SMTP connection # noqa: E501 Test the SMTP connection for a connector # 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_connector_smtp_connection_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_options: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorSmtpConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_smtp_connection_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_connector_smtp_connection" % 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 `test_connector_smtp_connection`") # 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 'create_connector_smtp_connection_options' in local_var_params: body_params = local_var_params['create_connector_smtp_connection_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( '/connectors/{id}/smtp/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorSmtpConnectionTestResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # 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_connector_smtp_connection_options(self, create_connector_smtp_connection_options, **kwargs): # noqa: E501 """Test an inbox connector SMTP connection options # noqa: E501 Test the SMTP connection options for a connector # 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_connector_smtp_connection_options(create_connector_smtp_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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: ConnectorSmtpConnectionTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_connector_smtp_connection_options_with_http_info(create_connector_smtp_connection_options, **kwargs) # noqa: E501 def test_connector_smtp_connection_options_with_http_info(self, create_connector_smtp_connection_options, **kwargs): # noqa: E501 """Test an inbox connector SMTP connection options # noqa: E501 Test the SMTP connection options for a connector # 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_connector_smtp_connection_options_with_http_info(create_connector_smtp_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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(ConnectorSmtpConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_connector_smtp_connection_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_connector_smtp_connection_options" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_connector_smtp_connection_options' is set if self.api_client.client_side_validation and ('create_connector_smtp_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_smtp_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_smtp_connection_options` when calling `test_connector_smtp_connection_options`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_connector_smtp_connection_options' in local_var_params: body_params = local_var_params['create_connector_smtp_connection_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( '/connectors/connections/smtp/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorSmtpConnectionTestResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def update_connector(self, id, create_connector_options, **kwargs): # noqa: E501 """Update an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_connector(id, create_connector_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorOptions create_connector_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: ConnectorDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_connector_with_http_info(id, create_connector_options, **kwargs) # noqa: E501 def update_connector_with_http_info(self, id, create_connector_options, **kwargs): # noqa: E501 """Update an inbox connector # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_connector_with_http_info(id, create_connector_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorOptions create_connector_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(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method update_connector" % 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 `update_connector`") # noqa: E501 # verify the required parameter 'create_connector_options' is set if self.api_client.client_side_validation and ('create_connector_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_options` when calling `update_connector`") # 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 'create_connector_options' in local_var_params: body_params = local_var_params['create_connector_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( '/connectors/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def update_connector_imap_connection(self, id, create_connector_imap_connection_options, **kwargs): # noqa: E501 """Update an inbox connector IMAP connection # noqa: E501 Update IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_connector_imap_connection(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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: ConnectorImapConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, **kwargs) # noqa: E501 def update_connector_imap_connection_with_http_info(self, id, create_connector_imap_connection_options, **kwargs): # noqa: E501 """Update an inbox connector IMAP connection # noqa: E501 Update IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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(ConnectorImapConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_imap_connection_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method update_connector_imap_connection" % 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 `update_connector_imap_connection`") # noqa: E501 # verify the required parameter 'create_connector_imap_connection_options' is set if self.api_client.client_side_validation and ('create_connector_imap_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_imap_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_imap_connection_options` when calling `update_connector_imap_connection`") # 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 'create_connector_imap_connection_options' in local_var_params: body_params = local_var_params['create_connector_imap_connection_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( '/connectors/{id}/imap', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorImapConnectionDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def update_connector_smtp_connection(self, id, create_connector_smtp_connection_options, **kwargs): # noqa: E501 """Update an inbox connector SMTP connection # noqa: E501 Update SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_connector_smtp_connection(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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: ConnectorSmtpConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, **kwargs) # noqa: E501 def update_connector_smtp_connection_with_http_info(self, id, create_connector_smtp_connection_options, **kwargs): # noqa: E501 """Update an inbox connector SMTP connection # noqa: E501 Update SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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(ConnectorSmtpConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_connector_smtp_connection_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method update_connector_smtp_connection" % 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 `update_connector_smtp_connection`") # noqa: E501 # verify the required parameter 'create_connector_smtp_connection_options' is set if self.api_client.client_side_validation and ('create_connector_smtp_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_connector_smtp_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_connector_smtp_connection_options` when calling `update_connector_smtp_connection`") # 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 'create_connector_smtp_connection_options' in local_var_params: body_params = local_var_params['create_connector_smtp_connection_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( '/connectors/{id}/smtp', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConnectorSmtpConnectionDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
Methods
def create_connector(self, create_connector_options, **kwargs)
-
Create an inbox connector # noqa: E501
Sync emails between external mailboxes and MailSlurp inboxes # 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_connector(create_connector_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorOptions create_connector_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorDto If the method is called asynchronously, returns the request thread.
def create_connector_imap_connection(self, id, create_connector_imap_connection_options, **kwargs)
-
Create an inbox connector IMAP connection # noqa: E501
Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_connector_imap_connection(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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: ConnectorImapConnectionDto If the method is called asynchronously, returns the request thread.
def create_connector_imap_connection_with_http_info(self, id, create_connector_imap_connection_options, **kwargs)
-
Create an inbox connector IMAP connection # noqa: E501
Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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(ConnectorImapConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_connector_smtp_connection(self, id, create_connector_smtp_connection_options, **kwargs)
-
Create an inbox connector SMTP connection # noqa: E501
Allows sending via connector and email is routed to connected inbox and sent via SMTP # 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_connector_smtp_connection(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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: ConnectorSmtpConnectionDto If the method is called asynchronously, returns the request thread.
def create_connector_smtp_connection_with_http_info(self, id, create_connector_smtp_connection_options, **kwargs)
-
Create an inbox connector SMTP connection # noqa: E501
Allows sending via connector and email is routed to connected inbox and sent via SMTP # 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_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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(ConnectorSmtpConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_connector_sync_settings(self, id, create_connector_sync_settings_options, **kwargs)
-
Create an inbox connector sync settings # noqa: E501
Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings(id, create_connector_sync_settings_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSyncSettingsOptions create_connector_sync_settings_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: ConnectorSyncSettingsDto If the method is called asynchronously, returns the request thread.
def create_connector_sync_settings_with_http_info(self, id, create_connector_sync_settings_options, **kwargs)
-
Create an inbox connector sync settings # noqa: E501
Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings_with_http_info(id, create_connector_sync_settings_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSyncSettingsOptions create_connector_sync_settings_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(ConnectorSyncSettingsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_connector_with_http_info(self, create_connector_options, **kwargs)
-
Create an inbox connector # noqa: E501
Sync emails between external mailboxes and MailSlurp inboxes # 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_connector_with_http_info(create_connector_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorOptions create_connector_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_connector_with_options(self, create_connector_with_options, **kwargs)
-
Create an inbox connector with options # noqa: E501
Sync emails between external mailboxes and MailSlurp inboxes # 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_connector_with_options(create_connector_with_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorWithOptions create_connector_with_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorDto If the method is called asynchronously, returns the request thread.
def create_connector_with_options_with_http_info(self, create_connector_with_options, **kwargs)
-
Create an inbox connector with options # noqa: E501
Sync emails between external mailboxes and MailSlurp inboxes # 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_connector_with_options_with_http_info(create_connector_with_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorWithOptions create_connector_with_options: (required) :param str inbox_id: Optional inbox ID to associate with the connector :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_all_connector(self, **kwargs)
-
Delete all inbox connectors # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_connector(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def delete_all_connector_with_http_info(self, **kwargs)
-
Delete all inbox connectors # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_connector_with_http_info(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def delete_connector(self, id, **kwargs)
-
Delete an inbox connector # 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_connector(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: None If the method is called asynchronously, returns the request thread.
def delete_connector_imap_connection(self, id, **kwargs)
-
Delete an inbox connector IMAP connection # noqa: E501
Delete IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_connector_imap_connection(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: None If the method is called asynchronously, returns the request thread.
def delete_connector_imap_connection_with_http_info(self, id, **kwargs)
-
Delete an inbox connector IMAP connection # noqa: E501
Delete IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_connector_imap_connection_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: None If the method is called asynchronously, returns the request thread.
def delete_connector_smtp_connection(self, id, **kwargs)
-
Delete an inbox connector SMTP connection # noqa: E501
Delete SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_connector_smtp_connection(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: None If the method is called asynchronously, returns the request thread.
def delete_connector_smtp_connection_with_http_info(self, id, **kwargs)
-
Delete an inbox connector SMTP connection # noqa: E501
Delete SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_connector_smtp_connection_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: None If the method is called asynchronously, returns the request thread.
def delete_connector_sync_settings(self, id, **kwargs)
-
Create an inbox connector sync settings # noqa: E501
Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings(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: None If the method is called asynchronously, returns the request thread.
def delete_connector_sync_settings_with_http_info(self, id, **kwargs)
-
Create an inbox connector sync settings # noqa: E501
Configure automatic pull or emails from external inboxes using an interval or schedule # 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_connector_sync_settings_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: None If the method is called asynchronously, returns the request thread.
def delete_connector_with_http_info(self, id, **kwargs)
-
Delete an inbox connector # 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_connector_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: None If the method is called asynchronously, returns the request thread.
def get_all_connector_events(self, **kwargs)
-
Get all inbox connector events # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_connector_events(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: Optional connector ID :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageConnectorEvents If the method is called asynchronously, returns the request thread.
def get_all_connector_events_with_http_info(self, **kwargs)
-
Get all inbox connector events # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_connector_events_with_http_info(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: Optional connector ID :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageConnectorEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector(self, id, **kwargs)
-
Get an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector(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: ConnectorDto If the method is called asynchronously, returns the request thread.
def get_connector_by_email_address(self, email_address, **kwargs)
-
Get connector by email address # noqa: E501
Find an inbox connector 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_connector_by_email_address(email_address, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str email_address: Email address to search for connector by (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: OptionalConnectorDto If the method is called asynchronously, returns the request thread.
def get_connector_by_email_address_with_http_info(self, email_address, **kwargs)
-
Get connector by email address # noqa: E501
Find an inbox connector 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_connector_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: Email address to search for connector by (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(OptionalConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_by_inbox_id(self, inbox_id, **kwargs)
-
Get connector by inbox ID # noqa: E501
Find an inbox connector by inbox 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_connector_by_inbox_id(inbox_id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID to search for connector by (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: OptionalConnectorDto If the method is called asynchronously, returns the request thread.
def get_connector_by_inbox_id_with_http_info(self, inbox_id, **kwargs)
-
Get connector by inbox ID # noqa: E501
Find an inbox connector by inbox 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_connector_by_inbox_id_with_http_info(inbox_id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Inbox ID to search for connector by (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(OptionalConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_by_name(self, name, **kwargs)
-
Get connector by name # noqa: E501
Find an inbox connector by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_by_name(name, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str name: Name to search for connector by (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: OptionalConnectorDto If the method is called asynchronously, returns the request thread.
def get_connector_by_name_with_http_info(self, name, **kwargs)
-
Get connector by name # noqa: E501
Find an inbox connector by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_by_name_with_http_info(name, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str name: Name to search for connector by (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(OptionalConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_event(self, id, **kwargs)
-
Get an inbox connector event # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_event(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: ConnectorEventDto If the method is called asynchronously, returns the request thread.
def get_connector_event_with_http_info(self, id, **kwargs)
-
Get an inbox connector event # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_event_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(ConnectorEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_events(self, id, **kwargs)
-
Get an inbox connector events # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_events(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageConnectorEvents If the method is called asynchronously, returns the request thread.
def get_connector_events_with_http_info(self, id, **kwargs)
-
Get an inbox connector events # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_events_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str event_type: Filter by event type :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageConnectorEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_imap_connection(self, id, **kwargs)
-
Get an inbox connector IMAP connection # noqa: E501
Get IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_imap_connection(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: OptionalConnectorImapConnectionDto If the method is called asynchronously, returns the request thread.
def get_connector_imap_connection_with_http_info(self, id, **kwargs)
-
Get an inbox connector IMAP connection # noqa: E501
Get IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_imap_connection_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(OptionalConnectorImapConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_provider_settings(self, **kwargs)
-
Get SMTP and IMAP connection settings for common mail providers # noqa: E501
Get common mail provider SMTP and IMAP connection settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_provider_settings(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: ConnectorProviderSettingsDto If the method is called asynchronously, returns the request thread.
def get_connector_provider_settings_with_http_info(self, **kwargs)
-
Get SMTP and IMAP connection settings for common mail providers # noqa: E501
Get common mail provider SMTP and IMAP connection settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_provider_settings_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(ConnectorProviderSettingsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_smtp_connection(self, id, **kwargs)
-
Get an inbox connector SMTP connection # noqa: E501
Get SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_smtp_connection(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: OptionalConnectorSmtpConnectionDto If the method is called asynchronously, returns the request thread.
def get_connector_smtp_connection_with_http_info(self, id, **kwargs)
-
Get an inbox connector SMTP connection # noqa: E501
Get SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_smtp_connection_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(OptionalConnectorSmtpConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_sync_settings(self, id, **kwargs)
-
Get an inbox connector sync settings # noqa: E501
Get sync settings for connection with external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_sync_settings(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: OptionalConnectorSyncSettingsDto If the method is called asynchronously, returns the request thread.
def get_connector_sync_settings_with_http_info(self, id, **kwargs)
-
Get an inbox connector sync settings # noqa: E501
Get sync settings for connection with external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_sync_settings_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(OptionalConnectorSyncSettingsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connector_with_http_info(self, id, **kwargs)
-
Get an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connector_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(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_connectors(self, **kwargs)
-
Get inbox connectors # noqa: E501
List inbox connectors that sync external emails to MailSlurp inboxes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connectors(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageConnector If the method is called asynchronously, returns the request thread.
def get_connectors_with_http_info(self, **kwargs)
-
Get inbox connectors # noqa: E501
List inbox connectors that sync external emails to MailSlurp inboxes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_connectors_with_http_info(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param int page: Optional page index in connector list pagination :param int size: Optional page size in connector list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageConnector, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def send_email_from_connector(self, id, send_email_options, **kwargs)
-
Send from an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_email_from_connector(id, send_email_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param SendEmailOptions send_email_options: (required) :param bool use_fallback: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: SentEmailDto If the method is called asynchronously, returns the request thread.
def send_email_from_connector_with_http_info(self, id, send_email_options, **kwargs)
-
Send from an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_email_from_connector_with_http_info(id, send_email_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param SendEmailOptions send_email_options: (required) :param bool use_fallback: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(SentEmailDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def sync_connector(self, id, **kwargs)
-
Sync an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sync_connector(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param datetime since: Date to request emails since :param str folder: Which folder to sync emails with :param bool logging: Enable or disable logging for the sync operation :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorSyncRequestResult If the method is called asynchronously, returns the request thread.
def sync_connector_with_http_info(self, id, **kwargs)
-
Sync an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sync_connector_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param datetime since: Date to request emails since :param str folder: Which folder to sync emails with :param bool logging: Enable or disable logging for the sync operation :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorSyncRequestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def test_connector_imap_connection(self, id, **kwargs)
-
Test an inbox connector IMAP connection # noqa: E501
Test the IMAP connection for a connector # 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_connector_imap_connection(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_options: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorImapConnectionTestResult If the method is called asynchronously, returns the request thread.
def test_connector_imap_connection_options(self, create_connector_imap_connection_options, **kwargs)
-
Test an inbox connector IMAP connection options # noqa: E501
Test the IMAP connection options for a connector # 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_connector_imap_connection_options(create_connector_imap_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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: ConnectorImapConnectionTestResult If the method is called asynchronously, returns the request thread.
def test_connector_imap_connection_options_with_http_info(self, create_connector_imap_connection_options, **kwargs)
-
Test an inbox connector IMAP connection options # noqa: E501
Test the IMAP connection options for a connector # 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_connector_imap_connection_options_with_http_info(create_connector_imap_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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(ConnectorImapConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def test_connector_imap_connection_with_http_info(self, id, **kwargs)
-
Test an inbox connector IMAP connection # noqa: E501
Test the IMAP connection for a connector # 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_connector_imap_connection_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_options: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorImapConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def test_connector_smtp_connection(self, id, **kwargs)
-
Test an inbox connector SMTP connection # noqa: E501
Test the SMTP connection for a connector # 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_connector_smtp_connection(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_options: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ConnectorSmtpConnectionTestResult If the method is called asynchronously, returns the request thread.
def test_connector_smtp_connection_options(self, create_connector_smtp_connection_options, **kwargs)
-
Test an inbox connector SMTP connection options # noqa: E501
Test the SMTP connection options for a connector # 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_connector_smtp_connection_options(create_connector_smtp_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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: ConnectorSmtpConnectionTestResult If the method is called asynchronously, returns the request thread.
def test_connector_smtp_connection_options_with_http_info(self, create_connector_smtp_connection_options, **kwargs)
-
Test an inbox connector SMTP connection options # noqa: E501
Test the SMTP connection options for a connector # 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_connector_smtp_connection_options_with_http_info(create_connector_smtp_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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(ConnectorSmtpConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def test_connector_smtp_connection_with_http_info(self, id, **kwargs)
-
Test an inbox connector SMTP connection # noqa: E501
Test the SMTP connection for a connector # 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_connector_smtp_connection_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_options: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ConnectorSmtpConnectionTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_connector(self, id, create_connector_options, **kwargs)
-
Update an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_connector(id, create_connector_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorOptions create_connector_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: ConnectorDto If the method is called asynchronously, returns the request thread.
def update_connector_imap_connection(self, id, create_connector_imap_connection_options, **kwargs)
-
Update an inbox connector IMAP connection # noqa: E501
Update IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_connector_imap_connection(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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: ConnectorImapConnectionDto If the method is called asynchronously, returns the request thread.
def update_connector_imap_connection_with_http_info(self, id, create_connector_imap_connection_options, **kwargs)
-
Update an inbox connector IMAP connection # noqa: E501
Update IMAP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorImapConnectionOptions create_connector_imap_connection_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(ConnectorImapConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_connector_smtp_connection(self, id, create_connector_smtp_connection_options, **kwargs)
-
Update an inbox connector SMTP connection # noqa: E501
Update SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_connector_smtp_connection(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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: ConnectorSmtpConnectionDto If the method is called asynchronously, returns the request thread.
def update_connector_smtp_connection_with_http_info(self, id, create_connector_smtp_connection_options, **kwargs)
-
Update an inbox connector SMTP connection # noqa: E501
Update SMTP connection for external inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorSmtpConnectionOptions create_connector_smtp_connection_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(ConnectorSmtpConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_connector_with_http_info(self, id, create_connector_options, **kwargs)
-
Update an inbox connector # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_connector_with_http_info(id, create_connector_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: (required) :param CreateConnectorOptions create_connector_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(ConnectorDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.