A Ruby wrapper for the Quickmail API.

Add module to your Gemfile:

gem 'quickmail'

Then run bundle to install the Gem:

bundle install

Set up an initializer file with your Quickmail access token and settings:

Quickmail.access_token  = 'quickmail_access_token'
Quickmail.api_version = 'v1'
Quickmail.test_mode  = "true or false"

e.g. config/initializers/quickmail.rb

You can either set the access token at the project level via an initializer file or at the request level as a parameter.

This gem provides a collection of operations for use within the Quickmail API.

Use OAuth to generate new API access for an account

Quickmail::Authentication.oauth(auth_params, access_token)

Create all available SKUs in Inventory

Quickmail::Inventory.list(access_token)

Create a single order

Quickmail::Order.create(order_params, access_token)

Poll the tracking endpoint to get the latest order delivery updates

Quickmail::Tracking.poll(tracking_params, access_token)

• Fork the project
• Create your feature or bug fix
• Add the required tests for it.
• Commit (do not change version or history)
• Send a pull request against the development branch

Copyright (c) 2024 Douglas Lim (@hellodouglim)
Licenced under the MIT licence.