Class: AsposeEmailCloud::ClientThreadGetListRequest

Inherits:
EmailRequest
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/client_thread_get_list_request.rb

Overview

Request model for client_thread_get_list operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(folder:, account:, storage: nil, account_storage_folder: nil, update_folder_cache: nil, messages_cache_limit: nil) ⇒ ClientThreadGetListRequest

Get message threads from folder. All messages are partly fetched (without email body and some other fields).

Parameters:

  • folder (String) —

    A folder in email account.

  • account (String) —

    Email account

  • storage (String) (defaults to: nil) —

    Storage name where account file located

  • account_storage_folder (String) (defaults to: nil) —

    Folder in storage where account file located

  • update_folder_cache (BOOLEAN) (defaults to: nil) —

    This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account

  • messages_cache_limit (Integer) (defaults to: nil) —

    Limit messages cache size if CacheFile is used. Ignored in accounts without limits support



58
59
60
61
62
63
64
65
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 58

def initialize(folder:, account:, storage: nil, account_storage_folder: nil, update_folder_cache: nil, messages_cache_limit: nil)
  self.folder = folder if folder
  self. =  if 
  self.storage = storage if storage
  self. =  if 
  self.update_folder_cache = update_folder_cache if update_folder_cache
  self.messages_cache_limit = messages_cache_limit if messages_cache_limit
end

Instance Attribute Details

#account ⇒ String

Email account

Returns:

  • (String) 


37
38
39
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 37

def 
  @account
end

#account_storage_folder ⇒ String

Folder in storage where account file located

Returns:

  • (String) 


43
44
45
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 43

def 
  @account_storage_folder
end

#folder ⇒ String

A folder in email account.

Returns:

  • (String) 


34
35
36
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 34

def folder
  @folder
end

#messages_cache_limit ⇒ Integer

Limit messages cache size if CacheFile is used. Ignored in accounts without limits support

Returns:

  • (Integer) 


49
50
51
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 49

def messages_cache_limit
  @messages_cache_limit
end

#storage ⇒ String

Storage name where account file located

Returns:

  • (String) 


40
41
42
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 40

def storage
  @storage
end

#update_folder_cache ⇒ BOOLEAN

This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account

Returns:

  • (BOOLEAN) 


46
47
48
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 46

def update_folder_cache
  @update_folder_cache
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aspose-email-cloud/models/client_thread_get_list_request.rb', line 67

def to_http_info(api_client)
  # verify the required parameter 'folder' is set
  if api_client.config.client_side_validation && self.folder.nil?
    raise ArgumentError, "Missing the required parameter 'folder' when calling ClientThreadApi.get_list"
  end
  # verify the required parameter 'account' is set
  if api_client.config.client_side_validation && self..nil?
    raise ArgumentError, "Missing the required parameter 'account' when calling ClientThreadApi.get_list"
  end
  # resource path
  local_var_path = '/email/client/thread/list'

  # query parameters
  query_params = {}
  query_params[:folder] = self.folder
  query_params[:account] = self.
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:accountStorageFolder] = self. unless self..nil?
  query_params[:updateFolderCache] = self.update_folder_cache unless self.update_folder_cache.nil?
  query_params[:messagesCacheLimit] = self.messages_cache_limit unless self.messages_cache_limit.nil?

  # form parameters
  form_params = {}

  # http body (model)
  auth_names = ['JWT']

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = EmailRequest.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['application/json'])

  AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                    header_params: header_params,
                                    query_params: query_params,
                                    form_params: form_params,
                                    auth_names: auth_names)
end