Class: AsposeEmailCloud::ClientThreadGetMessagesRequest

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

Overview

Request model for client_thread_get_messages operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(thread_id:, account:, folder: nil, storage: nil, account_storage_folder: nil) ⇒ ClientThreadGetMessagesRequest

Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned.

Parameters:

  • thread_id (String) —

    Thread identifier

  • account (String) —

    Email account

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

    Specifies account folder to get thread from

  • 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



54
55
56
57
58
59
60
 
# File 'lib/aspose-email-cloud/models/client_thread_get_messages_request.rb', line 54

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

Instance Attribute Details

#account ⇒ String

Email account

Returns:

  • (String) 


37
38
39
 
# File 'lib/aspose-email-cloud/models/client_thread_get_messages_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_thread_get_messages_request.rb', line 46

def 
  @account_storage_folder
end

#folder ⇒ String

Specifies account folder to get thread from

Returns:

  • (String) 


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

def folder
  @folder
end

#storage ⇒ String

Storage name where account file located

Returns:

  • (String) 


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

def storage
  @storage
end

#thread_id ⇒ String

Thread identifier

Returns:

  • (String) 


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

def thread_id
  @thread_id
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



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
95
96
97
98
99
100
 
# File 'lib/aspose-email-cloud/models/client_thread_get_messages_request.rb', line 62

def to_http_info(api_client)
  # verify the required parameter 'thread_id' is set
  if api_client.config.client_side_validation && self.thread_id.nil?
    raise ArgumentError, "Missing the required parameter 'thread_id' when calling ClientThreadApi.get_messages"
  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 ClientThreadApi.get_messages"
  end
  # resource path
  local_var_path = '/email/client/thread/messages'

  # query parameters
  query_params = {}
  query_params[:threadId] = self.thread_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?

  # 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