This is a Ruby library for convenient access to ExpressPigeon API.
Add this line to your application's Gemfile:
gem 'expresspigeon-ruby'
And then execute:
$ bundle
Or install it yourself as:
$ gem install expresspigeon-ruby
Sending a transactional message is easy:
MESSAGES = ExpressPigeon::API.messages.auth_key 'XXX'
message_response = MESSAGES.send_message 115, # template ID
'[email protected]', # send to
'[email protected]', # reply to
"Jane Dow", # senders name
'Hi there!', # subject
# hash with custom content to merge
content: "hello, there!"
puts message_response
# need to wait before message information is written to DB
sleep 5
# get a report for a specific message
puts MESSAGES.report message_response.id MESSAGES = ExpressPigeon::API.messages.auth_key(ENV['AUTH_KEY'])
attachments = %W{attachments/attachment1.txt attachments/smile.pdf attachments/example.ics}
puts MESSAGES.send_message(
123, # template_id
'[email protected]', #to
'[email protected]', #reply_to
"Jane Doe", #from
"Want to get out for a dinner?", #subject
{first_name: 'John', main_course: 'stake'}, #merge_fields
false, #view_online
true, #click_tracking
true, #suppress_address
attachments #file paths to upload as attachments
)MESSAGES = ExpressPigeon::API.messages.auth_key(ENV['AUTH_KEY'])
attachments = %W{attachments/attachment1.txt attachments/calendar.ics}
puts MESSAGES.send_msg 123, '[email protected]', '[email protected]',
'Jane Doe', 'A simple test subject',
merge_fields: { first_name: "John" },
view_online: false,
click_tracking: true,
suppress_address: false,
attachments: attachments,
headers: { Xtest: "test" },
reply_name: "Jane S. Doe",
from_address: "[email protected]" The first five arguments are mandatory, while the rest are optional.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request