Popularity
1.5
Growing
Activity
7.0
Growing
62
4
0

Description

A gem that makes it easy to automatically unsubscribe from emails in Rails.

Programming language: Ruby
License: MIT License
Tags: Email     Engine     Rails    
Latest version: v1.0.0

๐Ÿ“ญ Unsubscribe alternatives and similar gems

Based on the "Email" category.
Alternatively, view unsubscribe alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of ๐Ÿ“ญ Unsubscribe or a related project?

Add another 'Email' Gem

README

๐Ÿ“ญ Unsubscribe

Automatically unsubscribe from emails in Rails.

[Demo](./docs/demo.gif)

๐Ÿš€ Installation

Add this line to your application's Gemfile:

gem 'unsubscribe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install unsubscribe

Then run the installation commands:

rails g unsubscribe:install
rails unsubscribe:install:migrations
rails db:migrate

๐Ÿ“š Usage

Unsubscribe::Owner

  • Add include Unsubscribe::Owner to a Model. The Model must have an email column.
class User < ApplicationRecord
  include Unsubscribe::Owner
end

Available Methods

User.first.mailer_subscriptions
# => #<ActiveRecord::Associations::CollectionProxy [#<Unsubscribe::MailerSubscription>, #<Unsubscribe::MailerSubscription>] >

User.first.subscribed_to_mailer? "MarketingMailer"
# => true/false

User.first.to_sgid_for_mailer_subscription
# => #<SignedGlobalID:123 ...>

Unsubscribe::Mailer

  • Add include Unsubscribe::Mailer to a Mailer.
  • Optionally call unsubscribe_settings to set a name and description. This will be used in the unsubscribe page.
  • Set mail to: to @recipient.email. The @recipient is an instance of whatever Class include Unsubscribe::Owner was added to.
class MarketingMailer < ApplicationMailer  
  include Unsubscribe::Mailer

  unsubscribe_settings name: "Marketing Emails", description: "Updates on promotions and sales."

  def promotion
    mail to: @recipient.email
  end  
end
  • Call the Mailer with a recipient parameter.
  MarketingMailer.with(
    recipient: User.first
  ).promotion.deliver_now

Available Methods

Unsubscribe::MailerSubscription.first.action
# => "Unsubscribe from"/"Subscribe to"

Unsubscribe::MailerSubscription.first.call_to_action
# => "Unsubscribe from Marketing Emails"/"Subscribe to Marketing Emails"

Unsubscribe::MailerSubscription.first.description
# => "Updates on promotions and sales."

Unsubscribe::MailerSubscription.first.name
# => "Marketing Emails"

Unsubscribe Link

  • Add the @unsubscribe_url link to the Mailer.
<%= link_to "Unsubscribe", @unsubscribe_url %>

โš™๏ธ Customize Templates

Run rails g unsubscribe:views if you want to modify the existing templates.

๐ŸŒ I18n

The language used for Unsubscribe::MailerSubscription#action can be translated.

# config/locales/en.yml
en:
  unsubscribe:
    action:
      subscribe: "Subscribe to"
      unsubscribe: "Unsubscribe from"

๐Ÿ™ Contributing

If you'd like to open a PR please make sure the following things pass:

bin/rails test
bundle exec standardrb

๐Ÿ“œ License

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


*Note that all licence references and agreements mentioned in the ๐Ÿ“ญ Unsubscribe README section above are relevant to that project's source code only.