Class: MailSlurpClient::EmailProjection

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/email_projection.rb

Overview

A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailProjection

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

[View source]

147
148
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
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
208
209
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
256
257
258
259
260
261
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 147

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::EmailProjection` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::EmailProjection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'sender')
    self.sender = attributes[:'sender']
  end

  if attributes.key?(:'recipients')
    self.recipients = attributes[:'recipients']
  end

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end

  if attributes.key?(:'inbox_id')
    self.inbox_id = attributes[:'inbox_id']
  end

  if attributes.key?(:'to')
    if (value = attributes[:'to']).is_a?(Array)
      self.to = value
    end
  end

  if attributes.key?(:'cc')
    if (value = attributes[:'cc']).is_a?(Array)
      self.cc = value
    end
  end

  if attributes.key?(:'bcc')
    if (value = attributes[:'bcc']).is_a?(Array)
      self.bcc = value
    end
  end

  if attributes.key?(:'message_id')
    self.message_id = attributes[:'message_id']
  end

  if attributes.key?(:'domain_id')
    self.domain_id = attributes[:'domain_id']
  end

  if attributes.key?(:'favourite')
    self.favourite = attributes[:'favourite']
  end

  if attributes.key?(:'plus_address')
    self.plus_address = attributes[:'plus_address']
  end

  if attributes.key?(:'in_reply_to')
    self.in_reply_to = attributes[:'in_reply_to']
  end

  if attributes.key?(:'read')
    self.read = attributes[:'read']
  end

  if attributes.key?(:'body_excerpt')
    self.body_excerpt = attributes[:'body_excerpt']
  end

  if attributes.key?(:'text_excerpt')
    self.text_excerpt = attributes[:'text_excerpt']
  end

  if attributes.key?(:'body_part_content_types')
    if (value = attributes[:'body_part_content_types']).is_a?(Array)
      self.body_part_content_types = value
    end
  end

  if attributes.key?(:'body_md5_hash')
    self.body_md5_hash = attributes[:'body_md5_hash']
  end

  if attributes.key?(:'team_access')
    self.team_access = attributes[:'team_access']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'thread_id')
    self.thread_id = attributes[:'thread_id']
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end
end

Instance Attribute Details

#attachments ⇒ Object

Returns the value of attribute attachments.


26
27
28
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 26

def attachments
  @attachments
end

#bcc ⇒ Object

Returns the value of attribute bcc.


34
35
36
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 34

def bcc
  @bcc
end

#body_excerpt ⇒ Object

Returns the value of attribute body_excerpt.


48
49
50
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 48

def body_excerpt
  @body_excerpt
end

#body_md5_hash ⇒ Object

Returns the value of attribute body_md5_hash.


54
55
56
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 54

def body_md5_hash
  @body_md5_hash
end

#body_part_content_types ⇒ Object

Returns the value of attribute body_part_content_types.


52
53
54
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 52

def body_part_content_types
  @body_part_content_types
end

#cc ⇒ Object

Returns the value of attribute cc.


32
33
34
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 32

def cc
  @cc
end

#created_at ⇒ Object

Returns the value of attribute created_at.


20
21
22
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 20

def created_at
  @created_at
end

#domain_id ⇒ Object

Returns the value of attribute domain_id.


38
39
40
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 38

def domain_id
  @domain_id
end

#favourite ⇒ Object

Returns the value of attribute favourite.


40
41
42
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 40

def favourite
  @favourite
end

#from ⇒ Object

Returns the value of attribute from.


62
63
64
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 62

def from
  @from
end

#id ⇒ Object

Returns the value of attribute id.


58
59
60
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 58

def id
  @id
end

#in_reply_to ⇒ Object

Returns the value of attribute in_reply_to.


44
45
46
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 44

def in_reply_to
  @in_reply_to
end

#inbox_id ⇒ Object

Returns the value of attribute inbox_id.


28
29
30
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 28

def inbox_id
  @inbox_id
end

#message_id ⇒ Object

Returns the value of attribute message_id.


36
37
38
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 36

def message_id
  @message_id
end

#plus_address ⇒ Object

Returns the value of attribute plus_address.


42
43
44
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 42

def plus_address
  @plus_address
end

#read ⇒ Object

Returns the value of attribute read.


46
47
48
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 46

def read
  @read
end

#recipients ⇒ Object

Returns the value of attribute recipients.


24
25
26
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 24

def recipients
  @recipients
end

#sender ⇒ Object

Returns the value of attribute sender.


22
23
24
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 22

def sender
  @sender
end

#subject ⇒ Object

Returns the value of attribute subject.


18
19
20
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 18

def subject
  @subject
end

#team_access ⇒ Object

Returns the value of attribute team_access.


56
57
58
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 56

def team_access
  @team_access
end

#text_excerpt ⇒ Object

Returns the value of attribute text_excerpt.


50
51
52
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 50

def text_excerpt
  @text_excerpt
end

#thread_id ⇒ Object

Returns the value of attribute thread_id.


60
61
62
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 60

def thread_id
  @thread_id
end

#to ⇒ Object

Returns the value of attribute to.


30
31
32
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 30

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 65

def self.attribute_map
  {
    :'subject' => :'subject',
    :'created_at' => :'createdAt',
    :'sender' => :'sender',
    :'recipients' => :'recipients',
    :'attachments' => :'attachments',
    :'inbox_id' => :'inboxId',
    :'to' => :'to',
    :'cc' => :'cc',
    :'bcc' => :'bcc',
    :'message_id' => :'messageId',
    :'domain_id' => :'domainId',
    :'favourite' => :'favourite',
    :'plus_address' => :'plusAddress',
    :'in_reply_to' => :'inReplyTo',
    :'read' => :'read',
    :'body_excerpt' => :'bodyExcerpt',
    :'text_excerpt' => :'textExcerpt',
    :'body_part_content_types' => :'bodyPartContentTypes',
    :'body_md5_hash' => :'bodyMD5Hash',
    :'team_access' => :'teamAccess',
    :'id' => :'id',
    :'thread_id' => :'threadId',
    :'from' => :'from'
  }
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

[View source]

351
352
353
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 351

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true

[View source]

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 123

def self.openapi_nullable
  Set.new([
    :'subject',
    :'sender',
    :'recipients',
    :'attachments',
    :'cc',
    :'bcc',
    :'message_id',
    :'domain_id',
    :'favourite',
    :'plus_address',
    :'in_reply_to',
    :'body_excerpt',
    :'text_excerpt',
    :'body_part_content_types',
    :'body_md5_hash',
    :'thread_id',
    :'from'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.

[View source]

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
120
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 94

def self.openapi_types
  {
    :'subject' => :'String',
    :'created_at' => :'DateTime',
    :'sender' => :'Sender',
    :'recipients' => :'EmailRecipients',
    :'attachments' => :'Array<String>',
    :'inbox_id' => :'String',
    :'to' => :'Array<String>',
    :'cc' => :'Array<String>',
    :'bcc' => :'Array<String>',
    :'message_id' => :'String',
    :'domain_id' => :'String',
    :'favourite' => :'Boolean',
    :'plus_address' => :'String',
    :'in_reply_to' => :'String',
    :'read' => :'Boolean',
    :'body_excerpt' => :'String',
    :'text_excerpt' => :'String',
    :'body_part_content_types' => :'Array<String>',
    :'body_md5_hash' => :'String',
    :'team_access' => :'Boolean',
    :'id' => :'String',
    :'thread_id' => :'String',
    :'from' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

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
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subject == o.subject &&
      created_at == o.created_at &&
      sender == o.sender &&
      recipients == o.recipients &&
      attachments == o.attachments &&
      inbox_id == o.inbox_id &&
      to == o.to &&
      cc == o.cc &&
      bcc == o.bcc &&
      message_id == o.message_id &&
      domain_id == o.domain_id &&
      favourite == o.favourite &&
      plus_address == o.plus_address &&
      in_reply_to == o.in_reply_to &&
      read == o.read &&
      body_excerpt == o.body_excerpt &&
      text_excerpt == o.text_excerpt &&
      body_part_content_types == o.body_part_content_types &&
      body_md5_hash == o.body_md5_hash &&
      team_access == o.team_access &&
      id == o.id &&
      thread_id == o.thread_id &&
      from == o.from
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

[View source]

379
380
381
382
383
384
385
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
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 379

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
    MailSlurpClient.const_get(type).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

[View source]

448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 448

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

[View source]

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 358

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

338
339
340
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code

[View source]

344
345
346
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 344

def hash
  [subject, created_at, sender, recipients, attachments, inbox_id, to, cc, bcc, message_id, domain_id, favourite, plus_address, in_reply_to, read, body_excerpt, text_excerpt, body_part_content_types, body_md5_hash, team_access, id, thread_id, from].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

[View source]

265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 265

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

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

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

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

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

  if @id.nil?
    invalid_properties.push('invalid value for "id", id 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

[View source]

424
425
426
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 424

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

[View source]

430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 430

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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

[View source]

418
419
420
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 418

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

[View source]

296
297
298
299
300
301
302
303
304
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 296

def valid?
  return false if @created_at.nil?
  return false if @inbox_id.nil?
  return false if @to.nil?
  return false if @read.nil?
  return false if @team_access.nil?
  return false if @id.nil?
  true
end