Class: AsposeEmailCloud::SetMessageReadFlagAccountBaseRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb

Overview

Set message is read request

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(first_account = nil, second_account = nil, storage_folder = nil, message_id = nil, is_read = nil) ⇒ SetMessageReadFlagAccountBaseRequest

Initializes the object

Parameters:

  • first_account (String) (defaults to: nil) —

    First account storage file name for receiving emails (or universal one)

  • second_account (String) (defaults to: nil) —

    Second account storage file name for sending emails (ignored if first is universal)

  • storage_folder (StorageFolderLocation) (defaults to: nil) —

    Storage folder location of account files

  • message_id (String) (defaults to: nil) —

    Message identifier

  • is_read (BOOLEAN) (defaults to: nil) —

    Specifies that message should be marked read or unread



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'firstAccount')
    self. = attributes[:'firstAccount']
  end

  if attributes.has_key?(:'secondAccount')
    self. = attributes[:'secondAccount']
  end

  if attributes.has_key?(:'storageFolder')
    self.storage_folder = attributes[:'storageFolder']
  end

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

  if attributes.has_key?(:'isRead')
    self.is_read = attributes[:'isRead']
  end
end

Instance Attribute Details

#first_account ⇒ String

First account storage file name for receiving emails (or universal one)

Returns:

  • (String) 


34
35
36
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 34

def 
  
end

#is_read ⇒ BOOLEAN

Specifies that message should be marked read or unread

Returns:

  • (BOOLEAN) 


50
51
52
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 50

def is_read
  @is_read
end

#message_id ⇒ String

Message identifier

Returns:

  • (String) 


46
47
48
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 46

def message_id
  @message_id
end

#second_account ⇒ String

Second account storage file name for sending emails (ignored if first is universal)

Returns:

  • (String) 


38
39
40
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 38

def 
  
end

#storage_folder ⇒ StorageFolderLocation

Storage folder location of account files

Returns:



42
43
44
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 42

def storage_folder
  @storage_folder
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 53

def self.attribute_map
  {
    :'first_account' => :'firstAccount',
    :'second_account' => :'secondAccount',
    :'storage_folder' => :'storageFolder',
    :'message_id' => :'messageId',
    :'is_read' => :'isRead'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 64

def self.swagger_types
  {
    :'first_account' => :'String',
    :'second_account' => :'String',
    :'storage_folder' => :'StorageFolderLocation',
    :'message_id' => :'String',
    :'is_read' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      storage_folder == o.storage_folder &&
      message_id == o.message_id &&
      is_read == o.is_read
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



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
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 233

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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 303

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 210

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_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


197
198
199
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



203
204
205
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 203

def hash
  [, , storage_folder, message_id, is_read].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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 119

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

  if .to_s.length < 1
    invalid_properties.push('invalid value for "first_account", the character length must be great than or equal to 1.')
  end

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

  if @message_id.to_s.length < 1
    invalid_properties.push('invalid value for "message_id", the character length must be great than or equal to 1.')
  end

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



283
284
285
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 283

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



289
290
291
292
293
294
295
296
297
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 289

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



277
278
279
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 277

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



146
147
148
149
150
151
152
153
 
# File 'lib/aspose-email-cloud/models/set_message_read_flag_account_base_request.rb', line 146

def valid?
  return false if .nil?
  return false if .to_s.length < 1
  return false if @message_id.nil?
  return false if @message_id.to_s.length < 1
  return false if @is_read.nil?
  true
end