An API client for the EmailOctopus email marketing service, allowing you to create/view/update/destroy campaigns, lists, and contacts.
For more information on how to set up your account, read the API docs.
NOTE: This project is alpha software, tests are still being written but most of the logic is there.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install email_octopus
First, configure the
EmailOctopus library so it can be used with your
account. After obtaining your API key, add the following before your
application is initialized. For Rails apps, this might be
EmailOctopus.configure do |config| config.api_key = 'your-email-octopus-api-key' end
You can now perform CRUD actions on the various resources that the API provides.
Below is a short summary of what you can do with the library. For more information, read the RDoc documentation.
Creating a new list
list = EmailOctopus::List.create name: 'Newsletter'
Adding a contact to that list
list = EmailOctopus::List.find 'previous-list-id' contact = EmailOctopus::Contact.create( first_name: 'Lester', last_name: 'Tester', email_address: 'firstname.lastname@example.org', subscribed: true, list_id: list.id )
Creating a new campaign for that list
list = EmailOctopus::List.find 'previous-list-id' campaign = EmailOctopus::Campaign.new( list_id: list.id, name: 'hello world', content: 'test' )
Removing a user from the contact list
contact = EmailOctopus::Contact.find 'previous-contact-id' contact.destroy
After checking out the repo, run
bin/setup to install dependencies.
rake test to run the tests. You can also run
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install.
To release a new version, update the version number in
version.rb, and then
bundle exec rake release, which will create a git tag for the version,
push git commits and tags, and push the
.gem file to
Bug reports and pull requests are welcome on GitHub at https://github.com/tubbo/email_octopus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.