Skip to content

BiggerPockets/iterable_rails

Repository files navigation

IterableRails

Installation

Add this line to your application's Gemfile:

gem 'iterable_rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install iterable_rails

Usage

You'll need to set up a transactional email campaign and template within Iterable. Note your campaign ID.

Within your Rails application or environment config add these lines:

config.action_mailer.delivery_method = :iterable
config.action_mailer.iterable_settings = {
    api_key: ENV["ITERABLE_API_KEY"],
    campaign_id: 12345678
}

Within Iterable you'll need to configure your template to use the following handlebars data:

  • {{ cc_address }}
  • {{ bcc_address }}
  • {{ from_email }}
  • {{ from_name }}
  • {{ html }}
  • {{ subject }}
  • {{ text }}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console 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 run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/biggerpockets/iterable_rails. 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.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the IterableRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Ruby gem for using Iterable email provider with Rails

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •