class AsposeEmailCloud::EmailAddress
Email address.
Attributes
Email address.
@return [String]
Address category.
@return [EnumWithCustomOfEmailAddressCategory]
Display name.
@return [String]
The original e-mail address string
@return [String]
Defines whether email address is preferred.
@return [BOOLEAN]
A routing type for an email.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [EnumWithCustomOfEmailAddressCategory] category Address category.
@param [String] display_name
Display name.
@param [BOOLEAN] preferred Defines whether email address is preferred.
@param [String] routing_type
A routing type for an email.
@param [String] address Email address.
@param [String] original_address_string
The original e-mail address string
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Custom attribute writer method with validation @param [Object] address Value to be assigned
# File lib/aspose-email-cloud/models/email_address.rb, line 125 def address=(address) if address.nil? fail ArgumentError, 'address cannot be nil' end if address.to_s.length < 1 fail ArgumentError, 'invalid value for "address", the character length must be great than or equal to 1.' end @address = address end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/aspose-email-cloud/models/email_address.rb, line 152 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose-email-cloud/models/email_address.rb, line 232 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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