#action_mailer

[amishyn-blog]

Custom smtp settings for Rails Mailers

I have to define different smtp settings per mailer. Lets say, I want to use different SendGrid accounts to send emails. Rails Mailers use global ActionMailer::Base.smtp_settings. If you want custimize smtp settings per mailer you cant just do MyMailer.smtp_settings = {...}And got work done. Actually you can, but it will set this settings globally. The easiest way, is just to redefine smtp settings for particular mailer

class MyMailer < ActionMailer::Base def self.smtp_settings { ... } end end

And if I want to set different smtp settings for few mailers and make them easy configurable.

I can use next approach: Load configuration for yaml file for each mailer.

Code for it:

Create parent mailer, lets say ApplicationMailer

class ApplicationMailer def self.smtp_settings Hash[SmtpSettings.send(self.to_s.underscore)].symbolize_keys rescue Settingslogic::MissingSetting ActionMailer::Base.smtp_settings end end

class MyMailer < ApplicationMailer end

And create settings:

class SmtpSettings < Settingslogic source Rails.root.join("config/smtp_settings.yml") namespace Rails.env end

smtp_settings.yml:

common: &default_settings my_mailer: address: smtp.sendgrid.net port: 25 authentication: :plain development: <<: *default_settings staging: <<: *default_settings test: <<: *default_settings production: <<: *default_settings

Thats all. Now its easy to configure smtp settings per mailer and per environment. Set mailtrap.io account for dev and stagign and use SendGrid for prod.

[techs-empty]

携帯メールの件名の文字化け

携帯の現状ではAUが一番ひどくて、ISO-2022-JPにしか対応していない。

結局、件名はISO-2022-JP(<-日本語JISのこと)に対応させるべきらしい。

ちなみに、本文でも適応すると、旧漢字が自動的に簡易の漢字に変換されてしまい、

あまり、よろしくないらしい。特に人名などでは。

参考サイト

一応下記のプラグインはある

rails2

http://redmine.jp/faq/general/iso-2022-jp/

rails3

https://github.com/ma2shita/mail_ja

だが、今回２系で動いていて、そのうち３系にUPする予定なので、両方で動く必要がある。なので、自分で書いてみた。

class Notifier < ActionMailer::Base before_deliver :add_default def add_default(mail) mail.subject = base64(mail.subject) if I18n.locale == :ja mail.date = Time.now mail.from = $MAILED_BY mail.bcc = $ALL_MAIL_LOG #mail.reply_to = $REPLY_TO #mail.content_transfer_encoding = '8bit' end def outer_mail(reservation) subject I18n.t("models.notifier." + reservation.mail_type + ".subject",:locale=>reservation.locale) sent_on Time.now from $MAILED_BY bcc $ALL_MAIL_LOG recipients reservation.email body :root_url => $URL ,:reservation => reservation end def inner_mail(reservation) subject I18n.t("models.notifier." + reservation.mail_type + ".subject",:locale=>:ja) sent_on Time.now from $MAILED_BY bcc $ALL_MAIL_LOG recipients reservation.recipient body :root_url => $URL ,:reservation => reservation end private def base64(text, charset="iso-2022-jp", convert=true) if convert if charset == "iso-2022-jp" text = NKF.nkf('-j -m0', text) end end text = [text].pack('m').delete("\r\n") "=?#{charset}?B?#{text}?=" end end

ここで注意事項が２点

before_deliverというのは、このプラグインを入れています。なしだと動かないのでご注意を。

中国語などを表示するために、日本語以外では、変換を行っていません。(6行目)

[techs-empty]

PostfixとActionMailerでメール受信処理

postfixからメールの受信関係の処理をしました。 プログラム自体は凄く簡単なんですが、postfixの設定など含め色々つまづいたので、メモしておきます。 なお、サーバーはCentos6を使っています。

普通はRailsを使うと思いますが、単純にscriptを叩くだけだったのでファイル一枚を目指します。 今回の例では、メールを受信した後、外部のSSLがかかった、XMLRPCのAPIを叩きました。

実験環境は下記になります。

Centos 6.0

postfixt 2.6.6

ruby 1.9.3-p0

actionmailer (3.1.3)

ドメインの設定

まずは、何はともあれ、メールを送れるようにしないといけないと。 ということで、下記のように登録しました。

mail.hogehoge.com A 111.111.111.111 hogehoge.com MX mail.hogehoge.com 10

postfixの基本設定

次に、postfixの設定をしましょう。 ポイントは、inet_interfacesをallにすることと、mydestinationを設定することです。 inet_interfacesをallにするとどこからでも受信できるようになります。 mydestinationはメールの最終到着地点を定義しています。 該当箇所のコメントアウトを外すだけだったりするので、下記は抜粋です。

$ sudo vi /etc/postfix/main.cf myhostname = margin-0.in inet_interfaces = all mydestination = $myhostname, localhost.$mydomain, localhost

プログラムの準備

今回は、メールを受信したら、BacklogというチケットシステムのAPIを叩いて、チケットを登録するスクリプとです。 このAPIはxml-rpcという規格で作られていたため、rubyの標準添付ライブラリのxmlrpcも利用しています。 また、SSLとBasic認証もかかっています。

1 #-*- encoding: utf-8 -*- 2 3 require 'rubygems' 4 require 'xmlrpc/client' 5 require 'action_mailer' 6 require 'kconv' 7 8 class NilClass 9 def blank?; true; end 10 end 11 12 class String 13 def blank?; self==""; end 14 end 15 16 class MailKicker < ActionMailer::Base 17 @@server = XMLRPC::Client.new("xxx.backlog.jp","/xmlrpc",443,nil,nil,"user","password",true,nil) 18 @@server.http_header_extra= {"Content-Type" => "text/xml; charset=utf-8"} 19 20 # 受信したらとりあえず登録する 21 # bundle exec ruby -r ./lib/mail_kicker.rb -e "MailKicker.receive(STDIN.read)" 22 def receive(email=nil) 23 puts email.inspect 24 email.subject = "#{Time.now}に登録したチケット" if email.subject.blank? 25 params = { 26 projectId: 32272, #26584, 27 summary: email.subject.encode("utf-8"), 28 description: email.body.to_s.toutf8 29 } 30 @@server.call("backlog.createIssue", params) 31 end 32 end

小さいプログラムですが、ポイントとしては下記です。

email.bodyはMail::Bodyオブジェクトです。

email.bodyのencodingがiso-2022-jpだったりするので、強制的にkconvでutf8にしています。

xmlrpc( http://xmlrpc.scripting.com/spec.html )がちょっと古そうな規格でした。xmlでのやりとりをするAPIです。rubyのライブラリのおかげで簡単に使えました。

ActionMailer::Baseの子クラスであるMailKickerで作っているreceiveはメソッド名もポイントになります。ActionMailer::Baseでクラスメソッドにreceiveが用意されており、インスタンスメソッドのreceiveが呼ばれるようになっています。また、receiveの引数に入るemailという変数はMailオブジェクトです。Mailオブジェクトは https://github.com/mikel/mail を参照下さい。

参考までに、ActionMailer::Base.receiveは下記に書いておきます。

このクラスメソッドのreceiveを外部コマンドから呼び出すことになります。

ActionMailer::Base

def receive(raw_mail) ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload| mail = Mail.new(raw_mail) set_payload_for_mail(payload, mail) new.receive(mail) end end

postfixのaliasesの設定

次の設定は、メールを受信したときにスクリプトを走らせるための設定です。 引き続き、main.cfの該当箇所を修正します。

$ sudo vi /etc/postfix/main.cf alias_maps = hash:/etc/postfix/aliases alias_database = hash:/etc/postfix/aliases

次は、今設定した/etc/postfix/aliasesを書きます。

$ sudo vi /etc/postfix/aliases hoge: "| SSL_CERT_FILE=/etc/pki/tls/certs/ca-bundle.crt GEM_HOME=/usr/local/rvm/gems/ruby-1.9.3-p0 /usr/local/rvm/rubies/ruby-1.9.3-p0/bin/ruby -r /var/apps/alpha/kickers/lib/mail_kicker.rb -e 'MailKicker.receive(STDIN.read)' >> /tmp/posfix-test.log" fuga: "| echo fuga >/tmp/post-test.txt"

ポイントは、|で繋いでコマンドを叩くところです。 [email protected]で飛んでくると1行目を、[email protected]で飛んでくると2行目を実行します。

下記にポイントをまとめます。

PATHが通っていないので、基本的にフルパスで書きます。

rubyの-eオプションでワンライナーでrubyを実行しています(rails2の場合はscript/runner、rails3の場合はrails runnerを使うでしょうが・・)。

rubyの-rオプション で、requrieするファイルを追加しています。

ActionMailer::Baseのクラスメソッドのreceiveを呼び出しています。

rubyでパイプで繋いだ標準入力を利用するために、STDIN.readを使っています。

内部で使っているrubygemsを指定するために、GEM_HOMEを指定しています。

SSL通信を行うため、SSL_CERT_FILEも指定しています。

SELinux

これで、大体完了だったんですが、SELinuxのおかげでrubyの実行権限がないと言われてだいぶ嵌りました。 とりあえず、OFFにします。

# setenforce 0

最終確認

最後に外部から、[email protected] にメールを送ってあげればOKです。 テストがしにくいので、mockやstubを使ってrspecでテストしてあげると良いですね。

参考文献

https://github.com/rails/rails/tree/master/actionmailer

http://edgeguides.rubyonrails.org/action_mailer_basics.html

https://github.com/mikel/mail

http://xmlrpc.scripting.com/spec.html