class AsposeEmailCloud::ClientThreadGetListRequest

Request model for client_thread_get_list operation.

Attributes

account[RW]

Email account @return [String]

account_storage_folder[RW]

Folder in storage where account file located @return [String]

folder[RW]

A folder in email account.

@return [String]

messages_cache_limit[RW]

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

@return [Integer]

storage[RW]

Storage name where account file located @return [String]

update_folder_cache[RW]

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

@return [BOOLEAN]

Public Class Methods

new(folder:, account:, storage: nil, account_storage_folder: nil, update_folder_cache: nil, messages_cache_limit: nil) click to toggle source

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

@param [String] folder A folder in email account.

@param [String] account Email account @param [String] storage Storage name where account file located @param [String] account_storage_folder Folder in storage where account file located @param [BOOLEAN] update_folder_cache 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

@param [Integer] messages_cache_limit Limit messages cache size if CacheFile is used. Ignored in accounts without limits support

# 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.account = account if account
  self.storage = storage if storage
  self.account_storage_folder = account_storage_folder if account_storage_folder
  self.update_folder_cache = update_folder_cache if update_folder_cache
  self.messages_cache_limit = messages_cache_limit if messages_cache_limit
end

Public Instance Methods

to_http_info(api_client) click to toggle source
# 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.account.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.account
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:accountStorageFolder] = self.account_storage_folder unless self.account_storage_folder.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