class AsposeEmailCloud::ClientMessageFetchFileRequest

Request model for client_message_fetch_file operation.

Attributes

account[RW]

Email account @return [String]

account_storage_folder[RW]

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

folder[RW]

Account folder to fetch from (should be specified for some protocols such as IMAP)

@return [String]

format[RW]

Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft @return [String]

message_id[RW]

Message identifier @return [String]

storage[RW]

Storage name where account file located. @return [String]

Public Class Methods

new(message_id:, account:, folder: nil, storage: nil, account_storage_folder: nil, format: nil) click to toggle source

Fetch message as file from email account

@param [String] message_id Message identifier @param [String] account Email account @param [String] folder Account folder to fetch from (should be specified for some protocols such as IMAP)

@param [String] storage Storage name where account file located. @param [String] account_storage_folder Folder in storage where account file located. @param [String] format Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft

# File lib/aspose-email-cloud/models/client_message_fetch_file_request.rb, line 58
def initialize(message_id:, account:, folder: nil, storage: nil, account_storage_folder: nil, format: nil)
  self.message_id = message_id if message_id
  self.account = account if account
  self.folder = folder if folder
  self.storage = storage if storage
  self.account_storage_folder = account_storage_folder if account_storage_folder
  self.format = format if format
end

Public Instance Methods

to_http_info(api_client) click to toggle source
# File lib/aspose-email-cloud/models/client_message_fetch_file_request.rb, line 67
def to_http_info(api_client)
  # verify the required parameter 'message_id' is set
  if api_client.config.client_side_validation && self.message_id.nil?
    raise ArgumentError, "Missing the required parameter 'message_id' when calling ClientMessageApi.fetch_file"
  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 ClientMessageApi.fetch_file"
  end
  # resource path
  local_var_path = '/email/client/message/file'

  # query parameters
  query_params = {}
  query_params[:messageId] = self.message_id
  query_params[:account] = self.account
  query_params[:folder] = self.folder unless self.folder.nil?
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:accountStorageFolder] = self.account_storage_folder unless self.account_storage_folder.nil?
  query_params[:format] = self.format unless self.format.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(['multipart/form-data'])
  # 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