/var/log/azumakuniyuki

去年の夏ごろから作ってたHainekoを大晦日にCPANにアップロードしました。HainekoというのはHTTPサーバとして動いてJSONでPOSTされたメールを指定したSMTPサーバやメールクラウドにリレーするという代物なのですが、現時点でHainekoに関する最新情報は昨年渋谷であったShibuya Plack/PSGI Conference #1で発表した資料とgithubに置いているリポジトリのREADME-JA.mdです。

細かい説明まで含めるとREADMEに収めるには量が多い感じなので、ドキュメント類は思いつきで取得したhaineko.orgに纏めてそのうち置く予定ではありますが、開発開始〜今日に至るまでちょいちょい仕様が変わっているので、一旦全体的な概要を書いておこうかと思います。

Hainekoとは何か

CPANからインストール出来るようになりました

% sudo cpanm Haineko ⏎
--> Working on Haineko
Fetching http://search.cpan.org/CPAN/authors/id/A/AK/AKXLIX/Haineko-0.2.12.tar.gz ... OK
...
Successfully installed Net-DNS-0.73
Building and testing Haineko-0.2.12 ... OK
Successfully installed Haineko-0.2.12
3 distributions installed
% perldoc -l Haineko ⏎
/usr/local/lib/perl5/site_perl/5.12.1/Haineko.pm

XML::SimpleとかXML周辺のインストールに失敗する場合は、expatをpkg_addとかyumとかaptとかで、あるいはportsから入れるといけるかもしれません。

簡単なチュートリアル

セットアップ

% sudo hainekoctl setup --dest /usr/local/haineko ⏎
 * debug1: Destination directory = /usr/local/haineko
 * debug1: Temporary directory = /tmp/BUT1IP0WBd
 * debug1: Archive file = /tmp/BUT1IP0WBd/haineko-setup-files.tar.gz
 * debug1: Extracted directory = /tmp/BUT1IP0WBd/haineko-setup-files
 * debug1: [MAKE] /usr/local/haineko/bin
 * debug1: [COPY] /usr/local/haineko/bin/hainekoctl
 * debug1: [PERM] 0755 /usr/local/haineko/bin/hainekoctl
 * debug1: [MAKE] /usr/local/haineko/etc
 * debug1: [COPY] /usr/local/haineko/etc/authinfo
 * debug1: [PERM] 0600 /usr/local/haineko/etc/authinfo
 * debug1: [COPY] /usr/local/haineko/etc/haineko.cf
 * debug1: [COPY] /usr/local/haineko/etc/mailertable
 * debug1: [COPY] /usr/local/haineko/etc/password
 * debug1: [COPY] /usr/local/haineko/etc/recipients
 * debug1: [COPY] /usr/local/haineko/etc/relayhosts
 * debug1: [COPY] /usr/local/haineko/etc/sendermt
 * debug1: [MAKE] /usr/local/haineko/libexec
 * debug1: [COPY] /usr/local/haineko/libexec/haineko.psgi
 * debug1: [DONE] hainekoctl --dest /usr/local/haineko

/usr/local/hainekoにファイルを展開していますが、~/hainekoでも何処でも良いです。etc/以下に設定ファイルが沢山ありますが、存在しなければHaineko::Defaultの値を読込んで動きますので、無くても良いですがあった方が良いです。

リレーサーバの設定

# etc/mailertable
default:
  mailer: 'ESMTP'
  host: 'smtp.gmail.com'
  port: 587
  auth: 'MyGoogleMail'
  starttls: 1

etc/authinfo

Gmailへ送る時は認証が必要ですので、etc/authinfoに認証情報を書いておきます。etc/mailertableの"auth"に書いた"MyGoogleMail"という値をキーにもつ認証情報が使用されますので、下記のように書いておきます。

# etc/authinfo
MyGoogleMail:
  username: 'Gmailのアカウント名'
  password: 'Gmailのパスワード'

キー名はmailertableとauthinfoで一致していてYAMLの規則に反していなければ何でも良いです。ユーザ名とパスワードの組をauthinfoに分離しているのは、ファイルそのもののパーミッションで保護する事が目的ですので、Hainekoを実行するユーザが読み取り権限を持っている必要があります。

メールを作る

{
    "ehlo": "[127.0.0.1]",
    "mail": "kijitora@example.org",
    "rcpt": [ "mikeneko@example.jp" ],
    "header": {
        "from":    "キジトラ <kijitora@example.com>",
        "subject": "謹賀新年",
        "replyto": "straycats@cat-ml.example.org",
        "charset": "UTF-8"
    },
    "body": "あとでお年玉貰いに行きます"
}

"mail"の値には自分のメールアドレスを(From)入れて"rcpt"の値には宛先メールアドレスを複数個書きます。宛先メールアドレス数の上限はhaineko.cfの"max_rcpts_per_message"で定義される4件です。

headerの値

"from"にはFromヘッダに表示したい名前とメールアドレスを書きますが、"from"が無い場合は"mail"のメールアドレスがヘッダに使われます。

"replyto"も返信は別のメールアドレスに欲しい場合は書いておくと良いですが、無い場合はReply-Toヘッダが作られないだけなのでなくても良いです。

"charset"はメール本文やSubjectにマルチバイト文字を使っている場合の文字コードを指定しますが、"charset"が無い場合はUTF-8である前提で処理されます。もしも伝統的なISO-2022-JPで書いたSubjectや本文であれば、"charset"の値は"ISO-2022-JP"としてください。

このような感じで作ったメールを/tmp/mail.jsonとして保存しておきます。

送信を許可する宛先(etc/recipients)

# etc/recipients
open-relay: 0
domainpart:
    - 'example.jp'

recipients:
    - 'sabatora@example.jp'
    - 'mi-chan@example.org'

宛先メールアドレスがいくつもないのであれば"recipients"シーケンスに、沢山あるのであれば共通するドメインを"domainpart"シーケンスに列挙しておくと良いです。

Hainekoを起動する

% /usr/local/haineko/bin/hainekoctl start -d ⏎
Watching /usr/local/haineko/etc /usr/local/haineko/lib /usr/local/haineko/libexec/lib /usr/local/haineko/libexec/haineko.psgi for file updates.
HTTP::Server::PSGI: Accepting connections at http://127.0.0.1:2794/

hainekoctlスクリプトを使わなくてもplackupで起動しても良いです。

% export HAINEKO_ROOT=/usr/local/haineko ⏎
plackup -o 127.0.0.1 -p 2794 /usr/local/haineko/libexec/haineko.psgi ⏎
HTTP::Server::PSGI: Accepting connections at http://127.0.0.1:2794/

上の例では-dオプションを付けていて、Hainekoへの接続が全て起動したターミナルの標準エラーに出力されます。-d(--devel)を付けない場合は本番モードで動きます。

メールの送信

% curl -XPOST -d'@/tmp/mail.json' 'http://127.0.0.1:2794/submit' | jq -M . ⏎
{
  "referer": null,
  "addresser": "kijitora@example.org",
  "recipient": [
    "mikeneko@example.jp"
  ],
  "response": [
    {
      "command": "QUIT",
      "mailer": "ESMTP",
      "port": 587,
      "message": [
        "2.0.0 closing connection ae5sm140915401pac.18 - gsmtp"
      ],
      "host": "smtp.gmail.com",
      "dsn": "2.0.0",
      "error": 0,
      "rcpt": "mikeneko@example.jp",
      "code": "221"
    }
  ],
  "useragent": "curl/7.15.5 (i686-redhat-linux-gnu) libcurl/7.15.5 OpenSSL/0.9.8b zlib/1.2.3 libidn/0.6.5",
  "queueid": "s03IZwf48603hOYm",
  "remoteport": 50320,
  "timestamp": {
    "datetime": "Fri Jan  3 18:35:58 2014",
    "unixtime": "1388741758"
  },
  "remoteaddr": "127.0.0.1"
}

まとめ