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

#initialize(api_key = Mailgun.api_key, api_host = Mailgun.api_host) ⇒ Address

Returns a new instance of Address.



5
6
7
 
# File 'lib/mailgun/address.rb', line 5

def initialize(api_key = Mailgun.api_key, api_host = Mailgun.api_host)
  @client = Mailgun::Client.new(api_key, 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.)



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

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