class AsposeEmailCloud::ClientFolderApi

ClientFolderApi operations.

Attributes

api_invoker[R]

Public Class Methods

new(api_invoker) click to toggle source

Initializes a new instance of the ClientFolderApi class. @param [ApiInvoker] api_invoker

# File lib/aspose-email-cloud/api/client_folder_api.rb, line 45
def initialize(api_invoker)
  @api_invoker = api_invoker
end

Public Instance Methods

create(request) click to toggle source

Create new folder in email account

@param [ClientFolderCreateRequest] request Create folder request @return [nil]

# File lib/aspose-email-cloud/api/client_folder_api.rb, line 52
def create(request)
  # verify the required parameter 'request' is set
  if @api_invoker.api_client.config.client_side_validation && request.nil?
    raise ArgumentError, "Missing the required parameter 'request' when calling ClientFolderApi.create"
  end

  local_var_path = '/email/client/folder'
  post_body = @api_invoker.api_client.object_to_http_body(request)
  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'] = EmailRequest.select_header_content_type(['application/json'])
  http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                                   header_params: header_params,
                                                   body: post_body,
                                                   auth_names: auth_names)

  @api_invoker.make_request(http_request, :PUT, nil)
  nil
end
delete(request) click to toggle source

Delete a folder in email account

@param [ClientFolderDeleteRequest] request Delete folder request @return [nil]

# File lib/aspose-email-cloud/api/client_folder_api.rb, line 80
def delete(request)
  # verify the required parameter 'request' is set
  if @api_invoker.api_client.config.client_side_validation && request.nil?
    raise ArgumentError, "Missing the required parameter 'request' when calling ClientFolderApi.delete"
  end

  local_var_path = '/email/client/folder'
  post_body = @api_invoker.api_client.object_to_http_body(request)
  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'] = EmailRequest.select_header_content_type(['application/json'])
  http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                                   header_params: header_params,
                                                   body: post_body,
                                                   auth_names: auth_names)

  @api_invoker.make_request(http_request, :DELETE, nil)
  nil
end
get_list(request) click to toggle source

Get folders list in email account

@param [ClientFolderGetListRequest] request Request object. @return [MailServerFolderList]

# File lib/aspose-email-cloud/api/client_folder_api.rb, line 108
def get_list(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :GET, 'MailServerFolderList')
end