Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 994 Bytes

README.md

File metadata and controls

44 lines (29 loc) · 994 Bytes

mailgunner

A Ruby wrapper for the Mailgun API.

Installation

$ gem install mailgunner

Quick start

require 'mailgunner'

mailgun = Mailgunner::Client.new({
  domain: 'samples.mailgun.org',
  api_key: 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0',
  public_key: 'pubkey-9hddctfripa1jnhc3qf664cg6aeyb-e6'
})

response = mailgun.get_stats(limit: 5)

if response.ok?
  # do something with response.object
else
  # handle client/server error
end

Environment variables

Best practice for storing credentials for external services is to use environment variables, as described by 12factor.net/config.

Mailgunner::Client defaults to extracting the domain and api_key values it needs from the MAILGUN_API_KEY and MAILGUN_SMTP_LOGIN environment variables. These will exist if you are using Mailgun on Heroku, or you can set them manually.