Skip to content
This repository has been archived by the owner on Apr 27, 2021. It is now read-only.

Shopify/dynect_email

Repository files navigation

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("[email protected]")

# Add a sub account with username, password, company, phone
response = DynectEmail.add_account("[email protected]", "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("[email protected]", response['apikey'])

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

# Remove sender
DynectEmail.remove_sender("[email protected]")

# Remove account
DynectEmail.remove_account("[email protected]")

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.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages