README.md in resque_mailer-2.1.0 vs README.md in resque_mailer-2.2.0
- old
+ new
@@ -13,11 +13,11 @@
class MyMailer < ActionMailer::Base
include Resque::Mailer
end
-Now, when <tt>MyMailer.subject_email(params).deliver</tt> is called, an entry
+Now, when `MyMailer.subject_email(params).deliver` is called, an entry
will be created in the job queue. Your Resque workers will be able to deliver
this message for you. The queue we're using is imaginatively named +mailer+,
so just make sure your workers know about it and are loading your environment:
QUEUE=mailer rake environment resque:work
@@ -31,22 +31,35 @@
a separate worker**. This means that you should resist the temptation to pass
database-backed objects as parameters in your mailer and instead pass record
identifiers. Then, in your delivery method, you can look up the record from
the id and use it as needed.
-If you want to set a different default queue name for your mailer, you can
-change the <tt>default_queue_name</tt> property like so:
+If you want to set a different default queue name for your mailer, you can
+change the `default_queue_name` property like so:
# config/initializers/resque_mailer.rb
Resque::Mailer.default_queue_name = 'application_specific_mailer'
This is useful when you are running more than one application using
resque_mailer in a shared environment. You will need to use the new queue
name when starting your workers.
QUEUE=application_specific_mailer rake environment resque:work
+### Using with Resque Scheduler
+
+If [resque-scheduler](https://github.com/bvandenbos/resque-scheduler) is
+installed, two extra methods will be available: `deliver_at` and `deliver_in`.
+These will enqueue mail for delivery at a specified time in the future.
+
+ # Delivers on the 25th of December, 2013
+ MyMailer.reminder_email(params).deliver_at(Time.parse('2013-12-25'))
+
+ # Delivers in 7 days
+ MyMailer.reminder_email(params).deliver_in(7.days)
+
+
## Resque::Mailer as a Project Default
If you have a variety of mailers in your application and want all of them to use
Resque::Mailer by default, you can subclass ActionMailer::Base and have your
other mailers inherit from an AsyncMailer:
@@ -78,9 +91,14 @@
You don't want to be sending actual emails in the test environment, so you can
configure the environments that should be excluded like so:
# config/initializers/resque_mailer.rb
Resque::Mailer.excluded_environments = [:test, :cucumber]
+
+Note: Define `current_env` if using Resque::Mailer in a non-Rails project:
+
+ Resque::Mailer.current_env = :production
+
## Note on Patches / Pull Requests
* Fork the project.
* Make your feature addition or bug fix.