Class: AsposeEmailCloud::ClientMessageFetchRequest

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

Overview

Request model for client_message_fetch operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(message_id:, account:, folder: nil, storage: nil, account_storage_folder: nil, type: nil, format: nil) ⇒ ClientMessageFetchRequest

Fetch message from email account

Parameters:

  • message_id (String) —

    Message identifier

  • account (String) —

    Email account

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

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

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

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

    MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64

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

    Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft



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

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

Instance Attribute Details

#account ⇒ String

Email account

Returns:

  • (String) 


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

def 
  @account
end

#account_storage_folder ⇒ String

Folder in storage where account file located.

Returns:

  • (String) 


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

def 
  @account_storage_folder
end

#folder ⇒ String

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

Returns:

  • (String) 


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

def folder
  @folder
end

#format ⇒ String

Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft

Returns:

  • (String) 


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

def format
  @format
end

#message_id ⇒ String

Message identifier

Returns:

  • (String) 


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

def message_id
  @message_id
end

#storage ⇒ String

Storage name where account file located.

Returns:

  • (String) 


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

def storage
  @storage
end

#type ⇒ String

MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64

Returns:

  • (String) 


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

def type
  @type
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_fetch_request.rb', line 72

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

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