ActionMailerで送信依頼の結果を取得する

ActionMailer→Mail gemには実はサーバのresponseをそのまま返すオプションがある

ドキュメントには全然情報がないんだけど、ここ。

Mail gem

 class SMTPConnection
   # Send the message via SMTP.
   # The from and to attributes are optional. If not set, they are retrieve from the Message.
   def deliver!(mail)
     envelope = Mail::SmtpEnvelope.new(mail)
     response = smtp.sendmail(dot_stuff(envelope.message), envelope.from, envelope.to)
     settings[:return_response] ? response : self
   end

まずdeliver!メソッド、そしてreturn_response: true

deliver を deliver! にすると

  • ログにメールの内容は出力されない

これだけで log に sensitive な情報が残ってしまう問題を避けることができる。

そのうえで

この辺を参考にすると、

  • Configuration で return_reseponse: true にするとサーバの返事を取得できる
  • その際、エラーも生で扱うことになるので raise_delivery_error などの Rails の機能の恩恵には預かれなくなる

例えば送信時のサーバの返事が取得できると何が嬉しいのか

エラーかエラーでないかだけを気にしているのなら返事は wrap されている方がよい。そうでないと status を見てエラーかどうかを見て、エラーでない場合は返事の構造がこうなっているので、ここにある文字列を取得して…という部分を生々しく作っていく必要が出てくる。

今回なぜこれを考えているかというと、

SendGrid の送信したメールの内容とその配信記録、状況の追跡を容易にするため

まず、SendGrid から配信されるメールにおいては以下の二つの message id が存在している。

  • ユーザーのメール上で確認できる伝統的な message-id
  • SendGrid での実際の処理に紐づく sg-message-id

そして、送信時のサーバからの response に、今処理を開始したメールの sg-message-id が入っているので、これをもとに処理の状況を追跡することが可能となる。

ということで、目的によって ActionMailer の return_response:true と deliver! を使うことが大事になってくる。

SendGrid Webhook APIとの突き合わせ

SendGrid の sg-message-id は

  • SMTP API であっても Web API であっても送信時の response に含まれている
  • Event Wehbook API の中にも含まれている

したがって、

  • メール送信時に sg-message-id とともにメールを記録しておく

と、

  • Event Webhook API からの情報をこの記録と突き合わせる

ことが可能になる。

簡単に言うと、「送信したメールが今どうなっているのかを確認できるシステムを作れる」

ということである。

参考

More

Categories

Tool 日々 Web Biz Net Apple MS ことば News Unix howto Food PHP Movie Edu Community Book Security Text TV Perl Ruby Music Pdoc 生き方 RDoc ViewCVS CVS Rsync Disk Mail FreeBSD Cygwin PDF Photo Zebedee Debian OSX Comic Cron Sysadmin Font Analog iCal Sunbird DNS Linux Wiki Emacs Thunderbird Sitecopy Terminal Drawing tDiary AppleScript Life Money Omni PukiWiki Xen XREA Zsh Screen CASL Firefox Fink zsh haXe Ecmascript PATH_INFO SQLite PEAR Lighttpd FastCGI Subversion au prototype.js jsUnit Apache Trac Template Java Rhino Mochikit Feed Bloglines CSS del.icio.us SBS qwikWeb gettext Ajax JSDoc Rails HTML CHM EPWING NDTP EB IE CLI ck ThinkPad Toy WSH RFC readline rlwrap ImageMagick epeg Frenzy sysprep Ubuntu MeCab DTP ERD DBMS eclipse Eclipse Awk RD Diigo XAMPP RubyGems PHPDoc iCab DOM YAML Camino Geekmonkey w3m Scheme Gauche Lisp JSAN Google VMware DSL SLAX Safari Markdown Textile IRC Jabber Fastladder MacPorts LLSpirit CPAN Mozilla Twitter OpenFL Rswatch ITS NTP GUI Pragger Yapra XML Mobile Git Study JSON VirtualBox Samba Pear Growl Mercurial Rack Capistrano Rake Win RSS Mechanize Sitemaps Android JavaScript Python RTM OOo iPod Yahoo Unicode Github iTunes God SBM friendfeed Friendfeed HokuUn Sinatra TDD Test Project Evernote iPad Geohash Location Map Search Simplenote Image WebKit RSpec Phone CSV WiMAX USB Chrome RubyKaigi RubyKaigi2011 Space CoffeeScript Nokogiri Hpricot Rubygems jQuery Node GTD CI UX Design VCS Kanazawa.rb Kindle Amazon Agile Vagrant Chef Windows Composer Dotenv PaaS Itamae SaaS Docker Swagger Grape WebAPI Microservices OmniAuth HTTP 分析基盤 CDN Terraform IaaS HCL Webpack Vue.js BigQuery Middleman CMS AWS PNG Laravel Selenium OAuth OpenAPI GitHub UML GCP TypeScript SQL Hanami Develop Document Jekyll