README.md in mailkick-1.2.2 vs README.md in mailkick-1.3.0
- old
+ new
@@ -1,10 +1,10 @@
# Mailkick
Email subscriptions for Rails
-- Add one-click unsubscribe links to your emails
+- Add one-click unsubscribe links and headers to your emails
- Fetch bounces and spam reports from your email service
:postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for analytics
[![Build Status](https://github.com/ankane/mailkick/workflows/build/badge.svg?branch=master)](https://github.com/ankane/mailkick/actions)
@@ -78,9 +78,19 @@
```sh
rails generate mailkick:views
```
which copies the view into `app/views/mailkick`.
+
+## Unsubscribe Headers
+
+For one-click unsubscribe headers ([RFC 8058](https://datatracker.ietf.org/doc/html/rfc8058)), create `config/initializers/mailkick.rb` with:
+
+```ruby
+Mailkick.headers = true
+```
+
+Headers will automatically be added to emails that call `mailkick_unsubscribe_url`.
## Bounces and Spam Reports
Fetch bounces, spam reports, and unsubscribes from your email service. Create `config/initializers/mailkick.rb` with a method to handle opt outs.