Class: AsposeEmailCloud::ClientMessageAppendFileRequest

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

Overview

Request model for client_message_append_file operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(account:, file:, storage: nil, account_storage_folder: nil, format: nil, folder: nil, mark_as_sent: nil) ⇒ ClientMessageAppendFileRequest

Add email message from file to specified folder in email account.

Parameters:

  • account (String) —

    Email account.

  • file (File) —

    Message file to append.

  • 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.

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

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

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

    Path to folder on email server to append message to.

  • mark_as_sent (BOOLEAN) (defaults to: nil) —

    Determines that appended message should be market as sent or not.



62
63
64
65
66
67
68
69
70
 
# File 'lib/aspose-email-cloud/models/client_message_append_file_request.rb', line 62

def initialize(account:, file:, storage: nil, account_storage_folder: nil, format: nil, folder: nil, mark_as_sent: nil)
  self. =  if 
  self.file = file if file
  self.storage = storage if storage
  self. =  if 
  self.format = format if format
  self.folder = folder if folder
  self.mark_as_sent = mark_as_sent if mark_as_sent
end

Instance Attribute Details

#account ⇒ String

Email account.

Returns:

  • (String) 


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

def 
  @account
end

#account_storage_folder ⇒ String

Folder in storage where account file located.

Returns:

  • (String) 


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

def 
  @account_storage_folder
end

#file ⇒ File

Message file to append.

Returns:

  • (File) 


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

def file
  @file
end

#folder ⇒ String

Path to folder on email server to append message to.

Returns:

  • (String) 


49
50
51
 
# File 'lib/aspose-email-cloud/models/client_message_append_file_request.rb', line 49

def folder
  @folder
end

#format ⇒ String

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

Returns:

  • (String) 


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

def format
  @format
end

#mark_as_sent ⇒ BOOLEAN

Determines that appended message should be market as sent or not.

Returns:

  • (BOOLEAN) 


52
53
54
 
# File 'lib/aspose-email-cloud/models/client_message_append_file_request.rb', line 52

def mark_as_sent
  @mark_as_sent
end

#storage ⇒ String

Storage name where account file located.

Returns:

  • (String) 


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

def storage
  @storage
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aspose-email-cloud/models/client_message_append_file_request.rb', line 72

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 ClientMessageApi.append_file"
  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 ClientMessageApi.append_file"
  end
  # resource path
  local_var_path = '/email/client/message/file/append'

  # 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[:format] = self.format unless self.format.nil?
  query_params[:folder] = self.folder unless self.folder.nil?
  query_params[:markAsSent] = self.mark_as_sent unless self.mark_as_sent.nil?

  # 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(['application/json'])
  # 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