Class: AsposeEmailCloud::MapiMessageDto

Inherits:
MapiMessageItemBaseDto show all
Defined in:
lib/aspose-email-cloud/models/mapi_message_dto.rb

Overview

Represents an Outlook Message format document.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attachments: nil, billing: nil, body: nil, body_html: nil, body_rtf: nil, body_type: nil, categories: nil, companies: nil, item_id: nil, message_class: nil, mileage: nil, recipients: nil, sensitivity: nil, subject: nil, subject_prefix: nil, properties: nil, message_body: nil, client_submit_time: nil, conversation_topic: nil, delivery_time: nil, display_bcc: nil, display_cc: nil, display_name: nil, display_name_prefix: nil, display_to: nil, flags: nil, headers: nil, internet_message_id: nil, message_format: nil, normalized_subject: nil, read_receipt_requested: nil, reply_to: nil, sender_address_type: nil, sender_email_address: nil, sender_name: nil, sender_smtp_address: nil, sent_representing_address_type: nil, sent_representing_email_address: nil, sent_representing_name: nil, sent_representing_smtp_address: nil, transport_message_headers: nil) ⇒ MapiMessageDto

Initializes the object

Parameters:

  • attachments (Array<MapiAttachmentDto>) (defaults to: nil) —

    Message item attachments.

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

    Billing information associated with an item.

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

    Message text.

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

    Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.

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

    RTF formatted message text.

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

    The content type of message body. Enum, available values: PlainText, Html, Rtf

  • categories (Array<String>) (defaults to: nil) —

    Contains keywords or categories for the message object.

  • companies (Array<String>) (defaults to: nil) —

    Contains the names of the companies that are associated with an item.

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

    The item id, uses with a server.

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

    Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.

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

    Contains the mileage information that is associated with an item.

  • recipients (Array<MapiRecipientDto>) (defaults to: nil) —

    Recipients of the message.

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

    Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential

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

    Subject of the message.

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

    Subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.

  • properties (Array<MapiPropertyDto>) (defaults to: nil) —

    List of MAPI properties

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

    Message text

  • client_submit_time (DateTime) (defaults to: nil) —

    Date and time the message sender submitted a message.

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

    Topic of the first message in a conversation thread.

  • delivery_time (DateTime) (defaults to: nil) —

    Date and time a message was delivered.

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

    List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;).

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

    List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;).

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

    Display name for the message.

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

    Prefix of the display name.

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

    List of the display names of the primary (To) message recipients, separated by semicolons (;).

  • flags (Array<String>) (defaults to: nil) —

    Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt

  • headers (Hash<String, String>) (defaults to: nil) —

    Transport message headers

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

    Internet message id of the message.

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

    Represents outlook message format. Enum, available values: Ascii, Unicode

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

    Normalized subject of the message.

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

    Value indicating whether the read receipt is requested.

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

    Reply to names.

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

    Message sender’s e-mail address type.

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

    Message sender’s e-mail address.

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

    Message sender’s display name.

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

    Message sender’s e-mail address.

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

    Address type for the messaging user represented by the sender.

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

    E-mail address for the messaging user represented by the sender.

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

    Display name for the messaging user represented by the sender.

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

    E-mail address for the messaging user represented by the sender.

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

    Transport-specific message envelope information.



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 299

def initialize(
  attachments: nil,
  billing: nil,
  body: nil,
  body_html: nil,
  body_rtf: nil,
  body_type: nil,
  categories: nil,
  companies: nil,
  item_id: nil,
  message_class: nil,
  mileage: nil,
  recipients: nil,
  sensitivity: nil,
  subject: nil,
  subject_prefix: nil,
  properties: nil,
  message_body: nil,
  client_submit_time: nil,
  conversation_topic: nil,
  delivery_time: nil,
  display_bcc: nil,
  display_cc: nil,
  display_name: nil,
  display_name_prefix: nil,
  display_to: nil,
  flags: nil,
  headers: nil,
  internet_message_id: nil,
  message_format: nil,
  normalized_subject: nil,
  read_receipt_requested: nil,
  reply_to: nil,
  sender_address_type: nil,
  sender_email_address: nil,
  sender_name: nil,
  sender_smtp_address: nil,
  sent_representing_address_type: nil,
  sent_representing_email_address: nil,
  sent_representing_name: nil,
  sent_representing_smtp_address: nil,
  transport_message_headers: nil)
  self.attachments = attachments if attachments
  self.billing = billing if billing
  self.body = body if body
  self.body_html = body_html if body_html
  self.body_rtf = body_rtf if body_rtf
  self.body_type = body_type if body_type
  self.categories = categories if categories
  self.companies = companies if companies
  self.item_id = item_id if item_id
  self.message_class = message_class if message_class
  self.mileage = mileage if mileage
  self.recipients = recipients if recipients
  self.sensitivity = sensitivity if sensitivity
  self.subject = subject if subject
  self.subject_prefix = subject_prefix if subject_prefix
  self.properties = properties if properties
  self.message_body = message_body if message_body
  self.client_submit_time = client_submit_time if client_submit_time
  self.conversation_topic = conversation_topic if conversation_topic
  self.delivery_time = delivery_time if delivery_time
  self.display_bcc = display_bcc if display_bcc
  self.display_cc = display_cc if display_cc
  self.display_name = display_name if display_name
  self.display_name_prefix = display_name_prefix if display_name_prefix
  self.display_to = display_to if display_to
  self.flags = flags if flags
  self.headers = headers if headers
  self.internet_message_id = internet_message_id if internet_message_id
  self.message_format = message_format if message_format
  self.normalized_subject = normalized_subject if normalized_subject
  self.read_receipt_requested = read_receipt_requested if read_receipt_requested
  self.reply_to = reply_to if reply_to
  self.sender_address_type = sender_address_type if sender_address_type
  self.sender_email_address = sender_email_address if sender_email_address
  self.sender_name = sender_name if sender_name
  self.sender_smtp_address = sender_smtp_address if sender_smtp_address
  self.sent_representing_address_type = sent_representing_address_type if sent_representing_address_type
  self.sent_representing_email_address = sent_representing_email_address if sent_representing_email_address
  self.sent_representing_name = sent_representing_name if sent_representing_name
  self.sent_representing_smtp_address = sent_representing_smtp_address if sent_representing_smtp_address
  self.transport_message_headers = transport_message_headers if transport_message_headers
end

Instance Attribute Details

#attachments ⇒ Array<MapiAttachmentDto>

Message item attachments.

Returns:



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

def attachments
  @attachments
end

#billing ⇒ String

Billing information associated with an item.

Returns:

  • (String) 


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

def billing
  @billing
end

#body ⇒ String

Message text.

Returns:

  • (String) 


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

def body
  @body
end

#body_html ⇒ String

Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.

Returns:

  • (String) 


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

def body_html
  @body_html
end

#body_rtf ⇒ String

RTF formatted message text.

Returns:

  • (String) 


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

def body_rtf
  @body_rtf
end

#body_type ⇒ String

The content type of message body. Enum, available values: PlainText, Html, Rtf

Returns:

  • (String) 


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

def body_type
  @body_type
end

#categories ⇒ Array<String>

Contains keywords or categories for the message object.

Returns:

  • (Array<String>) 


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

def categories
  @categories
end

#client_submit_time ⇒ DateTime

Date and time the message sender submitted a message.

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 91

def client_submit_time
  @client_submit_time
end

#companies ⇒ Array<String>

Contains the names of the companies that are associated with an item.

Returns:

  • (Array<String>) 


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

def companies
  @companies
end

#conversation_topic ⇒ String

Topic of the first message in a conversation thread.

Returns:

  • (String) 


94
95
96
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 94

def conversation_topic
  @conversation_topic
end

#delivery_time ⇒ DateTime

Date and time a message was delivered.

Returns:

  • (DateTime) 


97
98
99
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 97

def delivery_time
  @delivery_time
end

#display_bcc ⇒ String

List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;).

Returns:

  • (String) 


100
101
102
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 100

def display_bcc
  @display_bcc
end

#display_cc ⇒ String

List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;).

Returns:

  • (String) 


103
104
105
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 103

def display_cc
  @display_cc
end

#display_name ⇒ String

Display name for the message.

Returns:

  • (String) 


106
107
108
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 106

def display_name
  @display_name
end

#display_name_prefix ⇒ String

Prefix of the display name.

Returns:

  • (String) 


109
110
111
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 109

def display_name_prefix
  @display_name_prefix
end

#display_to ⇒ String

List of the display names of the primary (To) message recipients, separated by semicolons (;).

Returns:

  • (String) 


112
113
114
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 112

def display_to
  @display_to
end

#flags ⇒ Array<String>

Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt

Returns:

  • (Array<String>) 


115
116
117
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 115

def flags
  @flags
end

#headers ⇒ Hash<String, String>

Transport message headers

Returns:

  • (Hash<String, String>) 


118
119
120
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 118

def headers
  @headers
end

#internet_message_id ⇒ String

Internet message id of the message.

Returns:

  • (String) 


121
122
123
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 121

def internet_message_id
  @internet_message_id
end

#item_id ⇒ String

The item id, uses with a server.

Returns:

  • (String) 


57
58
59
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 57

def item_id
  @item_id
end

#message_body ⇒ String

Message text

Returns:

  • (String) 


88
89
90
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 88

def message_body
  @message_body
end

#message_class ⇒ String

Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.

Returns:

  • (String) 


60
61
62
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 60

def message_class
  @message_class
end

#message_format ⇒ String

Represents outlook message format. Enum, available values: Ascii, Unicode

Returns:

  • (String) 


124
125
126
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 124

def message_format
  @message_format
end

#mileage ⇒ String

Contains the mileage information that is associated with an item.

Returns:

  • (String) 


63
64
65
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 63

def mileage
  @mileage
end

#normalized_subject ⇒ String

Normalized subject of the message.

Returns:

  • (String) 


127
128
129
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 127

def normalized_subject
  @normalized_subject
end

#properties ⇒ Array<MapiPropertyDto>

List of MAPI properties

Returns:



78
79
80
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 78

def properties
  @properties
end

#read_receipt_requested ⇒ BOOLEAN

Value indicating whether the read receipt is requested.

Returns:

  • (BOOLEAN) 


130
131
132
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 130

def read_receipt_requested
  @read_receipt_requested
end

#recipients ⇒ Array<MapiRecipientDto>

Recipients of the message.

Returns:



66
67
68
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 66

def recipients
  @recipients
end

#reply_to ⇒ String

Reply to names.

Returns:

  • (String) 


133
134
135
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 133

def reply_to
  @reply_to
end

#sender_address_type ⇒ String

Message sender’s e-mail address type.

Returns:

  • (String) 


136
137
138
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 136

def sender_address_type
  @sender_address_type
end

#sender_email_address ⇒ String

Message sender’s e-mail address.

Returns:

  • (String) 


139
140
141
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 139

def sender_email_address
  @sender_email_address
end

#sender_name ⇒ String

Message sender’s display name.

Returns:

  • (String) 


142
143
144
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 142

def sender_name
  @sender_name
end

#sender_smtp_address ⇒ String

Message sender’s e-mail address.

Returns:

  • (String) 


145
146
147
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 145

def sender_smtp_address
  @sender_smtp_address
end

#sensitivity ⇒ String

Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential

Returns:

  • (String) 


69
70
71
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 69

def sensitivity
  @sensitivity
end

#sent_representing_address_type ⇒ String

Address type for the messaging user represented by the sender.

Returns:

  • (String) 


148
149
150
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 148

def sent_representing_address_type
  @sent_representing_address_type
end

#sent_representing_email_address ⇒ String

E-mail address for the messaging user represented by the sender.

Returns:

  • (String) 


151
152
153
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 151

def sent_representing_email_address
  @sent_representing_email_address
end

#sent_representing_name ⇒ String

Display name for the messaging user represented by the sender.

Returns:

  • (String) 


154
155
156
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 154

def sent_representing_name
  @sent_representing_name
end

#sent_representing_smtp_address ⇒ String

E-mail address for the messaging user represented by the sender.

Returns:

  • (String) 


157
158
159
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 157

def sent_representing_smtp_address
  @sent_representing_smtp_address
end

#subject ⇒ String

Subject of the message.

Returns:

  • (String) 


72
73
74
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 72

def subject
  @subject
end

#subject_prefix ⇒ String

Subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.

Returns:

  • (String) 


75
76
77
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 75

def subject_prefix
  @subject_prefix
end

#transport_message_headers ⇒ String

Transport-specific message envelope information.

Returns:

  • (String) 


160
161
162
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 160

def transport_message_headers
  @transport_message_headers
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 162

def self.attribute_map
  {
    :'attachments' => :'attachments',
    :'billing' => :'billing',
    :'body' => :'body',
    :'body_html' => :'bodyHtml',
    :'body_rtf' => :'bodyRtf',
    :'body_type' => :'bodyType',
    :'categories' => :'categories',
    :'companies' => :'companies',
    :'item_id' => :'itemId',
    :'message_class' => :'messageClass',
    :'mileage' => :'mileage',
    :'recipients' => :'recipients',
    :'sensitivity' => :'sensitivity',
    :'subject' => :'subject',
    :'subject_prefix' => :'subjectPrefix',
    :'properties' => :'properties',
    :'discriminator' => :'discriminator',
    :'message_body' => :'messageBody',
    :'client_submit_time' => :'clientSubmitTime',
    :'conversation_topic' => :'conversationTopic',
    :'delivery_time' => :'deliveryTime',
    :'display_bcc' => :'displayBcc',
    :'display_cc' => :'displayCc',
    :'display_name' => :'displayName',
    :'display_name_prefix' => :'displayNamePrefix',
    :'display_to' => :'displayTo',
    :'flags' => :'flags',
    :'headers' => :'headers',
    :'internet_message_id' => :'internetMessageId',
    :'message_format' => :'messageFormat',
    :'normalized_subject' => :'normalizedSubject',
    :'read_receipt_requested' => :'readReceiptRequested',
    :'reply_to' => :'replyTo',
    :'sender_address_type' => :'senderAddressType',
    :'sender_email_address' => :'senderEmailAddress',
    :'sender_name' => :'senderName',
    :'sender_smtp_address' => :'senderSmtpAddress',
    :'sent_representing_address_type' => :'sentRepresentingAddressType',
    :'sent_representing_email_address' => :'sentRepresentingEmailAddress',
    :'sent_representing_name' => :'sentRepresentingName',
    :'sent_representing_smtp_address' => :'sentRepresentingSmtpAddress',
    :'transport_message_headers' => :'transportMessageHeaders'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 210

def self.swagger_types
  {
    :'attachments' => :'Array<MapiAttachmentDto>',
    :'billing' => :'String',
    :'body' => :'String',
    :'body_html' => :'String',
    :'body_rtf' => :'String',
    :'body_type' => :'String',
    :'categories' => :'Array<String>',
    :'companies' => :'Array<String>',
    :'item_id' => :'String',
    :'message_class' => :'String',
    :'mileage' => :'String',
    :'recipients' => :'Array<MapiRecipientDto>',
    :'sensitivity' => :'String',
    :'subject' => :'String',
    :'subject_prefix' => :'String',
    :'properties' => :'Array<MapiPropertyDto>',
    :'discriminator' => :'String',
    :'message_body' => :'String',
    :'client_submit_time' => :'DateTime',
    :'conversation_topic' => :'String',
    :'delivery_time' => :'DateTime',
    :'display_bcc' => :'String',
    :'display_cc' => :'String',
    :'display_name' => :'String',
    :'display_name_prefix' => :'String',
    :'display_to' => :'String',
    :'flags' => :'Array<String>',
    :'headers' => :'Hash<String, String>',
    :'internet_message_id' => :'String',
    :'message_format' => :'String',
    :'normalized_subject' => :'String',
    :'read_receipt_requested' => :'BOOLEAN',
    :'reply_to' => :'String',
    :'sender_address_type' => :'String',
    :'sender_email_address' => :'String',
    :'sender_name' => :'String',
    :'sender_smtp_address' => :'String',
    :'sent_representing_address_type' => :'String',
    :'sent_representing_email_address' => :'String',
    :'sent_representing_name' => :'String',
    :'sent_representing_smtp_address' => :'String',
    :'transport_message_headers' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 434

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attachments == o.attachments &&
      billing == o.billing &&
      body == o.body &&
      body_html == o.body_html &&
      body_rtf == o.body_rtf &&
      body_type == o.body_type &&
      categories == o.categories &&
      companies == o.companies &&
      item_id == o.item_id &&
      message_class == o.message_class &&
      mileage == o.mileage &&
      recipients == o.recipients &&
      sensitivity == o.sensitivity &&
      subject == o.subject &&
      subject_prefix == o.subject_prefix &&
      properties == o.properties &&
      discriminator == o.discriminator &&
      message_body == o.message_body &&
      client_submit_time == o.client_submit_time &&
      conversation_topic == o.conversation_topic &&
      delivery_time == o.delivery_time &&
      display_bcc == o.display_bcc &&
      display_cc == o.display_cc &&
      display_name == o.display_name &&
      display_name_prefix == o.display_name_prefix &&
      display_to == o.display_to &&
      flags == o.flags &&
      headers == o.headers &&
      internet_message_id == o.internet_message_id &&
      message_format == o.message_format &&
      normalized_subject == o.normalized_subject &&
      read_receipt_requested == o.read_receipt_requested &&
      reply_to == o.reply_to &&
      sender_address_type == o.sender_address_type &&
      sender_email_address == o.sender_email_address &&
      sender_name == o.sender_name &&
      sender_smtp_address == o.sender_smtp_address &&
      sent_representing_address_type == o.sent_representing_address_type &&
      sent_representing_email_address == o.sent_representing_email_address &&
      sent_representing_name == o.sent_representing_name &&
      sent_representing_smtp_address == o.sent_representing_smtp_address &&
      transport_message_headers == o.transport_message_headers
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 519

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 589

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 496

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#discriminator ⇒ Object

getter method



79
80
81
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 79

def discriminator #getter method
  self.class.name.split('::').last
end

#discriminator=(discriminator) ⇒ Object

setter method, parameter ignored



83
84
85
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 83

def discriminator=(discriminator) #setter method, parameter ignored
  @discriminator = self.class.name.split('::').last
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


483
484
485
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 483

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



489
490
491
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 489

def hash
  [attachments, billing, body, body_html, body_rtf, body_type, categories, companies, item_id, message_class, mileage, recipients, sensitivity, subject, subject_prefix, properties, discriminator, message_body, client_submit_time, conversation_topic, delivery_time, display_bcc, display_cc, display_name, display_name_prefix, display_to, flags, headers, internet_message_id, message_format, normalized_subject, read_receipt_requested, reply_to, sender_address_type, sender_email_address, sender_name, sender_smtp_address, sent_representing_address_type, sent_representing_email_address, sent_representing_name, sent_representing_smtp_address, transport_message_headers].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 386

def list_invalid_properties
  invalid_properties = Array.new
  if @body_type.nil?
    invalid_properties.push('invalid value for "body_type", body_type cannot be nil.')
  end

  if @sensitivity.nil?
    invalid_properties.push('invalid value for "sensitivity", sensitivity cannot be nil.')
  end

  if @discriminator.nil?
    invalid_properties.push('invalid value for "discriminator", discriminator cannot be nil.')
  end

  if @client_submit_time.nil?
    invalid_properties.push('invalid value for "client_submit_time", client_submit_time cannot be nil.')
  end

  if @delivery_time.nil?
    invalid_properties.push('invalid value for "delivery_time", delivery_time cannot be nil.')
  end

  if @message_format.nil?
    invalid_properties.push('invalid value for "message_format", message_format cannot be nil.')
  end

  if @read_receipt_requested.nil?
    invalid_properties.push('invalid value for "read_receipt_requested", read_receipt_requested cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



569
570
571
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 569

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



575
576
577
578
579
580
581
582
583
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 575

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



563
564
565
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 563

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



421
422
423
424
425
426
427
428
429
430
 
# File 'lib/aspose-email-cloud/models/mapi_message_dto.rb', line 421

def valid?
  return false if @body_type.nil?
  return false if @sensitivity.nil?
  return false if @discriminator.nil?
  return false if @client_submit_time.nil?
  return false if @delivery_time.nil?
  return false if @message_format.nil?
  return false if @read_receipt_requested.nil?
  true
end