Class: MailSlurpClient::InboxDto

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

Overview

Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. `SMTP` inboxes use a custom mail server at `mx.mailslurp.com` and support SMTP login, IMAP and POP3. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InboxDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 138

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.



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

def created_at
  @created_at
end

#description ⇒ Object

Description of an inbox for labelling and searching purposes



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

def description
  @description
end

#domain_id ⇒ Object

ID of custom domain used by the inbox if any



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

def domain_id
  @domain_id
end

#email_address ⇒ Object

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.



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

def email_address
  @email_address
end

#expires_at ⇒ Object

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.



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

def expires_at
  @expires_at
end

#favourite ⇒ Object

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering



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

def favourite
  @favourite
end

#functions_as ⇒ Object

Inbox function if used as a primitive for another system.



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

def functions_as
  @functions_as
end

#id ⇒ Object

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.



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

def id
  @id
end

#inbox_type ⇒ Object

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).



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

def inbox_type
  @inbox_type
end

#name ⇒ Object

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search



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

def name
  @name
end

#read_only ⇒ Object

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.



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

def read_only
  @read_only
end

#tags ⇒ Object

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.



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

def tags
  @tags
end

#user_id ⇒ Object

ID of user that inbox belongs to



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

def user_id
  @user_id
end

#virtual_inbox ⇒ Object

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.



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

def virtual_inbox
  @virtual_inbox
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 83

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userId',
    :'created_at' => :'createdAt',
    :'name' => :'name',
    :'domain_id' => :'domainId',
    :'description' => :'description',
    :'email_address' => :'emailAddress',
    :'expires_at' => :'expiresAt',
    :'favourite' => :'favourite',
    :'tags' => :'tags',
    :'inbox_type' => :'inboxType',
    :'read_only' => :'readOnly',
    :'virtual_inbox' => :'virtualInbox',
    :'functions_as' => :'functionsAs'
  }
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/inbox_dto.rb', line 313

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 123

def self.openapi_nullable
  Set.new([
    :'user_id',
    :'name',
    :'domain_id',
    :'description',
    :'expires_at',
    :'tags',
    :'inbox_type',
    :'functions_as'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 103

def self.openapi_types
  {
    :'id' => :'String',
    :'user_id' => :'String',
    :'created_at' => :'DateTime',
    :'name' => :'String',
    :'domain_id' => :'String',
    :'description' => :'String',
    :'email_address' => :'String',
    :'expires_at' => :'String',
    :'favourite' => :'Boolean',
    :'tags' => :'Array<String>',
    :'inbox_type' => :'String',
    :'read_only' => :'Boolean',
    :'virtual_inbox' => :'Boolean',
    :'functions_as' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      created_at == o.created_at &&
      name == o.name &&
      domain_id == o.domain_id &&
      description == o.description &&
      email_address == o.email_address &&
      expires_at == o.expires_at &&
      favourite == o.favourite &&
      tags == o.tags &&
      inbox_type == o.inbox_type &&
      read_only == o.read_only &&
      virtual_inbox == o.virtual_inbox &&
      functions_as == o.functions_as
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/inbox_dto.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/inbox_dto.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/inbox_dto.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/inbox_dto.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/inbox_dto.rb', line 306

def hash
  [id, user_id, created_at, name, domain_id, description, email_address, expires_at, favourite, tags, inbox_type, read_only, virtual_inbox, functions_as].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



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

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 @email_address.nil?
    invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
  end

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

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

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 243

def valid?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @email_address.nil?
  return false if @favourite.nil?
  inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
  return false unless inbox_type_validator.valid?(@inbox_type)
  return false if @read_only.nil?
  return false if @virtual_inbox.nil?
  functions_as_validator = EnumAttributeValidator.new('String', ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"])
  return false unless functions_as_validator.valid?(@functions_as)
  true
end