Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
Gemfile
MIT-LICENSE
README.md
Rakefile
dynect_email.gemspec
shipit.rubygems.yml

README.md

DynectEmail

A Ruby library for interacting with DynECT Email Delivery API.

DynECT Email DynECT Email API

Installation

From Git

You can check out the latest source from git:

git clone git://github.com/Shopify/dynect_email.git

Usage Example

require 'rubygems'
require 'dynect_email'

# Set your API key
DynectEmail.api_key = "your-api-key"

# Add a sender to your account
DynectEmail.add_sender("myemail@example.com")

# Add a sub account with username, password, company, phone
response = DynectEmail.add_account("myemail@example.com", "secretpassword", "Shopify", "1231231231")

# response hash includes the api key for the account that was created
# Add a sender to the sub account
DynectEmail.add_sender("myemail@example.com", response['apikey'])

# Set headers
DynectEmail.set_headers({:xheader1 => "X-Sample1", :xheader2 => "X-Sample2"})

# Remove sender
DynectEmail.remove_sender("myemail@example.com")

# Remove account
DynectEmail.remove_account("myemail@example.com")

Check out the API docs for more information on what parameters are available.

Contributing

  1. Fork the official repository.
  2. Make your changes in a topic branch.
  3. Send a pull request.

Notes:

  • Contributions without tests won't be accepted.
  • Please don't update the Gem version.
Something went wrong with that request. Please try again.