class Mailgat::Email

Public Class Methods

new(email) click to toggle source

@param email [String] address

Calls superclass method
# File lib/mailgat/email.rb, line 5
def initialize(email)
  @email = email
  super()
end

Public Instance Methods

suggestion() click to toggle source

If invalid w/ suspected typo, returns suggestion

@see documentation.mailgun.com/api-email-validation.html#email-validation @return [String]

# File lib/mailgat/email.rb, line 23
def suggestion
  response = validate
  response.did_you_mean
end
valid?() click to toggle source

Determine whether or not the address appears valid

@see documentation.mailgun.com/api-email-validation.html#email-validation @return [Boolean]

# File lib/mailgat/email.rb, line 14
def valid?
  response = validate
  !!response.is_valid
end

Private Instance Methods

validate() click to toggle source
# File lib/mailgat/email.rb, line 30
def validate
  @validation ||= get("address/validate", {address: @email}, Mailgat.client_auth_header).body
end