msmtp
関連記事
msmtp はとてもシンプルで使いやすい SMTP クライアントです。sendmail と完全な互換性があります。
目次
インストール
msmtp パッケージでインストールできます。さらに msmtp-mta をインストールすることで msmtp に sendmail エイリアスが作成されます。
基本設定
以下は msmtp の設定例です (パッケージに含まれている、/usr/share/doc/msmtp/msmtprc-user.example
にある通常ユーザーのサンプルが基になっています。システム設定ファイルは /etc/msmtprc
にあり、サンプルは /usr/share/doc/msmtp/msmtprc-system.example
にあります):
~/.msmtprc
# Set default values for all following accounts. defaults auth on tls on tls_trust_file /etc/ssl/certs/ca-certificates.crt logfile ~/.msmtp.log # Gmail account gmail host smtp.gmail.com port 587 from username@gmail.com user username password plain-text-password # A freemail service account freemail host smtp.freemail.example from joe_smith@freemail.example ... # Set a default account account default : gmail
ユーザーの設定ファイルは所有者が読み書きできるように明示的に設定しないと msmtp がエラーを吐きます:
$ chmod 600 ~/.msmtprc
設定ファイルに平文でパスワードを保存したくない場合、passwordeval を使って外部プログラムを起動するか、あるいは下のパスワード管理セクションを見てください。以下は GnuPG を使ってパスワードを暗号化する例です:
$ echo -e "password\n" | gpg --encrypt -o .msmtp-gmail.gpg # enter id (email...)
~/.msmtprc
passwordeval "gpg --quiet --for-your-eyes-only --no-tty --decrypt ~/.msmtp-gmail.gpg"
mail コマンドを使う
mail
コマンドを使ってメールを送信するには s-nail パッケージをインストールする必要があります。それに加えて sendmail
互換の MTA が必要です。msmtp-mta をインストールするか /etc/mail.rc
を編集して sendmail クライアントを設定してください:
/etc/mail.rc
set sendmail=/usr/bin/msmtp
システム共通の /etc/msmtprc
ファイルを使用するか、.msmtprc
ファイルをメールを送信したい全てのユーザーのホームディレクトリに配置する必要があります。
msmtp ではエイリアスが使えます。以下の行を msmtprc のデフォルトセクションかローカルの設定ファイルに追加してください:
/etc/msmtprc
aliases /etc/aliases
そして /etc
にエイリアスファイルを作成してください:
/etc/aliases
# Example aliases file # Send root to Joe and Jane root: joe_smith@example.com, jane_chang@example.com # Send everything else to admin default: admin@domain.example
動作のテスト
アカウントオプション (--account=,-a
) で送信元として使用するアカウントを指定します:
$ echo "hello there username." | msmtp -a default username@domain.com
もしくは、ファイルにアドレスを書いて使用するには:
To: username@domain.com From: username@gmail.com Subject: A test Hello there.
$ cat test.mail | msmtp -a default <username>@domain.com
Cronie のデフォルトメールクライアント
cronie で sendmail ではなく msmtp を使うようにするには、msmtp-mta をインストールするか、cronie.service
systemd ユニットを編集してください:
/etc/systemd/system/cronie.service.d/msmtp.conf
[Service] ExecStart= ExecStart=/usr/bin/crond -n -m '/usr/bin/msmtp -t'
それから cronie あるいは msmtp にメールアドレスを設定してください:
/etc/msmtprc
に追加:aliases /etc/aliases
それから/etc/aliases
を作成:your_username: email@address.com
- crontab の
MAILTO
行に追加:MAILTO=email@address.com
パスワード管理
msmtp のパスワードはプレーンテキスト・暗号化ファイル・キーリングのどれかに保存できます [1]。
GNOME Keyring
GNOME Keyring にパスワードを保存することができます。Wiki ページに従ってキーリングを設定したら libsecret をインストールしてください。以下のコマンドでパスワードを保存できます:
$ secret-tool store --label=msmtp host smtp.your.domain service smtp user yourusername
msmtp は自動的にパスワードを確認します。
GnuPG
password
ディレクティブは省略できます。省略した場合、アカウントの auth
を off
以外の値に設定することで、インタラクティブシェルから msmtp を起動したときにメールの送信前にパスワードが要求されるようになります。Mutt などの他のアプリケーションから呼び出されたときは msmtp はパスワードを要求しません。そのようなときは --passwordeval
パラメータを使って GnuPG などの外部のキーリングツールを使用することができます。
GnuPG と gpg-agent を設定してパスワードを毎回入力しなくてもよいようにしてください。それから、以下のように msmtp 用に暗号化したパスワードファイルを作成してください。700
パーミッションで tmpfs 上にディレクトリを作成することで、ディスクに暗号化されていないパスワードが書き込まれないようにすることができます。ディレクトリの中にはメールアカウントのパスワードを記述したプレーンテキストファイルを作成してください。そして、秘密鍵を使ってファイルを暗号化してください:
$ gpg --default-recipient-self -e /path/to/plain/password
プレーンテキストファイルを削除して、暗号化したファイルを適切なディレクトリに移動してください (例: ~/.mail/.msmtp-credentials.gpg
)。~/.msmtprc
に以下を追加:
~/.msmtprc
passwordeval "gpg --quiet --for-your-eyes-only --no-tty --decrypt ~/.mail/.msmtp-credentials.gpg"
Mutt などからメールを送信するときに GUI のパスワードプロンプトを表示するだけなら上記で十分です。gpg によってパスフレーズのプロンプトが表示されない場合、先に gpg-agent を起動してください。muttrc に ` command `
のようにバッククォートを使って外部コマンドを指定することでエージェントを起動できます。例:
muttrc
set my_msmtp_pass=`gpg -d mypwfile.gpg`
Mutt will execute this when it starts, gpg-agent will cache your password, msmtp will be happy and you can send mail.
An alternative is to place passwords in ~/.netrc
, a file that can act as a common pool for msmtp, OfflineIMAP, and associated tools.
ヒントとテクニック
msmtp をオフラインで使う
msmtp は素晴らしいツールですが、使用するにはオンラインになる必要があります。インターネットに常時接続することができないノートパソコンなどではあまり好ましくありません。この問題を解決するためのスクリプトが複数存在し、まとめて msmtpqueue と呼ばれます。
スクリプトは /usr/share/doc/msmtp/msmtpqueue
にインストールされます。スクリプトはどこか便利な場所にコピーすると良いでしょう (/usr/local/bin
を推奨します)。
そして MUA でメールを送信するときに msmtp のかわりに msmtp-enqueue.sh を使うようにしてください。デフォルトでは、キューに入ったメッセージは ~/.msmtpqueue
に保存されます。保存場所を変更したい場合はスクリプトの QUEUEDIR=$HOME/.msmtpqueue
行を変更してください (もしくは行を削除して、.bash_profile
で QUEUEDIR 変数をエクスポートしてください: export QUEUEDIR="$XDG_DATA_HOME/msmtpqueue"
)。
作成したメールを送信したいときは以下のコマンドを実行:
$ /usr/local/bin/msmtp-runqueue.sh
/usr/local/bin
を PATH に追加することでキーストロークを少なくすることができます。スクリプトに付属している README ファイルには有用な情報が載っているため、読むことを推奨します。
Vim のシンタックスハイライト
msmtp のソースディストリビューションには Vim 用の msmtprc
のシンタックスハイライトスクリプトが含まれています。/usr/share/vim/vimfiles/syntax/msmtp.vim
で利用できます。ファイルタイプは自動的に認識されません。modeline をファイルの一番上に追加するのが簡単です:
# vim:filetype=msmtp
msmtp を使って PHP でメールを送信
php.ini
の sendmail_path オプションを以下のように編集してください:
sendmail_path = "/usr/bin/msmtp -C /path/to/your/config -t"
Note that you can not use a user configuration file (ie: one under ~/) if you plan on using msmtp as a sendmail replacement with php or something similar. In that case just create /etc/msmtprc, and remove your user configuration (or not if you plan on using it for something else). Also make sure it's readable by whatever you're using it with (php, django, etc...)
From the msmtp manual: Accounts defined in the user configuration file override accounts from the system configuration file. The user configuration file must have no more permissions than user read/write
So it's impossible to have a conf file under ~/ and have it still be readable by the php user.
To test it place this file in your php enabled server or using php-cli.
<?php mail("your@email.com", "Test email from PHP", "msmtp as sendmail for PHP"); ?>
Using XOAUTH2 Authentication for Gmail
msmtp currently does not support OAUTH2 authentication. To use XOAUTH2 authentication with Gmail (see official information), you can install the msmtp-oauth2AUR package in AUR. The package did a small hack so that the plain authentication method will send the AUTH XOAUTH2 password
instead of the AUTH PLAIN ...
, effectively disabling plain authentication and enabling XOAUTH2. An example config is as follows:
account gmail host smtp.gmail.com port 587 from your@gmail_login_email tls on tls_starttls on tls_certcheck off auth plain user any_thing_here passwordeval "get-gmail-token" logfile ~/.msmtp.log
The get-gmail-token
script can be found from the source files of the AUR package. See more information on getmail link about how this works. And see Gmail API quickstart for instruction on registering a Gmail APP and authorizing it to access emails.
トラブルシューティング
TLS の問題
以下のエラーメッセージが表示される場合:
msmtp: TLS certificate verification failed: the certificate hasn't got a known issuer
おそらく tls_trust_file が正しくありません。
Just follow the fine manual. It explains you how to find out the server certificate issuer of a given smtp server. Then you can explore the /usr/share/ca-certificates/
directory to find out if by any chance, the certificate you need is there. If not, you will have to get the certificate on your own. If you are using your own certificate, you can make msmtp trust it by adding the following to your ~/.msmtprc
:
tls_fingerprint <SHA1 (recommended) or MD5 fingerprint of the certificate>
If you are trying to send mail through GMail and are receiving this error, have a look at this thread or just use the second GMail example above.
If you are completely desperate, but are 100% sure you are communicating with the right server, you can always temporarily disable the cert check:
$ msmtp --tls-certcheck off
以下のメッセージが表示される場合:
msmtp: TLS handshake failed: the operation timed out
FS#44994 のバグが原因です。--with-ssl=openssl
を使って msmtp を再コンパイルしてください (デフォルトでは GnuTLS が有効になっています)。
Server sent empty reply
"server sent empty reply" エラーが表示される場合、以下の行を ~/.msmtprc
に追加してください:
tls_starttls off
上記の設定で msmtp で STARTTLS (ポート 587) のかわりに SSL/TLS (ポート 465) が使われるようになります [2]。
GSSAPI の問題
以下のエラーが表示される場合:
GNU SASL: GSSAPI error in client while negotiating security context in gss_init_sec_context() in SASL library. This is most likely due insufficient credentials or malicious interactions.
.msmtprc ファイルの auth 設定を gssapi から plain に変更してみてください [3]:
auth plain