Class: MailSlurpClient::ImapMailboxStatus

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImapMailboxStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
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
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 101

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#append_limit ⇒ Object

Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension



51
52
53
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 51

def append_limit
  @append_limit
end

#flags ⇒ Object

The mailbox flags.



27
28
29
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 27

def flags
  @flags
end

#items ⇒ Object

Results map



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

def items
  @items
end

#messages ⇒ Object

The number of messages in this mailbox.



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

def messages
  @messages
end

#name ⇒ Object

The mailbox name.



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

def name
  @name
end

#permanent_flags ⇒ Object

The mailbox permanent flags.



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

def permanent_flags
  @permanent_flags
end

#read_only ⇒ Object

True if the mailbox is open in read-only mode.



21
22
23
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 21

def read_only
  @read_only
end

#recent ⇒ Object

The number of messages not seen since the last time the mailbox was opened.



39
40
41
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 39

def recent
  @recent
end

#uid_next ⇒ Object

The next UID.



45
46
47
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 45

def uid_next
  @uid_next
end

#uid_validity ⇒ Object

Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1.



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

def uid_validity
  @uid_validity
end

#unseen ⇒ Object

The number of unread messages.



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

def unseen
  @unseen
end

#unseen_seq_num ⇒ Object

The sequence number of the first unseen message in the mailbox.



33
34
35
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 33

def unseen_seq_num
  @unseen_seq_num
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 54

def self.attribute_map
  {
    :'name' => :'name',
    :'read_only' => :'readOnly',
    :'items' => :'items',
    :'flags' => :'flags',
    :'permanent_flags' => :'permanentFlags',
    :'unseen_seq_num' => :'unseenSeqNum',
    :'messages' => :'messages',
    :'recent' => :'recent',
    :'unseen' => :'unseen',
    :'uid_next' => :'uidNext',
    :'uid_validity' => :'uidValidity',
    :'append_limit' => :'appendLimit'
  }
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



254
255
256
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
94
95
96
97
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 90

def self.openapi_nullable
  Set.new([
    :'items',
    :'flags',
    :'permanent_flags',
    :'append_limit'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'read_only' => :'Boolean',
    :'items' => :'Object',
    :'flags' => :'Array<String>',
    :'permanent_flags' => :'Array<String>',
    :'unseen_seq_num' => :'Integer',
    :'messages' => :'Integer',
    :'recent' => :'Integer',
    :'unseen' => :'Integer',
    :'uid_next' => :'Integer',
    :'uid_validity' => :'Integer',
    :'append_limit' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      read_only == o.read_only &&
      items == o.items &&
      flags == o.flags &&
      permanent_flags == o.permanent_flags &&
      unseen_seq_num == o.unseen_seq_num &&
      messages == o.messages &&
      recent == o.recent &&
      unseen == o.unseen &&
      uid_next == o.uid_next &&
      uid_validity == o.uid_validity &&
      append_limit == o.append_limit
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



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
315
316
317
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 282

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 351

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 261

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


241
242
243
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 247

def hash
  [name, read_only, items, flags, permanent_flags, unseen_seq_num, messages, recent, unseen, uid_next, uid_validity, append_limit].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



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

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

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

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

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

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

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

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

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



327
328
329
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 333

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



321
322
323
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 321

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



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/mailslurp_client/models/imap_mailbox_status.rb', line 208

def valid?
  return false if @name.nil?
  return false if @read_only.nil?
  return false if @unseen_seq_num.nil?
  return false if @messages.nil?
  return false if @recent.nil?
  return false if @unseen.nil?
  return false if @uid_next.nil?
  return false if @uid_validity.nil?
  true
end