Class: AsposeEmailCloud::ClientMessageListRequest

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

Overview

Request model for client_message_list operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(folder:, account:, query_string: nil, storage: nil, account_storage_folder: nil, recursive: nil, type: nil, format: nil) ⇒ ClientMessageListRequest

Get messages from folder, filtered by query

The query string should have the following view. The example of a simple expression: '<Field name>' <Comparison operator> '<Field value>', where <Field Name> - the name of a message field through which filtering is made, <Comparison operator> - comparison operators, as their name implies, allow to compare message field and specified value, <Field value> - value to be compared with a message field. The number of simple expressions can make a compound one, ex.: (<Simple expression 1> & <Simple expression 2>) | <Simple expression 3 >, where "&" - logical-AND operator, "|" - logical-OR operator At present the following values are allowed as a field name (<Field name>): "To" - represents a TO field of message, "Text" - represents string in the header or body of the message, "Bcc" - represents a BCC field of message, "Body" - represents a string in the body of message, "Cc" - represents a CC field of message, "From" - represents a From field of message, "Subject" - represents a string in the subject of message, "InternalDate" - represents an internal date of message, "SentDate" - represents a sent date of message Additionally, the following field names are allowed for IMAP-protocol: "Answered" - represents an /Answered flag of message "Seen" - represents a /Seen flag of message "Flagged" - represents a /Flagged flag of message "Draft" - represents a /Draft flag of message "Deleted" - represents a Deleted/ flag of message "Recent" - represents a Deleted/ flag of message "MessageSize" - represents a size (in bytes) of message Additionally, the following field names are allowed for Exchange: "IsRead" - Indicates whether the message has been read "HasAttachment" - Indicates whether or not the message has attachments "IsSubmitted" - Indicates whether the message has been submitted to the Outbox "ContentClass" - represents a content class of item The field value (<Field value>) can take the following values: For text fields - any string, For date type fields - the string of "d-MMM-yyy" format, ex. "10-Feb-2009", For flags (fields of boolean type) - either "True", or "False"

Parameters:

  • folder (String) —

    A folder in email account

  • account (String) —

    Email account

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

    A MailQuery search string

  • 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

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

    Specifies that should message be searched in subfolders recursively

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

    MailMessageBase type. Using this property you can get messages 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



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aspose-email-cloud/models/client_message_list_request.rb', line 67

def initialize(folder:, account:, query_string: nil, storage: nil, account_storage_folder: nil, recursive: nil, type: nil, format: nil)
  self.folder = folder if folder
  self. =  if 
  self.query_string = query_string if query_string
  self.storage = storage if storage
  self. =  if 
  self.recursive = recursive if recursive
  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_list_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_list_request.rb', line 46

def 
  @account_storage_folder
end

#folder ⇒ String

A folder in email account

Returns:

  • (String) 


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

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) 


55
56
57
 
# File 'lib/aspose-email-cloud/models/client_message_list_request.rb', line 55

def format
  @format
end

#query_string ⇒ String

A MailQuery search string

Returns:

  • (String) 


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

def query_string
  @query_string
end

#recursive ⇒ BOOLEAN

Specifies that should message be searched in subfolders recursively

Returns:

  • (BOOLEAN) 


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

def recursive
  @recursive
end

#storage ⇒ String

Storage name where account file located

Returns:

  • (String) 


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

def storage
  @storage
end

#type ⇒ String

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

Returns:

  • (String) 


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

def type
  @type
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



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
113
114
115
116
117
118
119
 
# File 'lib/aspose-email-cloud/models/client_message_list_request.rb', line 78

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

  # query parameters
  query_params = {}
  query_params[:folder] = self.folder
  query_params[:account] = self.
  query_params[:queryString] = self.query_string unless self.query_string.nil?
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:accountStorageFolder] = self. unless self..nil?
  query_params[:recursive] = self.recursive unless self.recursive.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