Class: MailSafePro::EmailResponse

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/email_response.rb

Overview

Comprehensive email validation response

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ EmailResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/mailsafepro/models/email_response.rb', line 146

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSafePro::EmailResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSafePro::EmailResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  else
    self.email = nil
  end

  if attributes.key?(:'valid')
    self.valid = attributes[:'valid']
  else
    self.valid = nil
  end

  if attributes.key?(:'detail')
    self.detail = attributes[:'detail']
  else
    self.detail = ''
  end

  if attributes.key?(:'processing_time')
    self.processing_time = attributes[:'processing_time']
  end

  if attributes.key?(:'provider')
    self.provider = attributes[:'provider']
  end

  if attributes.key?(:'reputation')
    self.reputation = attributes[:'reputation']
  end

  if attributes.key?(:'fingerprint')
    self.fingerprint = attributes[:'fingerprint']
  end

  if attributes.key?(:'quality_score')
    self.quality_score = attributes[:'quality_score']
  end

  if attributes.key?(:'risk_level')
    self.risk_level = attributes[:'risk_level']
  end

  if attributes.key?(:'suggestions')
    if (value = attributes[:'suggestions']).is_a?(Array)
      self.suggestions = value
    end
  end

  if attributes.key?(:'smtp')
    self.smtp = attributes[:'smtp']
  end

  if attributes.key?(:'dns')
    self.dns = attributes[:'dns']
  end

  if attributes.key?(:'risk_score')
    self.risk_score = attributes[:'risk_score']
  end

  if attributes.key?(:'validation_tier')
    self.validation_tier = attributes[:'validation_tier']
  end

  if attributes.key?(:'suggested_action')
    self.suggested_action = attributes[:'suggested_action']
  end
end

Instance Attribute Details

#detail ⇒ Object

Validation details summary



26
27
28
 
# File 'lib/mailsafepro/models/email_response.rb', line 26

def detail
  @detail
end

#dns ⇒ Object

Returns the value of attribute dns.



45
46
47
 
# File 'lib/mailsafepro/models/email_response.rb', line 45

def dns
  @dns
end

#email ⇒ Object

Validated email address



20
21
22
 
# File 'lib/mailsafepro/models/email_response.rb', line 20

def email
  @email
end

#fingerprint ⇒ Object

Returns the value of attribute fingerprint.



34
35
36
 
# File 'lib/mailsafepro/models/email_response.rb', line 34

def fingerprint
  @fingerprint
end

#processing_time ⇒ Object

Returns the value of attribute processing_time.



28
29
30
 
# File 'lib/mailsafepro/models/email_response.rb', line 28

def processing_time
  @processing_time
end

#provider ⇒ Object

Returns the value of attribute provider.



30
31
32
 
# File 'lib/mailsafepro/models/email_response.rb', line 30

def provider
  @provider
end

#quality_score ⇒ Object

Returns the value of attribute quality_score.



36
37
38
 
# File 'lib/mailsafepro/models/email_response.rb', line 36

def quality_score
  @quality_score
end

#reputation ⇒ Object

Returns the value of attribute reputation.



32
33
34
 
# File 'lib/mailsafepro/models/email_response.rb', line 32

def reputation
  @reputation
end

#risk_level ⇒ Object

Returns the value of attribute risk_level.



38
39
40
 
# File 'lib/mailsafepro/models/email_response.rb', line 38

def risk_level
  @risk_level
end

#risk_score ⇒ Object

Returns the value of attribute risk_score.



47
48
49
 
# File 'lib/mailsafepro/models/email_response.rb', line 47

def risk_score
  @risk_score
end

#smtp ⇒ Object

Returns the value of attribute smtp.



43
44
45
 
# File 'lib/mailsafepro/models/email_response.rb', line 43

def smtp
  @smtp
end

#suggested_action ⇒ Object

Returns the value of attribute suggested_action.



51
52
53
 
# File 'lib/mailsafepro/models/email_response.rb', line 51

def suggested_action
  @suggested_action
end

#suggestions ⇒ Object

Improvement suggestions



41
42
43
 
# File 'lib/mailsafepro/models/email_response.rb', line 41

def suggestions
  @suggestions
end

#valid ⇒ Object

Overall validation result



23
24
25
 
# File 'lib/mailsafepro/models/email_response.rb', line 23

def valid
  @valid
end

#validation_tier ⇒ Object

Returns the value of attribute validation_tier.



49
50
51
 
# File 'lib/mailsafepro/models/email_response.rb', line 49

def validation_tier
  @validation_tier
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



97
98
99
 
# File 'lib/mailsafepro/models/email_response.rb', line 97

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



102
103
104
 
# File 'lib/mailsafepro/models/email_response.rb', line 102

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/mailsafepro/models/email_response.rb', line 76

def self.attribute_map
  {
    :'email' => :'email',
    :'valid' => :'valid',
    :'detail' => :'detail',
    :'processing_time' => :'processing_time',
    :'provider' => :'provider',
    :'reputation' => :'reputation',
    :'fingerprint' => :'fingerprint',
    :'quality_score' => :'quality_score',
    :'risk_level' => :'risk_level',
    :'suggestions' => :'suggestions',
    :'smtp' => :'smtp',
    :'dns' => :'dns',
    :'risk_score' => :'risk_score',
    :'validation_tier' => :'validation_tier',
    :'suggested_action' => :'suggested_action'
  }
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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/mailsafepro/models/email_response.rb', line 416

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/mailsafepro/models/email_response.rb', line 128

def self.openapi_nullable
  Set.new([
    :'processing_time',
    :'provider',
    :'reputation',
    :'fingerprint',
    :'quality_score',
    :'risk_level',
    :'smtp',
    :'dns',
    :'risk_score',
    :'validation_tier',
    :'suggested_action'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/mailsafepro/models/email_response.rb', line 107

def self.openapi_types
  {
    :'email' => :'String',
    :'valid' => :'Boolean',
    :'detail' => :'String',
    :'processing_time' => :'Float',
    :'provider' => :'String',
    :'reputation' => :'Float',
    :'fingerprint' => :'String',
    :'quality_score' => :'Float',
    :'risk_level' => :'RiskLevelEnum',
    :'suggestions' => :'Array<String>',
    :'smtp' => :'SMTPInfo',
    :'dns' => :'DNSInfo',
    :'risk_score' => :'Float',
    :'validation_tier' => :'String',
    :'suggested_action' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/mailsafepro/models/email_response.rb', line 381

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      valid == o.valid &&
      detail == o.detail &&
      processing_time == o.processing_time &&
      provider == o.provider &&
      reputation == o.reputation &&
      fingerprint == o.fingerprint &&
      quality_score == o.quality_score &&
      risk_level == o.risk_level &&
      suggestions == o.suggestions &&
      smtp == o.smtp &&
      dns == o.dns &&
      risk_score == o.risk_score &&
      validation_tier == o.validation_tier &&
      suggested_action == o.suggested_action
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


403
404
405
 
# File 'lib/mailsafepro/models/email_response.rb', line 403

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



409
410
411
 
# File 'lib/mailsafepro/models/email_response.rb', line 409

def hash
  [email, valid, detail, processing_time, provider, reputation, fingerprint, quality_score, risk_level, suggestions, smtp, dns, risk_score, validation_tier, suggested_action].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



231
232
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
274
275
276
277
278
279
 
# File 'lib/mailsafepro/models/email_response.rb', line 231

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @email.to_s.length > 254
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 254.')
  end

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

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

  if !@processing_time.nil? && @processing_time < 0.0
    invalid_properties.push('invalid value for "processing_time", must be greater than or equal to 0.0.')
  end

  if !@reputation.nil? && @reputation > 1.0
    invalid_properties.push('invalid value for "reputation", must be smaller than or equal to 1.0.')
  end

  if !@reputation.nil? && @reputation < 0.0
    invalid_properties.push('invalid value for "reputation", must be greater than or equal to 0.0.')
  end

  if !@quality_score.nil? && @quality_score > 1.0
    invalid_properties.push('invalid value for "quality_score", must be smaller than or equal to 1.0.')
  end

  if !@quality_score.nil? && @quality_score < 0.0
    invalid_properties.push('invalid value for "quality_score", must be greater than or equal to 0.0.')
  end

  if !@risk_score.nil? && @risk_score > 1.0
    invalid_properties.push('invalid value for "risk_score", must be smaller than or equal to 1.0.')
  end

  if !@risk_score.nil? && @risk_score < 0.0
    invalid_properties.push('invalid value for "risk_score", must be greater than or equal to 0.0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/mailsafepro/models/email_response.rb', line 438

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/mailsafepro/models/email_response.rb', line 283

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @email.nil?
  return false if @email.to_s.length > 254
  return false if @email.to_s.length < 5
  return false if @valid.nil?
  return false if !@processing_time.nil? && @processing_time < 0.0
  return false if !@reputation.nil? && @reputation > 1.0
  return false if !@reputation.nil? && @reputation < 0.0
  return false if !@quality_score.nil? && @quality_score > 1.0
  return false if !@quality_score.nil? && @quality_score < 0.0
  return false if !@risk_score.nil? && @risk_score > 1.0
  return false if !@risk_score.nil? && @risk_score < 0.0
  true
end