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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 107

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?(:'created_at')
    self.created_at = attributes[:'created_at']
  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?(:'domain_id')
    self.domain_id = attributes[:'domain_id']
  end

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

  if attributes.key?(:'cc')
    if (value = attributes[:'cc']).is_a?(Array)
      self.cc = value
    end
  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?(:'team_access')
    self.team_access = attributes[:'team_access']
  end

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

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

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

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

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

Instance Attribute Details

#attachments ⇒ Object

Returns the value of attribute attachments.



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

def attachments
  @attachments
end

#bcc ⇒ Object

Returns the value of attribute bcc.



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

def bcc
  @bcc
end

#body_excerpt ⇒ Object

Returns the value of attribute body_excerpt.



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

def body_excerpt
  @body_excerpt
end

#body_md5_hash ⇒ Object

Returns the value of attribute body_md5_hash.



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

def body_md5_hash
  @body_md5_hash
end

#cc ⇒ Object

Returns the value of attribute cc.



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

def cc
  @cc
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#domain_id ⇒ Object

Returns the value of attribute domain_id.



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

def domain_id
  @domain_id
end

#from ⇒ Object

Returns the value of attribute from.



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

def from
  @from
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#inbox_id ⇒ Object

Returns the value of attribute inbox_id.



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

def inbox_id
  @inbox_id
end

#read ⇒ Object

Returns the value of attribute read.



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

def read
  @read
end

#subject ⇒ Object

Returns the value of attribute subject.



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

def subject
  @subject
end

#team_access ⇒ Object

Returns the value of attribute team_access.



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

def team_access
  @team_access
end

#text_excerpt ⇒ Object

Returns the value of attribute text_excerpt.



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

def text_excerpt
  @text_excerpt
end

#to ⇒ Object

Returns the value of attribute to.



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

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 49

def self.attribute_map
  {
    :'created_at' => :'createdAt',
    :'attachments' => :'attachments',
    :'inbox_id' => :'inboxId',
    :'to' => :'to',
    :'domain_id' => :'domainId',
    :'bcc' => :'bcc',
    :'cc' => :'cc',
    :'read' => :'read',
    :'body_excerpt' => :'bodyExcerpt',
    :'team_access' => :'teamAccess',
    :'body_md5_hash' => :'bodyMD5Hash',
    :'text_excerpt' => :'textExcerpt',
    :'subject' => :'subject',
    :'id' => :'id',
    :'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



269
270
271
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 269

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 91

def self.openapi_nullable
  Set.new([
    :'attachments',
    :'domain_id',
    :'bcc',
    :'cc',
    :'body_excerpt',
    :'body_md5_hash',
    :'text_excerpt',
    :'subject',
    :'from'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 70

def self.openapi_types
  {
    :'created_at' => :'DateTime',
    :'attachments' => :'Array<String>',
    :'inbox_id' => :'String',
    :'to' => :'Array<String>',
    :'domain_id' => :'String',
    :'bcc' => :'Array<String>',
    :'cc' => :'Array<String>',
    :'read' => :'Boolean',
    :'body_excerpt' => :'String',
    :'team_access' => :'Boolean',
    :'body_md5_hash' => :'String',
    :'text_excerpt' => :'String',
    :'subject' => :'String',
    :'id' => :'String',
    :'from' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 234

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



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

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 366

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 276

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


256
257
258
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



262
263
264
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 262

def hash
  [created_at, attachments, inbox_id, to, domain_id, bcc, cc, read, body_excerpt, team_access, body_md5_hash, text_excerpt, subject, 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



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

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



342
343
344
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 342

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 348

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



336
337
338
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 336

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



222
223
224
225
226
227
228
229
230
 
# File 'lib/mailslurp_client/models/email_projection.rb', line 222

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