Class: MailSlurpClient::EmailPreview

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

Overview

Preview of an email message. For full message (including body and attachments) call the `getEmail` or other email endpoints with the provided email ID.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailPreview

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::EmailPreview` 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::EmailPreview`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'favourite')
    self.favourite = attributes[:'favourite']
  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?(:'plus_address')
    self.plus_address = attributes[:'plus_address']
  end
end

Instance Attribute Details

#attachments ⇒ Object

List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.



49
50
51
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 49

def attachments
  @attachments
end

#bcc ⇒ Object

List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.



37
38
39
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 37

def bcc
  @bcc
end

#body_part_content_types ⇒ Object

Returns the value of attribute body_part_content_types.



66
67
68
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 66

def body_part_content_types
  @body_part_content_types
end

#cc ⇒ Object

List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.



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

def cc
  @cc
end

#created_at ⇒ Object

When was the email received by MailSlurp



43
44
45
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 43

def created_at
  @created_at
end

#domain_id ⇒ Object

ID of the domain that received the email



25
26
27
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 25

def domain_id
  @domain_id
end

#favourite ⇒ Object

Returns the value of attribute favourite.



64
65
66
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 64

def favourite
  @favourite
end

#from ⇒ Object

Who the email was sent from. An email address - see fromName for the sender name.



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

def from
  @from
end

#id ⇒ Object

ID of the email entity



19
20
21
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 19

def id
  @id
end

#in_reply_to ⇒ Object

Parsed value of In-Reply-To header. A Message-ID in a thread.



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

def in_reply_to
  @in_reply_to
end

#inbox_id ⇒ Object

ID of the inbox that received the email



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

def inbox_id
  @inbox_id
end

#message_id ⇒ Object

RFC 5322 Message-ID header value without angle brackets.



55
56
57
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 55

def message_id
  @message_id
end

#plus_address ⇒ Object

Returns the value of attribute plus_address.



68
69
70
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 68

def plus_address
  @plus_address
end

#read ⇒ Object

Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.



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

def read
  @read
end

#recipients ⇒ Object

Returns the value of attribute recipients.



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

def recipients
  @recipients
end

#sender ⇒ Object

Returns the value of attribute sender.



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

def sender
  @sender
end

#subject ⇒ Object

The subject line of the email message as specified by SMTP subject header



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

def subject
  @subject
end

#thread_id ⇒ Object

MailSlurp thread ID for email chain that enables lookup for In-Reply-To and References fields.



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

def thread_id
  @thread_id
end

#to ⇒ Object

List of `To` recipient email addresses that the email was addressed to. See recipients object for names.



31
32
33
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 31

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 71

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



313
314
315
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 313

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 96

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 274

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



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

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 410

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 320

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


300
301
302
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 300

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



306
307
308
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 306

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 246

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

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

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



386
387
388
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 392

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



380
381
382
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 380

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



265
266
267
268
269
270
 
# File 'lib/mailslurp_client/models/email_preview.rb', line 265

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