aboutsummaryrefslogtreecommitdiffstats
path: root/actionmailer/lib/action_mailer/message_delivery.rb
blob: db7724195c015cc07ddb1b2d268f55a9f1891b45 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
require 'delegate'

module ActionMailer

  # The ActionMailer::MessageDeliver class is used by ActionMailer::Base when
  # creating a new mailer. MessageDeliver is a wrapper (Delegator subclass)
  # around a lazy created Mail::Message. You can get direct access to the
  # Mail::Message, deliver the email or schedule the email to be sent through ActiveJob.
  #
  #   Notifier.welcome(User.first)               # an ActionMailer::MessageDeliver object
  #   Notifier.welcome(User.first).deliver_now   # sends the email
  #   Notifier.welcome(User.first).deliver_later # enqueue the deliver email job to ActiveJob
  #   Notifier.welcome(User.first).message       # a Mail::Message object
  class MessageDelivery < Delegator
    def initialize(mailer, mail_method, *args) #:nodoc:
      @mailer = mailer
      @mail_method = mail_method
      @args = args
    end

    def __getobj__ #:nodoc:
      @obj ||= @mailer.send(:new, @mail_method, *@args).message
    end

    def __setobj__(obj) #:nodoc:
      @obj = obj
    end

    # Returns the Mail::Message object
    def message
      __getobj__
    end

    # Enqueues the message to be delivered through ActiveJob. When the
    # ActiveJob job runs it will send the email using #deliver_now!. That
    # means that the message will be sent bypassing checking perform_deliveries
    # and raise_delivery_errors, so use with caution.
    #
    # ==== Examples
    #
    #   Notifier.welcome(User.first).deliver_later
    #   Notifier.welcome(User.first).deliver_later(in: 1.hour)
    #   Notifier.welcome(User.first).deliver_later(at: 10.hours.from_now)
    #
    # ==== Options
    # * <tt>in</tt>  - Enqueue the message to be delivered with a delay
    # * <tt>at</tt>  - Enqueue the message to be delivered at (after) a specific date / time
    def deliver_later!(options={})
      enqueue_delivery :deliver_now!, options
    end

    # Enqueues the message to be delivered through ActiveJob. When the
    # ActiveJob job runs it will send the email using #deliver_now.
    #
    # ==== Examples
    #
    #   Notifier.welcome(User.first).deliver_later
    #   Notifier.welcome(User.first).deliver_later(in: 1.hour)
    #   Notifier.welcome(User.first).deliver_later(at: 10.hours.from_now)
    #
    # ==== Options
    # * <tt>in</tt>  - Enqueue the message to be delivered with a delay
    # * <tt>at</tt>  - Enqueue the message to be delivered at (after) a specific date / time
    def deliver_later(options={})
      enqueue_delivery :deliver_now, options
    end

    # Delivers a message. The message will be sent bypassing checking perform_deliveries
    # and raise_delivery_errors, so use with caution.
    #
    #   Notifier.welcome(User.first).deliver_now!
    #
    def deliver_now!
      message.deliver!
    end

    # Delivers a message:
    #
    #   Notifier.welcome(User.first).deliver_now
    #
    def deliver_now
      message.deliver
    end

    def deliver! #:nodoc:
      ActiveSupport::Deprecation.warn "#deliver! is deprecated and will be removed in Rails 5. " \
        "Use #deliver_now! to deliver immediately or #deliver_later! to deliver through ActiveJob."
      deliver_now!
    end

    def deliver #:nodoc:
      ActiveSupport::Deprecation.warn "#deliver is deprecated and will be removed in Rails 5. " \
        "Use #deliver_now to deliver immediately or #deliver_later to deliver through ActiveJob."
      deliver_now
    end

    private

      def enqueue_delivery(delivery_method, options={})
        args = @mailer.name, @mail_method.to_s, delivery_method.to_s, *@args
        enqueue_method = :enqueue
        if options[:at]
          enqueue_method = :enqueue_at
          args.unshift options[:at]
        elsif options[:in]
          enqueue_method = :enqueue_in
          args.unshift options[:in]
        end
        ActionMailer::DeliveryJob.send enqueue_method, *args
      end
  end
end