Module mailslurp_client.api.imap_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 ImapControllerApi (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 ImapControllerApi(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 imap_server_fetch(self, seq_num, **kwargs): # noqa: E501 """Fetch message in an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_fetch(seq_num, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int seq_num: (required) :param str inbox_id: Inbox ID to search :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerFetchResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_fetch_with_http_info(seq_num, **kwargs) # noqa: E501 def imap_server_fetch_with_http_info(self, seq_num, **kwargs): # noqa: E501 """Fetch message in an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_fetch_with_http_info(seq_num, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int seq_num: (required) :param str inbox_id: Inbox ID to search :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerFetchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'seq_num', '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 imap_server_fetch" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'seq_num' is set if self.api_client.client_side_validation and ('seq_num' not in local_var_params or # noqa: E501 local_var_params['seq_num'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `seq_num` when calling `imap_server_fetch`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'seq_num' in local_var_params and local_var_params['seq_num'] is not None: # noqa: E501 query_params.append(('seqNum', local_var_params['seq_num'])) # 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( '/imap/server/fetch', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapServerFetchResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 imap_server_get(self, email_id, **kwargs): # noqa: E501 """Get a message by email 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.imap_server_get(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: Email ID to get (required) :param str inbox_id: Inbox ID to search :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerGetResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_get_with_http_info(email_id, **kwargs) # noqa: E501 def imap_server_get_with_http_info(self, email_id, **kwargs): # noqa: E501 """Get a message by email 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.imap_server_get_with_http_info(email_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: Email ID to get (required) :param str inbox_id: Inbox ID to search :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerGetResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', '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 imap_server_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'email_id' is set if self.api_client.client_side_validation and ('email_id' not in local_var_params or # noqa: E501 local_var_params['email_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_id` when calling `imap_server_get`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 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( '/imap/server/get', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapServerGetResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 imap_server_list(self, imap_server_list_options, **kwargs): # noqa: E501 """List messages in an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_list(imap_server_list_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapServerListOptions imap_server_list_options: (required) :param str inbox_id: Inbox ID to list :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerListResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_list_with_http_info(imap_server_list_options, **kwargs) # noqa: E501 def imap_server_list_with_http_info(self, imap_server_list_options, **kwargs): # noqa: E501 """List messages in an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_list_with_http_info(imap_server_list_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapServerListOptions imap_server_list_options: (required) :param str inbox_id: Inbox ID to list :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerListResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'imap_server_list_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 imap_server_list" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'imap_server_list_options' is set if self.api_client.client_side_validation and ('imap_server_list_options' not in local_var_params or # noqa: E501 local_var_params['imap_server_list_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `imap_server_list_options` when calling `imap_server_list`") # 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 'imap_server_list_options' in local_var_params: body_params = local_var_params['imap_server_list_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( '/imap/server/list', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapServerListResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 imap_server_mailbox(self, name, **kwargs): # noqa: E501 """Create a new mailbox if possible # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_mailbox(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: Inbox email address to create (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: ImapServerMailboxResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_mailbox_with_http_info(name, **kwargs) # noqa: E501 def imap_server_mailbox_with_http_info(self, name, **kwargs): # noqa: E501 """Create a new mailbox if possible # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_mailbox_with_http_info(name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str name: Inbox email address to create (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(ImapServerMailboxResult, 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 imap_server_mailbox" % 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 `imap_server_mailbox`") # 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( '/imap/server/mailbox', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapServerMailboxResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 imap_server_search(self, imap_server_search_options, **kwargs): # noqa: E501 """Search messages in an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_search(imap_server_search_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapServerSearchOptions imap_server_search_options: (required) :param str inbox_id: Inbox ID to search :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerSearchResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_search_with_http_info(imap_server_search_options, **kwargs) # noqa: E501 def imap_server_search_with_http_info(self, imap_server_search_options, **kwargs): # noqa: E501 """Search messages in an inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_search_with_http_info(imap_server_search_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapServerSearchOptions imap_server_search_options: (required) :param str inbox_id: Inbox ID to search :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerSearchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'imap_server_search_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 imap_server_search" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'imap_server_search_options' is set if self.api_client.client_side_validation and ('imap_server_search_options' not in local_var_params or # noqa: E501 local_var_params['imap_server_search_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `imap_server_search_options` when calling `imap_server_search`") # 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 'imap_server_search_options' in local_var_params: body_params = local_var_params['imap_server_search_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( '/imap/server/search', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapServerSearchResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 imap_server_status(self, imap_server_status_options, **kwargs): # noqa: E501 """Get status for mailbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_status(imap_server_status_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapServerStatusOptions imap_server_status_options: (required) :param str inbox_id: Inbox ID to list :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerStatusResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_status_with_http_info(imap_server_status_options, **kwargs) # noqa: E501 def imap_server_status_with_http_info(self, imap_server_status_options, **kwargs): # noqa: E501 """Get status for mailbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_status_with_http_info(imap_server_status_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapServerStatusOptions imap_server_status_options: (required) :param str inbox_id: Inbox ID to list :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerStatusResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'imap_server_status_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 imap_server_status" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'imap_server_status_options' is set if self.api_client.client_side_validation and ('imap_server_status_options' not in local_var_params or # noqa: E501 local_var_params['imap_server_status_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `imap_server_status_options` when calling `imap_server_status`") # 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 'imap_server_status_options' in local_var_params: body_params = local_var_params['imap_server_status_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( '/imap/server/status', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImapServerStatusResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_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 imap_server_update_flags(self, imap_update_flags_options, **kwargs): # noqa: E501 """imap_server_update_flags # noqa: E501 Update message flags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_update_flags(imap_update_flags_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapUpdateFlagsOptions imap_update_flags_options: (required) :param str inbox_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.imap_server_update_flags_with_http_info(imap_update_flags_options, **kwargs) # noqa: E501 def imap_server_update_flags_with_http_info(self, imap_update_flags_options, **kwargs): # noqa: E501 """imap_server_update_flags # noqa: E501 Update message flags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.imap_server_update_flags_with_http_info(imap_update_flags_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ImapUpdateFlagsOptions imap_update_flags_options: (required) :param str inbox_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'imap_update_flags_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 imap_server_update_flags" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'imap_update_flags_options' is set if self.api_client.client_side_validation and ('imap_update_flags_options' not in local_var_params or # noqa: E501 local_var_params['imap_update_flags_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `imap_update_flags_options` when calling `imap_server_update_flags`") # 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 'imap_update_flags_options' in local_var_params: body_params = local_var_params['imap_update_flags_options'] # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/imap/server/update-flags', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)Methods
def imap_server_fetch(self, seq_num, **kwargs)-
Fetch message in an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_fetch(seq_num, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int seq_num: (required) :param str inbox_id: Inbox ID to search :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerFetchResult If the method is called asynchronously, returns the request thread.
def imap_server_fetch_with_http_info(self, seq_num, **kwargs)-
Fetch message in an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_fetch_with_http_info(seq_num, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int seq_num: (required) :param str inbox_id: Inbox ID to search :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerFetchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def imap_server_get(self, email_id, **kwargs)-
Get a message by email 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.imap_server_get(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: Email ID to get (required) :param str inbox_id: Inbox ID to search :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerGetResult If the method is called asynchronously, returns the request thread.
def imap_server_get_with_http_info(self, email_id, **kwargs)-
Get a message by email 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.imap_server_get_with_http_info(email_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: Email ID to get (required) :param str inbox_id: Inbox ID to search :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerGetResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def imap_server_list(self, imap_server_list_options, **kwargs)-
List messages in an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_list(imap_server_list_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapServerListOptions imap_server_list_options: (required) :param str inbox_id: Inbox ID to list :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerListResult If the method is called asynchronously, returns the request thread.
def imap_server_list_with_http_info(self, imap_server_list_options, **kwargs)-
List messages in an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_list_with_http_info(imap_server_list_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapServerListOptions imap_server_list_options: (required) :param str inbox_id: Inbox ID to list :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerListResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def imap_server_mailbox(self, name, **kwargs)-
Create a new mailbox if possible # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_mailbox(name, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str name: Inbox email address to create (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: ImapServerMailboxResult If the method is called asynchronously, returns the request thread.
def imap_server_mailbox_with_http_info(self, name, **kwargs)-
Create a new mailbox if possible # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_mailbox_with_http_info(name, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str name: Inbox email address to create (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(ImapServerMailboxResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def imap_server_search(self, imap_server_search_options, **kwargs)-
Search messages in an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_search(imap_server_search_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapServerSearchOptions imap_server_search_options: (required) :param str inbox_id: Inbox ID to search :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerSearchResult If the method is called asynchronously, returns the request thread.
def imap_server_search_with_http_info(self, imap_server_search_options, **kwargs)-
Search messages in an inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_search_with_http_info(imap_server_search_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapServerSearchOptions imap_server_search_options: (required) :param str inbox_id: Inbox ID to search :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerSearchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def imap_server_status(self, imap_server_status_options, **kwargs)-
Get status for mailbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_status(imap_server_status_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapServerStatusOptions imap_server_status_options: (required) :param str inbox_id: Inbox ID to list :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: ImapServerStatusResult If the method is called asynchronously, returns the request thread.
def imap_server_status_with_http_info(self, imap_server_status_options, **kwargs)-
Get status for mailbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_status_with_http_info(imap_server_status_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapServerStatusOptions imap_server_status_options: (required) :param str inbox_id: Inbox ID to list :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ImapServerStatusResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def imap_server_update_flags(self, imap_update_flags_options, **kwargs)-
imap_server_update_flags # noqa: E501
Update message flags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_update_flags(imap_update_flags_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapUpdateFlagsOptions imap_update_flags_options: (required) :param str inbox_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def imap_server_update_flags_with_http_info(self, imap_update_flags_options, **kwargs)-
imap_server_update_flags # noqa: E501
Update message flags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.imap_server_update_flags_with_http_info(imap_update_flags_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ImapUpdateFlagsOptions imap_update_flags_options: (required) :param str inbox_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.