Class: AsposeEmailCloud::EmailGetAsFileRequest

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

Overview

Request model for email_get_as_file operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(file_name:, format:, storage: nil, folder: nil) ⇒ EmailGetAsFileRequest

Converts email document from storage to specified format and returns as file

Parameters:

  • file_name (String) —

    Email document file name

  • format (String) —

    File format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft

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

    Storage name

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

    Path to folder in storage



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

def initialize(file_name:, format:, storage: nil, folder: nil)
  self.file_name = file_name if file_name
  self.format = format if format
  self.storage = storage if storage
  self.folder = folder if folder
end

Instance Attribute Details

#file_name ⇒ String

Email document file name

Returns:

  • (String) 


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

def file_name
  @file_name
end

#folder ⇒ String

Path to folder in storage

Returns:

  • (String) 


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

def folder
  @folder
end

#format ⇒ String

File format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft

Returns:

  • (String) 


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

def format
  @format
end

#storage ⇒ String

Storage name

Returns:

  • (String) 


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

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
91
92
93
94
 
# File 'lib/aspose-email-cloud/models/email_get_as_file_request.rb', line 57

def to_http_info(api_client)
  # verify the required parameter 'file_name' is set
  if api_client.config.client_side_validation && self.file_name.nil?
    raise ArgumentError, "Missing the required parameter 'file_name' when calling EmailApi.get_as_file"
  end
  # verify the required parameter 'format' is set
  if api_client.config.client_side_validation && self.format.nil?
    raise ArgumentError, "Missing the required parameter 'format' when calling EmailApi.get_as_file"
  end
  # resource path
  local_var_path = '/email/as-file'

  # query parameters
  query_params = {}
  query_params[:fileName] = self.file_name
  query_params[:format] = self.format
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:folder] = self.folder unless self.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(['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