Class: MailSafePro::EmailValidationRequest

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

Overview

Request model for single email validation

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 = {}) ⇒ EmailValidationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSafePro::EmailValidationRequest` 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::EmailValidationRequest`. 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?(:'check_smtp')
    self.check_smtp = attributes[:'check_smtp']
  else
    self.check_smtp = false
  end

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

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

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

Instance Attribute Details

#check_smtp ⇒ Object

Enable SMTP mailbox verification



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

def check_smtp
  @check_smtp
end

#email ⇒ Object

Email address to validate (RFC 5321 compliant)



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

def email
  @email
end

#include_raw_dns ⇒ Object

Include raw DNS records



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

def include_raw_dns
  @include_raw_dns
end

#priority ⇒ Object

Validation priority level



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

def priority
  @priority
end

#testing_mode ⇒ Object

Enable testing mode (allows special TLDs like .test, .example, etc.)



29
30
31
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 29

def testing_mode
  @testing_mode
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 57

def self.attribute_map
  {
    :'email' => :'email',
    :'check_smtp' => :'check_smtp',
    :'include_raw_dns' => :'include_raw_dns',
    :'testing_mode' => :'testing_mode',
    :'priority' => :'priority'
  }
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 214

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



89
90
91
92
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 78

def self.openapi_types
  {
    :'email' => :'String',
    :'check_smtp' => :'Boolean',
    :'include_raw_dns' => :'Boolean',
    :'testing_mode' => :'Boolean',
    :'priority' => :'PriorityEnum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      check_smtp == o.check_smtp &&
      include_raw_dns == o.include_raw_dns &&
      testing_mode == o.testing_mode &&
      priority == o.priority
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


201
202
203
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 207

def hash
  [email, check_smtp, include_raw_dns, testing_mode, priority].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 141

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 > 320
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 320.')
  end

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 236

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



161
162
163
164
165
166
167
 
# File 'lib/mailsafepro/models/email_validation_request.rb', line 161

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @email.nil?
  return false if @email.to_s.length > 320
  return false if @email.to_s.length < 3
  true
end