Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Spree Mailing List
JavaScript Ruby
branch: master

README.md

Spree Mail

Spree Mail is a complete email marketing extension for Spree. Visitors can sign up for the mailing list by visiting the new subscriber page and admins can create and send emails to selected subscribers. Subscribers can view emails online and unsubscribe if they wish.

To customize Spree Mail's html template, copy email.html.erb to your local layouts folder.

Convert all of your site's current users into subscribers by running rake spree_mail:subscribe_users from your project's root. Be nice and don't spam your customers :)

Demo

To create a spree mail demo app, run the following:

rails new spree_mail_example 
cd spree_mail_example 
echo "gem 'spree', '0.40.2'" >> Gemfile 
echo "gem 'spree_mail', '0.40.0.4'" >> Gemfile 
rm public/index.html 
bundle install 
rake spree:install spree_mail:install db:migrate db:seed

Or all at once:

rails new spree_mail_example; cd spree_mail_example; echo "gem 'spree', '0.40.2'" >> Gemfile; echo "gem 'spree_mail', '0.40.0.4'" >> Gemfile; rm public/index.html; bundle install; rake spree:install spree_mail:install db:migrate db:seed

rake spree_sample:install db:sample if you want to...

Then start the server with rails s

Before sending, you may need to create an action_mailer initializer.

# config/initializers/action_mailer.rb

ActionMailer::Base.delivery_method = :sendmail
ActionMailer::Base.sendmail_settings = {
  :arguments => '-r no-reply@spree-mail-example.com'
}

Testing

Shoulda and Capybara/Selenium tests can be run by cloning the repo and running rake:

git clone git://github.com/citrus/spree_mail.git
cd spree_mail
bundle install
rake

To Do

  • Write admin tests
  • Add checkbox on user signup: 'sign up for our mailing list'
  • Add user help to admin email form
  • Add email tracking functionality
  • Add a selection of products to emails
  • Add an 'assets' upload admin and an easy way to link images or files to an email
  • Maybe add a wysiwyg editor for email composition

Contributors

  • Spencer Steffen - github.com/citrus
  • Alberto Vena - github.com/kennyadsl
  • Thiago Temple - github.com/vintem

If you'd like to help out feel free to fork and send me pull requests!

License

Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

Something went wrong with that request. Please try again.