/var/log/azumakuniyuki

夏に``Haineko''というHTTPでメール送信が出来るWebアプリケーションといいますか、HTTPでアクセス可能なAPIを作りました。

ざっくりした話は七月にはてなさんで開催されたKyoto.pmで発表したのですが、Hainekoの全体を見渡した話はまだ書いていなかったので、暦の上で秋になる前に書いておきます。

2014/01/06追記:

最新版のversion 0.2.13を基準として新たに概要を「HainekoがCPANモジュールになりました」として書きました。

Hainekoとは何か

接続先のURLは、HainekoがLISTENしているアドレスの/submitです。

$ cp eg/email-01.json /tmp/1.eml ⏎
$ vi /tmp/1.eml ⏎
$ curl -X POST -H 'Content-Type: application/json' -d '@/tmp/1.eml' 'http://127.0.0.1:2794/submit' | jq -M . ⏎
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   892  100   508  100   384    253    191  0:00:02  0:00:02 --:--:--   253
{
  "smtp.remoteport": 51762,
  "smtp.addresser": "kijitora@example.org",
  "smtp.remoteaddr": "127.0.0.1",
  "smtp.queueid": "r75FLUu048375jJI",
  "smtp.response": {
    "code": "250",
    "command": "QUIT",
    "message": [
      "2.0.0 OK Authenticated\n",
      "2.1.0 <kijitora@example.org>... Sender ok\n"
    ],
    "error": 0,
    "dsn": "2.1.0"
  },
  "smtp.useragent": "curl/7.21.4 (universal-apple-darwin11.0) libcurl/7.21.4 OpenSSL/0.9.8x zlib/1.2.5",
  "smtp.started": "Sun Aug  4 22:22:22 2013",
  "smtp.stage": 0,
  "smtp.referer": null,
  "smtp.recipient": [
    "mikeneko@example.jp"
  ]
}

curlでメールデータを記述したJSONを渡して、Hainekoが返す応答をjqコマンドで見やすくしています。jqコマンド、便利です。メール送信はJSONで渡して応答もJSONで返ってきますので、JSONが扱える言語であればPerlでなくてもPythonでもRubyでもPHPでもなんでもOKです。

作った理由

きっかけ: Javascriptからメール送信

様々な送信方法がある

汎用的な仕組みがない

名前について

Hainekoの実装

フレームワーク: Mojoliciousで実装

全体の流れ: リレーサーバとして動く

リレー: SMTPサーバやクラウドのAPIへ

LISTENするポート番号

インストールと起動

A. ソースディレクトリで実行: インストール不要

$ sudo cpanm --installdeps .⏎
$ cp etc/haineko.cf-example etc/haineko.cf ⏎
$ 他、etc/以下の必要な設定ファイルをコピーして編集

$ plackup -o '127.0.0.1' -p 2794 -a libexec/haineko.psgi ⏎

B. /usr/local/hainekoにインストールして実行: makeを使う

$ ./bootstrap ⏎
$ sh configure ⏎
$ make depend && make && make test ⏎
$ sudo make install ⏎
...

$ cd /usr/local/haineko ⏎
$ cp etc/haineko.cf-example etc/haineko.cf ⏎
$ 他、etc/以下の必要な設定ファイルをコピーして編集

$ export PERL5LIB=/usr/local/haineko/lib/perl5 ⏎
$ plackup -o '127.0.0.1' -p 2794 -a libexec/haineko.psgi ⏎

C. /usr/localにインストールして実行: cpanmだけでOK

$ sudo cpanm . ⏎
$ sudo cpanm -L/usr/local --installdeps ⏎
...

$ cd /usr/local/etc ⏎
$ cp haineko.cf-example haineko.cf ⏎
$ 他、etc/以下の必要な設定ファイルをコピーして編集

$ cd /usr/local ⏎
$ plackup -o '127.0.0.1' -p 2794 -a libexec/haineko.psgi ⏎

セキュリティ

relayhosts: 接続元IPアドレスで

recipients: 送信出来る宛先を定義

テンプレート

{ 'template' => 'greeting', 'param' => { 'var1' => 'cat', 'var2' => 'kijitora' } }

みたいなのを渡せば、指定ディレクトリにあるgreeting.emlとかそういうのをテンプレートとして処理してメール本文を作るのがよいかなぁという感じです。多くの宛先に同じ文面を送る際はテンプレート処理で本文を得たほうが、クライアントからHaineoに転送するデータが少なくて済みますし。

HainekoにPOSTする時の認証

Haineko::Relay::Haineko

Haineko::Milter