Class: AsposeEmailCloud::EmailConvertRequest

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

Overview

Request model for email_convert operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(from_format:, to_format:, file:) ⇒ EmailConvertRequest

Converts email document to specified format and returns as file

Parameters:

  • from_format (String) —

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

  • to_format (String) —

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

  • file (File) —

    File to convert



46
47
48
49
50
 
# File 'lib/aspose-email-cloud/models/email_convert_request.rb', line 46

def initialize(from_format:, to_format:, file:)
  self.from_format = from_format if from_format
  self.to_format = to_format if to_format
  self.file = file if file
end

Instance Attribute Details

#file ⇒ File

File to convert

Returns:

  • (File) 


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

def file
  @file
end

#from_format ⇒ String

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

Returns:

  • (String) 


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

def from_format
  @from_format
end

#to_format ⇒ String

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

Returns:

  • (String) 


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

def to_format
  @to_format
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



52
53
54
55
56
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
 
# File 'lib/aspose-email-cloud/models/email_convert_request.rb', line 52

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

  # query parameters
  query_params = {}
  query_params[:fromFormat] = self.from_format
  query_params[:toFormat] = self.to_format

  # form parameters
  form_params = {}
  form_params['File'] = self.file

  # 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(['multipart/form-data'])

  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