Class: AsposeEmailCloud::EmailAddress

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

Overview

Email address.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category: nil, display_name: nil, preferred: nil, routing_type: nil, address: nil, original_address_string: nil) ⇒ EmailAddress

Initializes the object

Parameters:

  • category (EnumWithCustomOfEmailAddressCategory) (defaults to: nil) —

    Address category.

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

    Display name.

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

    Defines whether email address is preferred.

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

    A routing type for an email.

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

    Email address.

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

    The original e-mail address string



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 80

def initialize(
  category: nil,
  display_name: nil,
  preferred: nil,
  routing_type: nil,
  address: nil,
  original_address_string: nil)
  self.category = category if category
  self.display_name = display_name if display_name
  self.preferred = preferred if preferred
  self.routing_type = routing_type if routing_type
  self.address = address if address
  self.original_address_string = original_address_string if original_address_string
end

Instance Attribute Details

#address ⇒ String

Email address.

Returns:

  • (String) 


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

def address
  @address
end

#category ⇒ EnumWithCustomOfEmailAddressCategory

Address category.

Returns:



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

def category
  @category
end

#display_name ⇒ String

Display name.

Returns:

  • (String) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 36

def display_name
  @display_name
end

#original_address_string ⇒ String

The original e-mail address string

Returns:

  • (String) 


48
49
50
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 48

def original_address_string
  @original_address_string
end

#preferred ⇒ BOOLEAN

Defines whether email address is preferred.

Returns:

  • (BOOLEAN) 


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

def preferred
  @preferred
end

#routing_type ⇒ String

A routing type for an email.

Returns:

  • (String) 


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

def routing_type
  @routing_type
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 50

def self.attribute_map
  {
    :'category' => :'category',
    :'display_name' => :'displayName',
    :'preferred' => :'preferred',
    :'routing_type' => :'routingType',
    :'address' => :'address',
    :'original_address_string' => :'originalAddressString'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'category' => :'EnumWithCustomOfEmailAddressCategory',
    :'display_name' => :'String',
    :'preferred' => :'BOOLEAN',
    :'routing_type' => :'String',
    :'address' => :'String',
    :'original_address_string' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category == o.category &&
      display_name == o.display_name &&
      preferred == o.preferred &&
      routing_type == o.routing_type &&
      address == o.address &&
      original_address_string == o.original_address_string
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



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
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 188

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 258

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 165

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


152
153
154
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 158

def hash
  [category, display_name, preferred, routing_type, address, original_address_string].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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 97

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

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

  if @address.to_s.length < 1
    invalid_properties.push('invalid value for "address", the character length must be great than or equal to 1.')
  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



238
239
240
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 238

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 244

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



232
233
234
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 232

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



116
117
118
119
120
121
 
# File 'lib/aspose-email-cloud/models/email_address.rb', line 116

def valid?
  return false if @preferred.nil?
  return false if @address.nil?
  return false if @address.to_s.length < 1
  true
end