Class: Mailgun::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/mailgun/address.rb

Overview

Mailgun::Address is a simple interface to the Email Validation API.

Instance Method Summary collapse

Constructor Details

#initializeAddress

Returns a new instance of Address.



7
8
9
# File 'lib/mailgun/address.rb', line 7

def initialize
  @client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v4')
end

Instance Method Details

#validate(address, mailbox_verification = false) ⇒ Object

Given an arbitrary address, validates it based on defined checks.

Parameters:

  • address (String)

    Email address to validate (max 512 chars.)



14
15
16
17
18
19
20
# File 'lib/mailgun/address.rb', line 14

def validate(address, mailbox_verification = false)
  params = {address:  address}
  params[:mailbox_verification] = true if mailbox_verification

  res = @client.get "address/validate", params
  return res.to_h!
end