Class: AsposeEmailCloud::ClientFolderGetListRequest

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

Overview

Request model for client_folder_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(account:, storage: nil, account_storage_folder: nil, parent_folder: nil) ⇒ ClientFolderGetListRequest

Get folders list in email account

Parameters:

  • 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

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

    Folder in which subfolders should be listed



50
51
52
53
54
55
 
# File 'lib/aspose-email-cloud/models/client_folder_get_list_request.rb', line 50

def initialize(account:, storage: nil, account_storage_folder: nil, parent_folder: nil)
  self. =  if 
  self.storage = storage if storage
  self. =  if 
  self.parent_folder = parent_folder if parent_folder
end

Instance Attribute Details

#account ⇒ String

Email account

Returns:

  • (String) 


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

def 
  @account
end

#account_storage_folder ⇒ String

Folder in storage where account file located

Returns:

  • (String) 


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

def 
  @account_storage_folder
end

#parent_folder ⇒ String

Folder in which subfolders should be listed

Returns:

  • (String) 


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

def parent_folder
  @parent_folder
end

#storage ⇒ String

Storage name where account file located

Returns:

  • (String) 


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

def storage
  @storage
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose-email-cloud/models/client_folder_get_list_request.rb', line 57

def to_http_info(api_client)
  # 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 ClientFolderApi.get_list"
  end
  # resource path
  local_var_path = '/email/client/folder/list'

  # query parameters
  query_params = {}
  query_params[:account] = self.
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:accountStorageFolder] = self. unless self..nil?
  query_params[:parentFolder] = self.parent_folder unless self.parent_folder.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