Module: Railgun

Defined in:
lib/railgun.rb,
lib/railgun/errors.rb,
lib/railgun/mailer.rb,
lib/railgun/railtie.rb,
lib/railgun/attachment.rb

Defined Under Namespace

Classes: Attachment, ConfigurationError, Error, InternalError, Mailer, Railtie

Class Method Summary collapse

Class Method Details

.build_message_object(mail) ⇒ Object

Acts on a Rails/ActionMailer message object and uses Mailgun::MessageBuilder to construct a new message.

Parameters:


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/railgun/mailer.rb', line 149

def build_message_object(mail)
  mb = Mailgun::MessageBuilder.new

  mb.from mail[:from]
  mb.reply_to(mail[:reply_to].to_s) if mail[:reply_to].present?
  mb.subject mail.subject
  mb.body_html extract_body_html(mail)
  mb.body_text extract_body_text(mail)

  [:to, :cc, :bcc].each do |rcpt_type|
    addrs = mail[rcpt_type] || nil
    case addrs
    when String
      # Likely a single recipient
      mb.add_recipient rcpt_type.to_s, addrs
    when Array
      addrs.each do |addr|
        mb.add_recipient rcpt_type.to_s, addr
      end
    when Mail::Field
      mb.add_recipient rcpt_type.to_s, addrs.to_s
    end
  end

  return mb.message if mail.attachments.empty?

  mail.attachments.each do |attach|
    attach = Attachment.new(attach, encoding: 'ascii-8bit', inline: attach.inline?)
    attach.attach_to_message! mb
  end

  return mb.message
end

.extract_body_html(mail) ⇒ String

Returns the decoded HTML body from the Mail::Message object if available, otherwise nil.

Parameters:

Returns:

  • (String)

189
190
191
192
193
194
195
# File 'lib/railgun/mailer.rb', line 189

def extract_body_html(mail)
  begin
    retrieve_html_part(mail).body.decoded || nil
  rescue
    nil
  end
end

.extract_body_text(mail) ⇒ String

Returns the decoded text body from the Mail::Message object if it is available, otherwise nil.

Parameters:

Returns:

  • (String)

203
204
205
206
207
208
209
# File 'lib/railgun/mailer.rb', line 203

def extract_body_text(mail)
  begin
    retrieve_text_part(mail).body.decoded || nil
  rescue
    nil
  end
end

.retrieve_html_part(mail) ⇒ Mail::Message

Returns the mail object from the Mail::Message object if html part exists, (decomposing multipart into individual format if necessary) otherwise nil.

Parameters:

Returns:

  • (Mail::Message)

    mail message with its content-type = text/html


230
231
232
233
# File 'lib/railgun/mailer.rb', line 230

def retrieve_html_part(mail)
  return mail.html_part if mail.multipart?
  (mail.mime_type =~ /^text\/html$/i) && mail
end

.retrieve_text_part(mail) ⇒ Mail::Message

Returns the mail object from the Mail::Message object if text part exists, (decomposing multipart into individual format if necessary) otherwise nil.

Parameters:

Returns:

  • (Mail::Message)

    mail message with its content-type = text/plain


218
219
220
221
# File 'lib/railgun/mailer.rb', line 218

def retrieve_text_part(mail)
  return mail.text_part if mail.multipart?
  (mail.mime_type =~ /^text\/plain$/i) && mail
end

.transform_for_mailgun(mail) ⇒ Hash

Performs a series of transformations on the `mailgun*` attributes. After prefixing them with the proper option type, they are added to the message hash where they will then be sent to the API as JSON.

It is important to note that headers set in `mailgun_headers` on the message WILL overwrite headers set via `mail.headers()`.

Parameters:

Returns:

  • (Hash)

    transformed message hash


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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/railgun/mailer.rb', line 76

def transform_for_mailgun(mail)
  message = build_message_object(mail)

  # v:* attributes (variables)
  mail.mailgun_variables.try(:each) do |k, v|
    message["v:#{k}"] = JSON.dump(v)
  end

  # o:* attributes (options)
  mail.mailgun_options.try(:each) do |k, v|
    message["o:#{k}"] = v
  end

  # support for using ActionMailer's `headers()` inside of the mailer
  # note: this will filter out parameters such as `from`, `to`, and so forth
  #       as they are accepted as POST parameters on the message endpoint.

  msg_headers = Hash.new

  # h:* attributes (headers)

  # Let's set all of these headers on the [Mail::Message] so that
  # the are created inside of a [Mail::Header] instance and processed there.
  mail.headers(mail.mailgun_headers || {})
  mail.header_fields.each do |field|
    header = field.name.downcase
    if msg_headers.include? header
      msg_headers[header] = [msg_headers[header], field.value].flatten
    else
      msg_headers[header] = field.value
    end
  end

  msg_headers.each do |k, v|
    if Railgun::Mailer::IGNORED_HEADERS.include? k.downcase
      Rails.logger.debug("[railgun] ignoring header (using envelope instead): #{k}")
      next
    end

    # Cover cases like `cc`, `bcc` where parameters are valid
    # headers BUT they are submitted as separate POST params
    # and already exist on the message because of the call to
    # `build_message_object`.
    if message.include? k.downcase
      Rails.logger.debug("[railgun] ignoring header (already set): #{k}")
      next
    end

    message["h:#{k}"] = v
  end

  # recipient variables
  message['recipient-variables'] = mail.mailgun_recipient_variables.to_json if mail.mailgun_recipient_variables

  # reject blank values
  message.delete_if do |k, v|
    return true if v.nil?

    # if it's an array remove empty elements
    v.delete_if { |i| i.respond_to?(:empty?) && i.empty? } if v.is_a?(Array)

    v.respond_to?(:empty?) && v.empty?
  end

  return message
end