Class: CloudmersiveValidateApiClient::FullEmailValidationResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb

Overview

Full email addresss validation result

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FullEmailValidationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 77

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?(:'ValidAddress')
    self.valid_address = attributes[:'ValidAddress']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#domain ⇒ Object

Domain name of the email address



37
38
39
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 37

def domain
  @domain
end

#is_catchall_domain ⇒ Object

True if the domain is a catch-all domain name, false otherwise. Catch-all domain names, while rare, always accept inbound email to ensure they do not lose any potentially useful emails. Catch-all domain names can occassionally be configured to first accept and store all inbound email, but then later send a bounce email back to the sender after a delayed period of time.



34
35
36
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 34

def is_catchall_domain
  @is_catchall_domain
end

#is_disposable ⇒ Object

True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there.



43
44
45
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 43

def is_disposable
  @is_disposable
end

#is_free_email_provider ⇒ Object

True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise.



40
41
42
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 40

def is_free_email_provider
  @is_free_email_provider
end

#mail_server_used_for_validation ⇒ Object

Email server connected to for verification



22
23
24
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 22

def mail_server_used_for_validation
  @mail_server_used_for_validation
end

#valid_address ⇒ Object

True if the email address is valid overall, false otherwise



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 19

def valid_address
  @valid_address
end

#valid_domain ⇒ Object

True if the domain name of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one.



28
29
30
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 28

def valid_domain
  @valid_domain
end

#valid_smtp ⇒ Object

True if the email address was verified by the remote server, false otherwise. This is one component of ValidAddress, but not the only one.



31
32
33
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 31

def valid_smtp
  @valid_smtp
end

#valid_syntax ⇒ Object

True if the syntax of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one.



25
26
27
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 25

def valid_syntax
  @valid_syntax
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 46

def self.attribute_map
  {
    :'valid_address' => :'ValidAddress',
    :'mail_server_used_for_validation' => :'MailServerUsedForValidation',
    :'valid_syntax' => :'Valid_Syntax',
    :'valid_domain' => :'Valid_Domain',
    :'valid_smtp' => :'Valid_SMTP',
    :'is_catchall_domain' => :'IsCatchallDomain',
    :'domain' => :'Domain',
    :'is_free_email_provider' => :'IsFreeEmailProvider',
    :'is_disposable' => :'IsDisposable'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 61

def self.swagger_types
  {
    :'valid_address' => :'BOOLEAN',
    :'mail_server_used_for_validation' => :'String',
    :'valid_syntax' => :'BOOLEAN',
    :'valid_domain' => :'BOOLEAN',
    :'valid_smtp' => :'BOOLEAN',
    :'is_catchall_domain' => :'BOOLEAN',
    :'domain' => :'String',
    :'is_free_email_provider' => :'BOOLEAN',
    :'is_disposable' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      valid_address == o.valid_address &&
      mail_server_used_for_validation == o.mail_server_used_for_validation &&
      valid_syntax == o.valid_syntax &&
      valid_domain == o.valid_domain &&
      valid_smtp == o.valid_smtp &&
      is_catchall_domain == o.is_catchall_domain &&
      domain == o.domain &&
      is_free_email_provider == o.is_free_email_provider &&
      is_disposable == o.is_disposable
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



185
186
187
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
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 185

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
    temp_model = CloudmersiveValidateApiClient.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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 251

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 164

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


151
152
153
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 157

def hash
  [valid_address, mail_server_used_for_validation, valid_syntax, valid_domain, valid_smtp, is_catchall_domain, domain, is_free_email_provider, is_disposable].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



122
123
124
125
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  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



231
232
233
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 231

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



237
238
239
240
241
242
243
244
245
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 237

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



225
226
227
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 225

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



129
130
131
 
# File 'lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb', line 129

def valid?
  true
end