Class: AsposeEmailCloud::MapiMessageItemBaseDto

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

Overview

Base Dto for MapiMessage, MapiCalendar or MapiContact

Direct Known Subclasses

MapiCalendarDto, MapiContactDto, MapiMessageDto

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) ⇒ MapiMessageItemBaseDto

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 149

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)
  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
end

Instance Attribute Details

#attachments ⇒ Array<MapiAttachmentDto>

Message item attachments.

Returns:



33
34
35
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_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_item_base_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_item_base_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_item_base_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_item_base_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_item_base_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_item_base_dto.rb', line 51

def categories
  @categories
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_item_base_dto.rb', line 54

def companies
  @companies
end

#item_id ⇒ String

The item id, uses with a server.

Returns:

  • (String) 


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

def item_id
  @item_id
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_item_base_dto.rb', line 60

def message_class
  @message_class
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_item_base_dto.rb', line 63

def mileage
  @mileage
end

#properties ⇒ Array<MapiPropertyDto>

List of MAPI properties

Returns:



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

def properties
  @properties
end

#recipients ⇒ Array<MapiRecipientDto>

Recipients of the message.

Returns:



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

def recipients
  @recipients
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_item_base_dto.rb', line 69

def sensitivity
  @sensitivity
end

#subject ⇒ String

Subject of the message.

Returns:

  • (String) 


72
73
74
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_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_item_base_dto.rb', line 75

def subject_prefix
  @subject_prefix
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 87

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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 110

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 214

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 274

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 344

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 251

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_item_base_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_item_base_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


238
239
240
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 244

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 186

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

  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



324
325
326
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 324

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



330
331
332
333
334
335
336
337
338
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 330

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



318
319
320
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 318

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



205
206
207
208
209
210
 
# File 'lib/aspose-email-cloud/models/mapi_message_item_base_dto.rb', line 205

def valid?
  return false if @body_type.nil?
  return false if @sensitivity.nil?
  return false if @discriminator.nil?
  true
end