Class: AsposeEmailCloud::MapiContactElectronicAddressDto

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

Overview

Refers to the group of properties that define the e-mail address or fax address for a contact.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address_type: nil, display_name: nil, email_address: nil, fax_number: nil, is_empty: nil, original_display_name: nil) ⇒ MapiContactElectronicAddressDto

Initializes the object

Parameters:

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

    Address type of an electronic address

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

    User-readable display name for the e-mail address

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

    E-mail address of the contact

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

    Telephone number of the mail user’s primary fax machine

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

    Shows if MapiContactElectronicAddress is empty

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

    SMTP e-mail address that corresponds to the e-mail address for the Contact object.



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

def initialize(
  address_type: nil,
  display_name: nil,
  email_address: nil,
  fax_number: nil,
  is_empty: nil,
  original_display_name: nil)
  self.address_type = address_type if address_type
  self.display_name = display_name if display_name
  self.email_address = email_address if email_address
  self.fax_number = fax_number if fax_number
  self.is_empty = is_empty if is_empty
  self.original_display_name = original_display_name if original_display_name
end

Instance Attribute Details

#address_type ⇒ String

Address type of an electronic address

Returns:

  • (String) 


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

def address_type
  @address_type
end

#display_name ⇒ String

User-readable display name for the e-mail address

Returns:

  • (String) 


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

def display_name
  @display_name
end

#email_address ⇒ String

E-mail address of the contact

Returns:

  • (String) 


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

def email_address
  @email_address
end

#fax_number ⇒ String

Telephone number of the mail user’s primary fax machine

Returns:

  • (String) 


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

def fax_number
  @fax_number
end

#is_empty ⇒ BOOLEAN

Shows if MapiContactElectronicAddress is empty

Returns:

  • (BOOLEAN) 


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

def is_empty
  @is_empty
end

#original_display_name ⇒ String

SMTP e-mail address that corresponds to the e-mail address for the Contact object.

Returns:

  • (String) 


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

def original_display_name
  @original_display_name
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/mapi_contact_electronic_address_dto.rb', line 50

def self.attribute_map
  {
    :'address_type' => :'addressType',
    :'display_name' => :'displayName',
    :'email_address' => :'emailAddress',
    :'fax_number' => :'faxNumber',
    :'is_empty' => :'isEmpty',
    :'original_display_name' => :'originalDisplayName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'address_type' => :'String',
    :'display_name' => :'String',
    :'email_address' => :'String',
    :'fax_number' => :'String',
    :'is_empty' => :'BOOLEAN',
    :'original_display_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 115

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_type == o.address_type &&
      display_name == o.display_name &&
      email_address == o.email_address &&
      fax_number == o.fax_number &&
      is_empty == o.is_empty &&
      original_display_name == o.original_display_name
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



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

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 234

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 141

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


128
129
130
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 134

def hash
  [address_type, display_name, email_address, fax_number, is_empty, original_display_name].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
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 97

def list_invalid_properties
  invalid_properties = Array.new
  if @is_empty.nil?
    invalid_properties.push('invalid value for "is_empty", is_empty 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



214
215
216
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 214

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



220
221
222
223
224
225
226
227
228
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 220

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



208
209
210
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 208

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



108
109
110
111
 
# File 'lib/aspose-email-cloud/models/mapi_contact_electronic_address_dto.rb', line 108

def valid?
  return false if @is_empty.nil?
  true
end