fetchmail プログラムは一般的なメール取得プロトコル (POP2, POP3, IMAP2bis, IMAP4, IMAPrev1) の いずれかをサポートしているサーバからメールを集めてくることができます。 また、ESMTP の ETRN 拡張と ODMR を使うこともできます。 (これらのプロトコルを説明している RFC 全ては、 このオンラインマニュアルの最後に列挙します。)
fetchmail は基本的に (SLIP や PPP 等の) オンデマンド TCP/IP 接続上で使うためのものですが、 sendmail を使った (送信者開始の) SMTP トランザクションを セキュリティ上の理由から認めないサイトでは、 メッセージ転送エージェントとしても役立つかもしれません。
それぞれのメッセージを取得すると、 通常 fetchmail は自身が動作しているマシン (localhost) の 25 番ポートに SMTP 経由でこのメッセージを配送します。 この動作は、ちょうど通常の TCP/IP 接続上で メッセージが渡されたかのように行われます。 次に、メールはシステムの MDA (Mail Delivery Agent (メール配送エージェント)、 普通は sendmail(8) ですが、システムによっては smail, mmdf, exim, qmail 等が 使われているかもしれません) 経由でローカルに配送されます。 したがって、配送制御機構 (.forward ファイル等) は、 システムの MDA とローカル配送エージェントを通じて 全て通常通り使うことができます。
25 番ポートのリスナはないが、fetchmail のコンパイル時に 信頼できるローカル MDA を検知または指定された場合、 代わりとしてローカル配信にその MDA を使います。 通常、ビルド時に fetchmail は 実行可能プログラム procmail(1) と sendmail(1) のバイナリを探します。
プログラム fetchmailconf が使用可能であれば、このプログラムを使って fetchmailrc の設定ファイルを楽に設定・編集することができます。 このプログラムは X 上で動作し、 またシステム上に Python 言語と Tk ツールキットがあることが必要です。 単独ユーザモード用に初めて fetchmail を設定する場合には、 初心者モード (Novice mode) を使うことをお勧めします。 上級者モード (Expert mode) を使うと、 マルチドロップ機能を含む fetchmail の設定を完全に制御することができます。 どちらの場合でも、`Autoprobe (自動検出)' ボタンを押すと、 指定されたメールサーバが最もうまくサポートしているプロトコルを教えてくれ、 そのサーバで起こる可能性がある問題も指摘してくれます。
問い合わせは、コマンドラインのオプションの後に指定した 全てのサーバに対して行われます。 コマンド行でサーバを指定していない場合には、 ~/.fetchmailrc ファイルの `poll' エントリそれぞれに対して問い合わせが行われます。
fetchmail は、スクリプトやパイプラインで使いやすいように、 終了時に適切な終了コードを返すようになっています。 後述の「終了コード」セクションをご覧ください。
以下のオプションで fetchmail の動作が変わります。 一度うまく動作する .fetchmailrc ファイルが設定できれば、その後は これらのオプションを指定する必要はほとんどないでしょう。
ほとんど全てのオプションには対応するキーワードがあり、これらは fetchmailrc ファイルで宣言することができます。
ここでは一部の特殊なオプションは説明しておらず、 代わりに後述の「認証」と「デーモンモード」に関するセクションで説明しています。
ETRN と ODMR を除き、これらの選択オプションは基本的に全て同じ動作です (標準のサーバデーモンと通信し、 サーバのメールボックスに配送されているメールを取得します)。 ETRN モードを使うと、ESMTP 準拠のサーバ (BSD sendmail のリリース 8.8.0 以降など) に、 クラアイントマシンへの送信 SMTP 接続を即座に開かせ、 サーバの未配達メールのキューに入っている、 宛先がユーザのクライアントマシンになっている 全てのメールの転送を開始させることができます。 ODMR モードでは ODMR が可能なサーバが必要で ETRN と同様に動作します。 ただし、ODMR モードではクライアントマシンに静的 DNS が必要ありません。
--smtphost server1,server2/2525,server3,/var/imap/socket/lmtp
このオプションは ODMR モードで使用することができ、 fetchmail に ODMR サーバと SMTP, LMTP レシーバの間の リレーをさせます。
interface/iii.iii.iii.iii/mmm.mmm.mmm.mmm
最初のスラッシュの前のフィールドはインタフェース名です (つまり、sl0, ppp0 等)。 2 番目のスラッシュの前のフィールドは許可される IP アドレスです。 2 番目のスラッシュの後のフィールドは、許可する IP アドレスの範囲を 指定するマスク値です。 マスクがない場合には、255.255.255.255 (つまり、完全なマッチ) が指定されたものとして扱われます。 このオプションを現在サポートしているのは Linux と FreeBSD だけです。 FreeBSD 固有の情報については、後述の monitor セクションをご覧ください。
`Delivered-To:'
があります。 qmail はローカルのメールボックスにメッセージを配達するときには必ず、 ユーザ名と envelope recipient のホスト名をこの行に書きます。 これは主にメールのループを防ぐために行います。 接続されていないサイトに一括でメールを送る qmail の設定を行うため、 ISP のメールホストはそのサイトを `Virtualhosts' 制御ファイルに書いておくのが普通であり、 これによりそのサイト宛のメールアドレス全てにプレフィックスが追加されます。 その結果、'username@userhost.userdom.dom.com' 宛に送られたメールの `Delivered-To:' 行は以下のような形になります:
Delivered-To: mbox-userstr-username@userhost.userdom.dom.com
ISP は 'mbox-userstr-' プレフィックスを自由に決められますが、 よく選ばれるのはユーザのホスト名にマッチする文字列です。 オプション `envelope Delivered-To:' を使うことにより、 fetchmail に元の envelope recipient を識別させることが安全に行えますが、 正しいユーザにメールを配達するには `mbox-userstr-' プレフィックスを 取り除かなければなりません。 これがこのオプションの目的です。
メールサーバが、あなたが通常のユーザアカウントを持っている Unix マシンならば、 あなたがいつも使っているログイン名とパスワードを fetchmail でも使ってください。 サーバとクライアントの両方で同じログイン名を使っている場合、 -u オプションでわざわざユーザ ID を指定する必要はありません。 というのも、デフォルトの動作ではクライアントマシン上での ログイン名をサーバマシンのユーザ ID として使うからです。 サーバマシンでは別のログイン名を使っている場合には、 -u オプションでログイン名を指定してください。 例えば、'mailgrunt' という名前のマシンでのログイン名が 'jsmith' である場合、 以下のようにして fetchmail を起動することになるでしょう:
fetchmail のデフォルトの動作では、接続が確立される前に ユーザにメールサーバのパスワードを問い合わせます。 これは最も安全に fetchmail を使う方法であり、パスワードも盗まれにくなります。 パスワードは ~/.fetchmailrc ファイルで指定することもできます。 これはデーモンモードやスクリプトで fetchmail を使う場合に便利です。
パスワードを指定されておらず、 fetchmail が ~/.fetchmailrc ファイルからパスワードを展開できなかった場合、 fetchmail は対話的にパスワードを聞く前にユーザのホームディレクトリの ~/.netrc ファイルを探します。 このファイル中に、ユーザのメールサーバにマッチするエントリがあった場合、 そのパスワードが使われます。 fetchmail は poll 名にマッチするものを最初に探します。 これが見つからなければ、via 名にマッチするものをチェックします。 ~/.netrc ファイルの詳しい文法については、オンラインマニュアルの ftp(1) を参照してください。 (この機能を使うと、複数のファイルにパスワード情報が 分かれることを避けることができます。)
通常のユーザアカウントを与えないメールサーバでは普通、 ユーザ ID とパスワードはサーバにメールボックスを与えるときに サーバの管理者が割り当てます。 メールボックスのアカウント用の正しいユーザ ID とパスワードが分からなければ、 サーバの管理者に連絡しましょう。
古いバージョンの POP3 (RFC1081, RFC1225) は メールサーバ側で rhosts を用いる大雑把な形式の独自の認証をサポートしていました。 この RPOP の変種では、パスワードと同等であるユーザごとの固定 ID は、 予約ポートとの接続上で平文のまま送信されていました。 このとき、PASS コマンドでなく RPOPコマンドを使って、 特殊なチェックが必要なことをサーバに知らせていました。 fetchmail は RPOP をサポートしています (`protocol RPOP' を指定すると、 fetchmail に `PASS' ではなく `RPOP' を送らせることができます) が、 これは使わないことを強くお勧めします。 この機能は盗聴に弱いため、RFC1460 において削除されました。
RFC1460 で APOP 認証が導入されました。 この POP3 の変種では、APOP パスワードをサーバホストに登録します (サーバ上でこれを行うプログラムは、 たぶん popauth(8) と呼ばれるものです)。 ~/.fetchmailrc ファイルには、これと同じパスワードを書いてください。 fetchmail がログインするたびに、パスワードとサーバにおけるグリーティング時刻の 暗号学的に安全なハッシュ値がサーバに送られます。 これは、認証データベースのチェックによって検査できます。
お使いの fetchmail が Kerberos のサポート付きで構築されており、 かつ Kerberos 認証を指定 (--auth か .fetchmailrc での authenticate kerberos_v4 オプションを用います) した場合、 fetchmail は問い合わせ開始時に 毎回 Kerberos チケットを取得しようとします。 注意: poll 名か via 名のどちらかが `hesiod' ならば、 fetchmail はメールサーバの検索に Hesiod を使おうとします。
GSSAPI 認証による POP3 や IMAP を使う場合、 fetchmail はサーバが RFC1731 または RFC1734 に準拠する GSSAPI 機能を備えていると仮定して使用します。 現在、この機能は Kerberos V 上でしかテストされていないので、 既に tiket-granting チケットを持っていることを仮定します。 標準の --user コマンドや .fetchmailrc の user オプションを 使って、主に使っている名前とは別のユーザ名を渡すことができます。
お使いの IMAP デーモンがグリーティング行で PREAUTH レスポンスを返した場合には、 fetchmail はこれを通知して、通常の認証手順を飛ばします。 これは例えば ssh を明示的に用いて imapd を起動している場合などに便利です。 この場合、fetchmail が起動したときに パスワードを問い合わせるのを止めさせるために、 そのサイトでの認証の値 `ssh' を宣言できます。
POP3 を使う場合には、サーバは RFC1938 準拠の 使い捨てパスワードのチャレンジ文字列を発行し、 fetchmail はユーザのパスワードをパスフレーズとして使って、 必要とされるレスポンス文字列を生成します。 これにより、ネットワーク上に 暗号化されていない機密情報を流すことを避けることができます。
Compuserve の RPA 認証 (APOP に似ています) がサポートされています。 このサポートを組み込んでいる場合、 ホスト名の中に "@compuserve.com" が見つかると、 fetchmail はパスワードを平文で送らず、 RPA パスフレーズを用いた認証を実行しようとします。
IMAP を使っている場合、 (Microsoft Exchange が使う) Microsoft の NTLM 認証 がサポートされます。 このサポートを組み込んでいる場合、サーバが機能を示す応答で 「AUTH=NTLM」を返すと、fetchmail は (パスワードを平文で送らないで) NTLM 認証を実行しようとします。 「ユーザ名@ドメイン名」の形で user オプションを指定してください: 「@」の左の部分はユーザ名として渡され、 「@」の右の部分は NTLM ドメインとして渡されます。
IPsec を使っている場合には、-T (--netsec) オプションを使うと、 外向きの IP 接続が初期化されるときに使われる IP セキュリティリクエストを渡すことができます。 これは .fetchmailrc ファイルで `netsec' サーバオプションを 使って行うこともできます。 どちらの場合でも、オプションの値は inet6_apps ライブラリの net_security_strtorequest() 関数が受け付ける フォーマットの文字列です。
--ssl オプションを使うと SSL で暗号化されたサービスにアクセスできます。 これは .fetchmailrc ファイルで "ssl" サーバオプションを使っても行えます。 SSL による暗号化を有効にすると、 SSL セッションの調停の後に SSL 接続上で問い合わせが行われます。 POP3 や IMAP といった一部のサービスでは、 SSL による暗号化サービスのために標準プロトコルとは別に 既知のポートが定義されています。 SSL が有効にされており、かつ明示的にポートが指定されていなければ、 暗号化通信のポートは自動的に選択されます。
SSL による暗号化を行うサーバに接続するとき、 サーバは身元確認のためにクライアントに証明書を示します。 証明書はチェックされ、接続しようとしているサーバの名前が 証明書の中の標準名と一致することと、 証明書に書かれている有効期限によると 現在証明書が有効であることが確かめられます。 どちらかのチェックが失敗すると警告メッセージが表示されますが、 接続は継続されます。 サーバの証明書は特定の認証機関 (CA, Certification Authority) によって 署名されている必要はありませんし、 「自分で署名した」証明書であってもかまいません。
SSL による暗号化を行うサーバによっては、 クライアント側の証明書を要求することがあります。 クライアント側の公開 SSL 証明書と秘密 SSL 鍵を指定できます。 サーバが証明書を要求したら、クライアントの証明書は 身元確認のためにサーバに送られます。 サーバによっては正当なクライアントの証明書を要求し、 証明書が送られないか正当でなければ接続を拒否するものがあります。 サーバによっては、認められている認証機関よる署名が クライアント側の証明書になされていることが必要なものもあります。 鍵ファイルと証明書ファイルのフォーマットは、 内部的に動作している SSL ライブラリが必要とする形式 (一般的には OpenSSL) です。
最後に、SSL の使用について注意書きをします : ネットワーク越しに自分で署名したサーバの証明書を取得するという 上で述べたような設定では、 消極的な盗み聞きをする相手からは守れますが、 積極的に攻撃してくる相手から守るための助けにはなりません。 パスワードを平文で送るのに比べれば、かなり改善されますが、 中継点にいる相手からの攻撃は (http://www.monkey.org/~dugsong/dsniff/ にある dsniff のようなツールを使うと特に) 簡単に可能であることを知っておかなければなりません。 自分のメールボックスのセキュリティを真剣に考えるなら、 ssh トンネル (下記の例を参照) をお勧めします。
デーモンモードでは、 fetchmail は自分自身をバックグラウンドでずっと動作させます。 つまり、指定された各ホストへの問い合わせと、 指定された時間のスリープを繰り返します。
したがって、単に
を実行すると、 ~/.fetchmailrc に記述された全てのホスト (キーワード `skip' で明示的に除外されたホストは除きます) に対して 15 分ごとに 1 回ポーリングを行います。
`set daemon <interval>' を ~/.fetchmailrc ファイルに書くことでポーリング間隔を設定することが可能です。 ここで、<interval> は秒数を表す整数値です。 これを行うと、コマンドラインオプションの --daemon 0 または -d0 で上書きしない限り、 fetchmail は必ずデーモンモードで起動します。
ユーザあたり 1 つのデーモンプロセスしか許されません。 デーモンモードでは、 fetchmail はユーザ単位のロックファイルを作成してこれを保証します。
通常は、バックグラウンドでデーモンを動作している時に fetchmail を呼び出すと、 デーモンに対して起動のシグナルを送信し、 即座にメールサーバにポーリングさせることができます。 (fatchmali を root で実行していれば起動シグナルは SIGHUP で、 それ以外のユーザであれば SIGUSR1 です。) 起動の動作では、認証の失敗や複数回のタイムアウトによって 接続が「刺さっている」ことを示すフラグが全てクリアされます。
オプション --quit は、デーモンを起動させるのではなく、動作しているデーモンを殺します (そのようなプロセスが無ければ fetchmail が知らせてくれます)。 --quit オプションが唯一のコマンドラインオプションならば、 この動作だけを行います。
quit オプションは他のコマンドラインオプションと一緒に使うこともできます。 この場合の動作としては、他のオプションと実行制御ファイルを組み合わせて 指定されていることを行う前に、動作しているデーモンを全て殺します。
-L <ファイル名> または --logfile <ファイル名> オプション (キーワード: set logfile) を使うと、 端末と切り離されている間に発生した状態メッセージを、 指定されたログファイル (オプションの後にログファイル名を続けてください) に リダイレクトすることができます。 ログファイルは追加モードでオープンされるので、 以前のメッセージは削除されません。 このオプションは主にデバッグ用の設定の場合に役に立ちます。
--syslog オプション (キーワード: set syslog) を使うと、 可能であれば、発生した状態メッセージとエラーメッセージを syslog(3) システムデーモンに送ります。 メッセージは fetchmail の ID, LOG_MAIL の機能、 LOG_ERR, LOG_ALERT, LOG_INFO いずれかの優先度と一緒に記録されます。 このオプションは、サーバからメールを取得している間のデーモンの状態と 結果を示す状態メッセージとエラーメッセージを記録するためのものです。 この場合でも、コマンドラインオプションと .fetchmailrc の処理に対する エラーメッセージは標準エラー出力か指定されたログファイルに書かれます。 --nosyslog オプションは、これが ~/.fetchmailrc 内で有効にされているか、 -L <ファイル名> または --logfile <ファイル名> オプションが使われているものとして syslog(3) の使用を無効にします。
-N または --nodetach オプションは、デーモンプロセスの制御端末からの バックグラウンド化や切り離しを止めます。 これは主にデバッグ時に有効です。 このオプションは logfile オプションも無効にしてしまう点に注意してください (たぶんこれではいけないのですが)。
デーモンモードで動作して POP2 や IMAP2bis サーバに対して ポーリングしている時には、 一時的エラー (DNS 参照失敗や sendmail の配送拒否など) が起こると 次のポーリング周期の間には fetchall オプションが有効となります。 これは頑健さを実現する機能です。 つまり、メッセージを取得できた (そしてメールサーバでは既読の印が付けられた) けれど、 一時的エラーのためにローカルでは配送されなかった場合、 そのメールは次のポーリング周期のときに再び取得されます。 (IMAP の仕組みではメッセージは配達されるまで消去されません。 したがって、このような問題は起こりません。)
fetchmail がデーモンモードで動作している時に ~/.fetchmailrc ファイルを touch したり変更すると、これは次回のポーリングが始まる時に 検出されます。 ~/.fetchmailrc の変更が検出されると、fetchmail はこのファイルを読み込み直し、 自分自身を最初から起動し直します (exec(2) を使います。 新しく動作する fetchmail には、状態に関するそれまでの情報は一切残りません)。 ~/.fetchmailrc ファイルの文法に違反していると、 新しい fetchmail は起動時に黙って静かに消えてしまうでしょう。
--postmaster <ユーザ名> オプション (キーワード: set postmaster) は、 ローカルでメールを受け取る適切なユーザが見つからなかった場合に、 マルチドロップメールが転送される最終地点になるユーザ名を指定します。 通常、これは単に fetchmail を起動したユーザです。 起動したユーザが root であれば、 このオプションのデフォルト値はユーザ `postmaster' になります。 postmaster のユーザ名を空の文字列に設定すると、このようなメールは破棄されます。
--nobounce オプションは、RFC1894 準拠のエラーメッセージのうち、 送信者に戻される差戻しエラー (bouncing error) の通常の動作を止めます。 nobounce が有効な場合、メッセージは送信者ではなく postmaster に送られます。
--invisible オプション (キーワード: set invisible) は fetchmail を見えなくしようとします。 通常、fetchmail は他の MTA と同じように振舞います。 つまり、送信の経路が記述されている Received ヘッダをメッセージ全てに書き込み、 転送先の MTA に、fetchmail そのものが実行されているマシンから メールが来たことを知らせます。 invisible オプションが有効である場合は、 Received ヘッダは付けられず、fetchmail は転送先の MTA をだまして、 メールがメールサーバのホストから直接届いたと思わせようとします。
--showdots オプション (キーワード: set showdots) は、 たとえ現在の端末 (tty) が標準出力でない場合 (例えばログファイルの場合) でも、進捗状況を表すドットを表示する。 fetchmail バージョン 5.3.0 を起動した場合、 デフォルトでは進捗状況を表すドットは標準出力にしか表示されません。
--tracepolls オプションを指定することにより、fetchmail に対して "polling {label} account {user}" という形式の情報を Received ヘッダに加えるように指示することができます。 ここで、{label} は (指定された設定ファイル、 通常は ~/.fetchmailrc での) アカウントラベルです。 また、{user} はメールサーバにログオンするためのユーザ名です。 このヘッダは、役立つヘッダ情報のない E メールをフィルタリングしたり、 アカウント毎のメールを別々のメールボックスに ソートして入れるのに使うことができます (例えば、メーリングリストが運営されているサーバにアカウントがあり、 そのアカウントを使ってメーリングリストを購読している場合に 使うことができます)。 デフォルトでは、このようなヘッダは追加されません。 これは .fetchmailrc では `tracepolls' というキーワードになります。
しかし、MDA に転送する時には、エラーの可能性はずっと高くなります MDA のなかには「安全」なものもあり、 配送エラーの場合や一時的なリソース資源を使い果たした場合にも、 0 以外のステータスを必ず返してくれます。 有名な procmail(1) プログラムは、このような動作をします。 sendmail(1) や exim(1) のようなメール転送エージェントとしてデザインされた大部分のプログラムも、 このような動作をします。 これらのプログラムは信頼できる積極的な返答を返してくれるので、 メールを失うリスクを負うことなく、 mda オプションをつけて使うことができます。 しかし安全でない MDA では、配送が失敗した場合でも 0 を返します。 このような事が起これば、メールがなくなるでしょう。
fetchmail の通常モードは、 「新しい」メッセージだけをダウンロードしようとし、 サーバから既に直接読み出した (あるいは、以前に fetchmail --keep を使って受け取った) メールには関与しません (削除もしません)。 しかし、--all を指定していない場合でさえ、サーバ上にある 既読のメールが取得される (そして削除される) ことがあることに お気づきになるでしょう。 このようなことが起こる理由はいくつかあります。
まず POP2 を使っている場合が考えられます。 POP2 プロトコルには、メッセージの「新規」や「既読」の状態を 表現する方法がありません。 したがって、fetchmail は必ず全てのメッセージを 新しいものとして扱わなければなりません。 しかし、POP2 は古くて使われなくなっているので、 これが原因のことはあまりないでしょう。
POP3 の場合には、RFC1725 を恨んでください。 このバージョンの POP3 プロトコルの仕様では LAST コマンドが無くなっているのですが、 一部の POP サーバがこれに準拠しているのです (これを調べるには、メールサーバに対して fetchmail -v を実行して、 問い合わせの最初の方で行われる LAST コマンドへの応答を見てください)。 fetchmail のコードでは POP3 の UID 機能を使って埋め合わせをしようとしています。 これは、それぞれのセッションで見たメッセージの識別子を、 次のセッションまで .fetchids に保存しておくという方法です。 しかしこの方法では、他のクライアントで見たメッセージや、 ホスト上のメーラで直接読まれたけれど その後で消されていないメッセージまでは追いかけられません。 IMAP に乗り換える方がいいでしょう。
他に起こる可能性がある POP3 の問題として、 メールボックスの途中にメッセージを挿入するサーバが考えられます (VMS のメールの実装の一部に、このようなものがあると言われています)。 fetchmail のコードでは、 新しいメールはメールボックスの最後に追加されることを想定しています。 これが成り立っていなければ、 古いメッセージの一部が新しいものとして扱われることがありますし、 その逆も起こります。 この問題を真っ当に解決する唯一の方法は、IMAP に乗り換えることです。
POP3 の別の問題として、 ユーザのホームディレクトリに一時ファイルが作成できない場合に、 一部の POP3 サーバは文書化されていない応答を返すため、 fetchmail が間違って「No mail」と報告してしまうことがあります。
IMAP のコードでは、サーバ上の \Seen の有無を使って メッセージが新しいかどうかを決めています。 Unix の場合、fetchmail は IMAP サーバがメールユーザエージェントが設定した BSD 形式の Status フラグに注目し、 適当な時にこれらを使って \Seen フラグを設定することを期待します。 これは IMAP の RFC の仕様にはありませんが、 我々が知る限りの Unix 用 IMAP サーバは全てこれを行います。 これを行わないサーバでつまずいたときには、 ホスト上の既読のメッセージが サーバには新しく見えると言った症状が現われるでしょう。 この場合 (あまり起こりませんが) には、fetchmail --keep で 取得したメッセージだけが消されず、かつ既読の印が付けられます。
ETRN と ODMR モードでは、fetchmail は実際にはメールを取得しません。 その代わりに、サーバの SMTP リスナに対して、 クライアントに SMTP 経由のキューのフラッシュを開始するように指示します。 したがって、未配送のメッセージしか送りません。
最近のバージョンの sendmail はエラーコード 571 を返します。 この返し値は RFC1893 によって "Delivery not authorized, message refused" として与えられています。
RFC821 から置き換えられた現在のドラフトによると、 このような状況で返すべき正しい値は、 550 "Requested action not taken: mailbox unavailable" とされています (このドラフトでは "[E.g., mailbox not found, no access, or command rejected for policy reasons]." を追加しています)。
exim という MTA は 501 "Syntax error in parameters or arguments" を返しますが、 これはもうすぐ 550 に変更されます。
postfix という MTA はスパム拒否の応答として 554 を返します。
fetchmail のコードは応答のリストのいずれかに該当するメッセージを 認識・破棄します。 このリストはデフォルトでは [571, 550, 501, 554] ですが、 `antispam' オプションを使って設定することができます。 fetchmail がメールを破棄してしまう状況は 3 つしか ありませんが、これはそのうちの 1 つです (残りは後述の 552, 553 エラーの場合と、 マルチドロップされたメッセージで 既に処理されているメッセージ ID を持つものを破棄する場合です)。
fetchmail が IMAP サーバからメールを取得する場合に antispam の応答が検出されると、 antispam ヘッダを取得した後、メッセージ本体を読むことなく 即座にメッセージを拒否します。 したがって、spam メッセージの本体をダウンロードする分の 課金を支払うことはありません。
spambounce オプションが有効になっている場合に、 メールがスパム防御を受けると、差出人にメールを受け取らなかったことを知らせる RFC1892 の差戻しメッセージが送られます。
他のエラーでは、差出人に差戻しメールが送られます。
パスワードの機密を守るため、--version オプションが有効でない場合には、 ~/.fetchmailrc のパーミッションは 600 (u=rw,g=,o=) でなければなりません。 600 以外の場合には、 fetchmail は、エラー出力を行って終了します。
fetchmail が引き数なしで実行される場合、.fetchmailrc ファイルは実行される コマンドのリストとして読むことができます。
コメントは '#' で始まり、その行の最後まで続きます。 そうでない場合、このファイルは フリーフォーマットかつトークン指向の文法で書かれた、 一連のサーバエントリか動作全体のオプションの記述で構成されます。
トークンには 4 種類あります: すなわち、文法キーワード、数字 (つまり10進数を並べたもの)、 クォートされていない文字列、クォートされた文字列です。 クォートされた文字列はダブルクォートで囲まれ、空白文字を含むことができます (クォートされた数値は文字列として扱われます)。 クォートされていない文字列は、空白で区切られる任意のトークンであり、 数値やクォートされた文字列でなく、 特殊文字 `,', `;', `:', `=' も含まないものです。
任意の数の空白文字はサーバエントリ中のトークンを区切りますが、 それ以外には無視されます。 標準の C 言語形式のエスケープ文字 (\n, \t, \b, 8進数, 16進数) を用いて 表示不可能な文字列や文字列の区切り文字を文字列中に埋め込むことができます。
各サーバエントリは、キーワード `poll' または `skip'、 これに続くサーバ名、その後に続くサーバオプション、 さらにその後に続く任意の数のユーザ記述から構成されます。 注意: 一番起こしやすい文法エラーの原因は、 ユーザオプションとサーバオプションを混ぜてしまうことです。
後方互換性のため、キーワード `server' は `poll' と同義になります。
英語に似せるため、ノイズワード `and', `with', `has', `wants', `options' を エントリ中の任意の場所で使うことができます。 これらは無視されますが、エントリがずっと読みやすくなります。 区切り文字 ':', ';', ',' も同じく無視されます。
正式な動作全体のオプションを以下に示します:
| キーワード | オプション | 機能 |
|
|
||
| set daemon | バックグラウンドでのポーリング間隔を秒数で設定します。 |
|
| set postmaster | 最終的なメール受取人の名前を指定します。 |
|
| set no bouncemail | 送信者ではなく、postmaster にエラーメールを送ります。 |
|
| set no spambounce | スパム防御を受けたときに差戻しメールを送ります。 |
|
| set logfile | エラーメッセージと状態メッセージを書き込むファイル名 |
|
| set idfile | UID リストを格納するファイル名。 |
|
| set syslog | syslog(3) を使ったエラーのログ取得を行います。 |
|
| set nosyslog | syslog(3) を使ったエラーのログ取得を止めます。 |
|
| set properties | fetchmail が無視する文字列の値 (拡張スクリプトが使うことがあります)。 |
|
以下の正式なサーバオプションを示します:
| キーワード | オプション | 機能 |
|
|
||
| via | メールサーバの DNS 名を指定します。 これは poll 名を上書きします。 |
|
| proto[col] | -p | プロトコルを指定します (大文字・小文字は関係ありません): POP2, POP3, IMAP, APOP, KPOP。 |
| local[domains] | ローカルとして扱うドメインを指定します。 |
|
| port | -P | TCP/IP のサービスポートを指定します。 |
| auth[enticate] | 認証のタイプを設定します (デフォルト値は `password')。 |
|
| timeout | -t | サーバが動作していない時のタイムアウト値を秒数で指定します (デフォルト値は 300)。 |
| envelope | -E | エンベロープアドレスのヘッダ名を指定します。 |
| no envelope | エンベロープアドレスの検索を無効にします。 |
|
| qvirtual | -Q | ユーザ名から取り除く、qmail のバーチャルドメインのプレフィックス。 |
| aka | メールサーバの別の DNS 名 |
|
| interface | -I | サーバへのポーリングを行うためには立ち上がっていなければならない IP インタフェースを指定します。 |
| monitor | -M | 動作を監視する IP アドレスを指定します。 |
| plugin | サーバ接続を確立するためのコマンドを指定します。 |
|
| plugout | リスナ接続を確立するためのコマンドを指定します。 |
|
| dns | マルチドロップ用の DNS 参照を有効にします (デフォルト)。 |
|
| no dns | マルチドロップ用の DNS 参照を無効にします。 |
|
| checkalias | マルチドロップのために IP アドレスによる比較を行います。 |
|
| no checkalias | マルチドロップのために名前による比較を行います (デフォルト)。 |
|
| uidl | -U | POP3 で必ずクライアント側で UIDL を使うようにします。 |
| no uidl | POP3 での UIDL の使用を止めます (デフォルト)。 |
|
| interval | このサイトだけを N ポーリングサイクル毎にチェックします。 N は数値の引き数です。 |
|
| netsec | IPsec セキュリティオプション要求を渡します。 |
|
| principal | Kerberos 認証の principal を設定します (imap と kerberos の場合にのみ有効です)。 |
|
正式なユーザオプションを以下に示します:
| キーワード | オプション | 機能 |
|
|
||
| user[name] | -u | リモートのユーザ名を設定します (name の後に `here' があると、ローカルのユーザ名です)。 |
| is | ローカルとリモートのユーザ名を繋ぎます。 |
|
| to | ローカルとリモートのユーザ名を繋ぎます。 |
|
| pass[word] | リモートアカウントのパスワードを指定します。 |
|
| ssl | SSL による暗号化を使い、 指定された基本プロトコルを使ってサーバと接続します。 |
|
| sslcert | クライアント側の公開 SSL 証明書を指定します。 |
|
| sslkey | クライアント側の秘密 SSL 鍵を指定します。 |
|
| sslproto | 接続のために ssl プロトコルを使わせます。 |
|
| folder | -r | 問い合わせをするリモートのフォルダを指定します。 |
| smtphost | -S | 転送先の SMTP ホスト (群) を指定します。 |
| fetchdomains | メールを取得するドメインを指定します。 |
|
| smtpaddress | -D | RCPT TO 行に書くドメインを指定します。 |
| smtpname | RCPT TO 行に書くユーザとドメインを指定します。 |
|
| antispam | -Z | スパム防御と解釈される SMTP の返し値を指定します。 |
| mda | -m | ローカルの配送に使う MDA を指定します。 |
| bsmtp | -o | 追加する BSMTP バッチファイルを指定します。 |
| preconnect | それぞれの接続の前に実行するコマンド。 |
|
| postconnect | それぞれの接続の後に実行するコマンド。 |
|
| keep | -k | 既読のメッセージをサーバから削除しません。 |
| flush | -F | 問い合わせの前に既読のメッセージを全てフラッシュします。 |
| fetchall | -a | 既読・未読にかかわらず全てのメッセージを取得します。 |
| rewrite | リプライのために目的アドレスを書き換えます (デフォルト)。 |
|
| stripcr | 行末からキャリッジリターン文字を取り除きます。 |
|
| forcecr | 行末にキャリッジリターン文字を強制します。 |
|
| pass8bits | ESMTP リスナに対し、BODY=8BITMIME を強制します。 |
|
| dropstatus | やってくるメールから Status 行と X-Mozilla-Status 行を取り除きます。 |
|
| dropdelivered | やってくるメールから Delivered-To 行を取り除きます。 |
|
| mimedecode | quoted-printable を 8ビットの MIME 形式のメッセージに変換します。 |
|
| idle | 各ポーリングの後、新しいメッセージを待つアイドル時間 (IMAP 専用)。 |
|
| no keep | -K | 既読のメッセージをサーバから削除します (デフォルト)。 |
| no flush | 問い合わせの前に既読メッセージ全てはフラッシュしません (デフォルト)。 |
|
| no fetchall | 新規メッセージだけを取得します (デフォルト)。 |
|
| no rewrite | ヘッダを書き換えません。 |
|
| no stripcr | キャリッジリターン文字を取り除きません (デフォルト)。 |
|
| no forcecr | 行末にはキャリッジリターン文字を強制しません (デフォルト)。 |
|
| no pass8bits | ESMTP リスナに BODY=8BITMIME を強制しません (デフォルト)。 |
|
| no dropstatus | Status ヘッダを捨てません (デフォルト)。 |
|
| no mimedecode | quoted-printable を 8 ビット MIME 形式の メッセージには変換しません (デフォルト)。 |
|
| limit | -l | メッセージのサイズの上限を設定します。 |
| warnings | -w | メッセージサイズに関する警告の時間間隔を設定します。 |
| batchlimit | -b | 1 回の接続で転送するする最大メッセージ数。 |
| fetchlimit | -B | 1 回の接続で取得する最大メッセージ数。 |
| expunge | -e | 何回目のメッセージごとに削除を実行するかを指定します (IMAP と POP3 専用)。 |
| tracepolls | ポーリングトレース情報を Received ヘッダに追加します。 |
|
| properties | fetchmail が無視する文字列値 (拡張スクリプトで使うことができます)。 |
|
ユーザオプションは全てサーバオプションより後でなければいけません。
.fetchmailrc においては、`envelope' 文字列引き数の前に、 (空白で区切って) 数値を置くことができます。 この数字が指定された場合、この値はこのようなヘッダを飛ばす数です (つまり、この引き数に 1 を指定すると、 与えられたタイプの 2 番目のヘッダが選択されます)。 これは、ISP のローカルの配送エージェントが付けた 偽の Received ヘッダを無視する時に便利です。
`folder' と `smtphost' オプションには (同等のコマンドラインオプションとは異なり)、 空白区切りまたはコンマ区切りの名前のリストを続けることができます。
全てのオプションは、見た通りのコマンドライン引き数に対応しますが、 以下のものはこれに該当しません: `via', `interval', `aka', `is', `to', `dns'/`no dns', `checkalias'/`no checkalias', `password', `preconnect', `postconnect', `localdomains', `stripcr'/`no stripcr', `forcecr'/`no forcecr', `pass8bits'/`no pass8bits' `dropstatus/no dropstatus', `dropdelivered/no dropdelivered', `mimedecode/no mimedecode', `idle/no idle', `no envelope'.
`via' オプションは 同じサイトを指す複数の設定を使うためのものです。 これがある場合、文字列引き数は問い合わせ先の メールサーバの実際の DNS 名として扱われます。 これは poll 引き数を上書きし、これを設定を区別する単なるラベル (例えば、このホストを明示的に指定する時にコマンドラインで指定するもの) にすることができます。
`interval' オプション (数値の引き数を取ります) を使うと、 基本的なポーリング間隔より少ない頻度で サーバにポーリングを行わせることができます。 `interval N' を指定すると、このオプションが割り当てられた サーバに対する問い合わせは N 回ごとのポーリング間隔でしか行われません。
`is' または `to' キーワードは、その後に続くローカル (クライアント) 名 (または、= で区切られるサーバ名からクライアント名へのマッピング) を エントリ中のメールサーバのユーザ名と関連付けます。 is/to のリストの最後の名前に `*' があれば、認識されない名前もそのまま通します。
1 つのローカル名を使って、クライアントマシンでのユーザ名が メールサーバ上の名前と異なる時に、 メールのリダイレクトをサポートすることができます。 ローカル名が一つしかないときは、 メッセージの Received, To, Cc, Bcc ヘッダに関らず、 メールはローカルのユーザ名宛に転送されます。 この場合には、 fetchmail は DNS の参照を行いません。
ローカル名 (または名前マッピング) が複数ある時には、 fetchmail のコードは取得したメールの Received, To, Cc, Bcc ヘッダを参照します (これが「マルチドロップモード (multidrop mode)」です)。 fetchmail は poll 名、`via', `aka', `localdomains' オプションの いずれかにマッチする、ホスト部分を持つアドレスを探し、 また DNS で調べるとメールサーバのエイリアスであるホスト名部分も通常は探します。 アドレスのマッチングの処理方法の詳しい内容については、 `dns', `checkalias', `localdomains', `aka' の説明を参照してください。
fetchmail がメールサーバのユーザ名にも ローカルドメインにもマッチさせられない場合には、メールは差し戻されます。 このメールは通常、差出人に戻されますが、 `nobounce' オプションが有効ならば、これは postmaster に送られます (次に、これはデフォルトで fetchmail を呼び出したユーザになります)。
`dns' オプション (通常は有効) は、マルチドロップメールボックスから取り出した アドレスをチェックする方法を制御します。 このオプションが有効の時には、DNS を使った参照を行なうことにより、 `aka' または `localdomains' の宣言にマッチしないホストそれぞれのアドレスを チェックするロジックが有効になります。 メールサーバのユーザ名が、 マッチするホスト名部分に割り当てられていることが認識された時、 そのローカルマッピングがローカルの受信者のリストに追加されます。
`checkalias' オプション (通常は無効) は、 マルチドロップモードの `dns' キーワードが実行した検出結果を拡張し、 エイリアスを使ってポーリングされるものの、 自分自身を識別するにはカノニカルな名前 (canonical name) を用いる リモートの MTA をうまく扱う方法を提供します。 このようなサーバがポーリングされたときは、 envelope アドレスが展開されたことのチェックは失敗し、 fetchmail は To/Cc/Bcc ヘッダを使った配送に戻ります (後述の「ヘッダ対 envelope アドレス」を参照してください)。 このオプションを指定すると、 fetchmail に対する、 poll 名とリモートの MTA が使う名前の両方に関係する全ての IP アドレスを取得し、 これらの IP アドレスの比較を行うことの指示になります。 これは、リモートサーバのカノニカルな名前が頻繁に変わる状況で役に立ちます。 これを使わなければ、実行制御ファイルを変更する必要があります。 実行制御ファイルで `no dns' が指定された場合は、`checkalias' は無効です。
`aka' オプションはマルチドロップメールボックスと一緒に使うためのものです。 このオプションを使うと、サーバの DNS 的な別名のリストを 予め宣言しておくことができます。 これは、速度と容量のトレードオフを可能にする、最適化のためのハックです。 マルチドロップメールボックスを処理している間に、 fetchmail がメッセージのヘッダを使ったメールサーバの名前の検索をあきらめた時、 予め宣言してある共通の名前を使うと、DNS を参照するはめにならないで済みます。 `aka' の引き数として与えた名前は、 拡張子としてマッチされる点に注意してください -- 例えば `aka netaxs.com' を指定した場合、 単に netaxs.com という名前のホストにはマッチしませんが、 pop3.netaxs.com や mail.netaxs.com といった `.netaxs.com' で終る任意のホスト名にマッチします。
`localdomains' オプションを使うと、ローカルであると fetchmail が判断する ドメインのリストを宣言することができます。 fetchmail がマルチドロップモードでアドレス行を展開し、 かつ後に続くホスト名の部分が宣言されたローカルドメインにマッチする時、 そのアドレスは変更されずにリスナまたは MDA に渡されます (ローカル名マッピングは適用されません)。
`localdomains' を使っている場合には、 `no envelope' も指定する必要があるかもしれません。 このオプションは、fetchmail の通常の、 Received 行や X-Envelope-To ヘッダ、 あるいは以前に `envelope' で設定されたヘッダの いずれかから envelope アドレスを推定しようとする動作を無効にします。 デフォルトのエントリ中で `no envelope' を設定した場合、 `envelope <string>' を用いて個別エントリ中でこれを取り消すことが可能です。 特別な場合として、`envelope "Received"' で Received 行の展開の デフォルトの動作が復元されます。
password オプションは文字列の引き数を必要とします。 この文字列はエントリのサーバで使うパスワードです。
`preconnect' キーワードを使うと、 fetchmail がメールサーバへの接続を確立する直前に毎回実行する シェルコマンドを指定することができます。 これは、 ssh(1) に補助させて安全な POP 接続の設定をしようとする時に役に立つかもしれません。 コマンドがゼロでないステータスを返した場合、 そのメールサーバへのポーリングは異常終了します。
同様に、`postconnect' キーワードを使うと、メールサーバへの接続が切れた 直後に毎回実行するシェルコマンドを指定することができます。
`forcecr' オプションは、LF だけで終わる行を転送の前に CRLF で終わるようにするかどうかを制御します。 厳密に言うと RFC821 はこれを要求しているのですが、 これを必須としている MTA はほとんどないので、 このオプションは通常は無効になっています (このような MTA で特に使われているのは qmail だけで、 書き込み時にこれを行います)。
`stripcr' オプションは、取得したメールを転送する前に キャリッジリターン文字を取り除くかどうかを制御します。 通常はこれをセットする必要はありません。 なぜなら、MDA が宣言されているときには、 これはデフォルトで「オン」(CR 削除が有効) となり、 SMTP 経由で転送されるときには「オフ」(CR 削除が無効) となるからです。 `stripcr' と `forcecr' が両方ともオンならば、`stripcr' が優先されます。
`pass8bits' は、何にでも "Content-Transfer-Encoding: 7bit" を付けてくる 馬鹿な Microsoft のメーラをうまく扱うために存在します。 このオプションが無効 (デフォルト) で、かつこのヘッダが存在すると、 fetchmail は ESMTP 機能を持つリスナに対して BODY=7BIT を宣言します。 実際には 8-bit ISO や KOI-8 の文字集合を使っているメッセージの場合、 これは問題を起こします。 これらの文字は上位ビットが全て落とされてしまうため、 文字化けしてしまいます。 `pass8bits' がオンであれば、 fetchmail は ESMTP 機能を持つリスナ全てに対して必ず BODY=8BITMIME を宣言します。 リスナが 8 ビットクリーンであれば (最近のめぼしいものは全部そうです)、 たぶんうまくいくでしょう。
`dropstatus' オプションは、取得したメール中の空でない Status 行と X-Mozilla-Status 行を残す (デフォルト) か破棄するかを制御します。 これらを残すと、お使いの MUA で (もしあれば) どのメッセージがサーバ上で既読の印が付けられているかを知ることができます。 一方、この動作は新着メール通知プログラムの一部を混乱させることがあります。 これらのプログラムは、 Status 行が付いているものは全て既読と想定するのです。 (注意: 一部のバグっぽい POP サーバが付ける 空の Status 行は無条件に削除されます。)
`dropdelivered' オプションは、取得したメール中の Delivered-To ヘッダを残す (デフォルト) か破棄するかを制御します。 このヘッダは、メールサーバ Qmail と Postfix が ループを防止するために使用していますが、 同じドメイン内でメールサーバを「ミラー」しようとする場合は邪魔になります。 このオプションは、注意して使用して下さい。
`mimedecode' オプションは、quoted-printable エンコーディングを用いている MIME メッセージを純粋な 8 ビットデータに自動的に変換するかどうかを制御します。 ESMTP 機能を持ち、8 ビットクリーンなリスナ (これには sendmail などの有名な MTA の大部分が含まれます) に メールを配送する場合には、 このオプションを使うと quoted-printable で書かれた メッセージヘッダとデータは自動的に 8 ビットデータに変換され、 メールを読むときに理解しやすくなります。 お使いの電子メールプログラムが MIME メッセージを扱えるならば、 このオプションは必要ありません。 mimedecode オプションはデフォルトで無効になっています。 なぜなら、ヘッダに対して RFC2047 の変換を行うと文字集合の情報が消えてしまい、 ヘッダのエンコーディングが本文のエンコーディングと異なる場合に 好ましくない結果になるからです。
`idle' オプションは IMAP サーバが RFC2177 IDLE コマンド拡張を サポートしている場合にのみ使用できます。 このオプションが設定されていて、 かつ IDLE コマンドをサポートしていることを fetchmail が検知した場合、 ポーリングの終了毎に IDLE コマンドが発行されます。 このコマンドを使うことで、 IMAP サーバに接続をオープンに保持させ、 新しいメールが来たことをクライアントに通知させます。 頻繁にポーリングを行う必要がある場合、 IDLE コマンドは、TCP/IP 接続とログイン/ログアウトシーケンスをなくすことで、 バンド幅を押えることができます。 一方で、IDLE 接続は fetchmail のほとんどの時間を占めてしまいます。 なぜなら、IDLE コマンドは接続を切らず、 サーバが IDLE をタイムアウトしない限り 別のプールが起こることを許可してしまうためです。 複数のフォルダがある場合も動作せず、 最初のフォルダのみがポーリングされます。
`properties' オプションは拡張のための機構です。 これは文字列の引き数を取りますが、fetchmail 自身はこれを無視します。 この文字列引き数を使って、 設定情報を必要とするスクリプトのための情報を保持することができます。 特に、`--configdump' オプションの出力は、 そのまま Python スクリプトとして利用できる、 ユーザエントリに関連するプロパティとなります。
`protocol' キーワードで使用できる有効なプロトコル識別子を以下に示します:
auto (または AUTO)
pop2 (または POP2)
pop3 (または POP3)
sdps (または SDPS)
imap (または IMAP)
apop (または APOP)
kpop (または KPOP)
有効な認証のタイプは `any', `password', `kerberos', 'kerberos_v5', `gssapi', `cram-md5', `otp', `ntlm', `ssh` です。 `password' タイプは普通のパスワード送信による認証を指定します (パスワードはプレーンテキストのこともあれば、 APOP のようにプロトコル固有の暗号化がされていることもあります)。 `kerberos' を指定するとパスワード認証は行われず、 fetchmail はそれぞれの問い合わせの開始時に Kerberos のチケットを取得し、 パスワードとして任意の文字列を送信しようとします。 `gssapi' を指定すると fetchmail は GSSAPI 認証を使います。 さらに詳しい情報については `auth' キーワードの説明を参照してください。
`kpop' を指定すると、1109 番ポート上で Kerberos V4 認証を使う POP3 プロトコルが設定されます。 これらのデフォルト値は、後に現われるオプションによって上書きされます。
グローバルオプションを指定する文は現在 4 つあります。 `set logfile' の後に文字列を記述したものは、 --logfile オプションの指定と同じグローバルな設定を行います。 コマンドラインの --logfile はこれを上書きします。 また `set daemon' は、--daemon オプションと同じように ポーリング間隔を設定します。 これはコマンドラインの --daemon オプションで上書きすることができます。 特例として、--daemon 0 を使って、 強制的にフォアグラウンド動作をさせることができます。 `set postmater' 文は、ローカルで一致するものがない場合に マルチドロップメールがデフォルトで送られるアドレスを設定します。 最後に、`set syslog' を指定するとログメッセージが syslogd(8) に 送られるようになります。
Return-Path:
Resent-Sender: (@ または ! を含んでいない場合は無視される)
Sender: (@ または ! を含んでいない場合は無視される)
Resent-From:
From:
Reply-To:
Apparently-From:
送信アドレスはログの記録と、 SMTP に転送する時の MAIL FROM アドレスの設定のために使われます。 この順序はマルチドロップモードでメーリングリストの受信を うまく処理するためのものです。 その目的は、ローカルアドレスが存在しない場合に、 差し戻しメッセージがメールを出した人やメーリングリスト本体にむやみに返されず、 メーリングリストの管理者に届くようにすることです (こちらの方がまだマシです)。
マルチドロップモードでは、宛先のヘッダは以下のように処理されます: 最初に、fetchmail は Received: ヘッダ (あるいは、`envelope' で指定した任意のヘッダ) を探し、 ローカルの受信者アドレスを決めます。 もしメールが複数の受信者に宛てたものであれば、 Received は受信者のアドレスという点では全く情報を持っていないでしょう。
次に、fetchmail は Resent-To:, Resent-Cc:, Resent-Bcc: 行を探します。 これらのヘッダが存在する場合、これらには最終的な受信者が書かれており、 対になっている To:/Cc:/Bcc: よりも優先されます。 もし Resent-* 行が存在しなければ、 To:, Cc:, Bcc:, Apparently-To: 行が探されます。 (Resent-To: があると、To: アドレスが指している人物は 既にそのメールのコピーを受け取っているものと考えられます。)
基本フォーマットを以下に示します:
poll SERVERNAME protocol PROTOCOL username NAME password PASSWORD
例:
poll pop.provider.net protocol pop3 username "jsmith" password "secret1"
省略形を使えるものもあります:
poll pop.provider.net proto pop3 user "jsmith" password "secret1"
複数のサーバを並べることができます:
poll pop.provider.net proto pop3 user "jsmith" pass "secret1" poll other.provider.net proto pop2 user "John.Smith" pass "My^Hat"
上記の 2 つの例について、空白文字とノイズワードをいくつか増やしたもの を示します:
poll pop.provider.net proto pop3
user "jsmith", with password secret1, is "jsmith" here;
poll other.provider.net proto pop2:
user "John.Smith", with password "My^Hat", is "John.Smith" here;
こう書いた方がずっと読みやすいですが、処理の手間はそんなにかかりません (起動時に一度行われるだけです)。
パラメータ文字列に空白文字を含める必要がある場合には、 文字列をダブルクォートで囲みましょう。 以下のような形です:
poll mail.provider.net with proto pop3:
user "jsmith" there has password "u can't krak this"
is jws here and wants mda "/bin/mail"
最初のサーバ記述では、名前の前にキーワード `poll' ではなく、 キーワード`defaults' を置くことができます。 このようなレコードは、 全ての問い合わせで使われるデフォルト値として解釈されます。 これは個別のサーバ記述で上書きすることができます。 つまり、以下のように書くことができます:
defaults proto pop3
user "jsmith"
poll pop.provider.net
pass "secret1"
poll mail.provider.net
user "jjsmith" there has password "secret2"
サーバごとに複数のユーザを指定することもできます (これが役に立つのは多分、 root がデーモンモードで fetchmail を実行するときだけでしょう)。 1 人のユーザ記述は `user' キーワードで始まり、 ユーザエントリが複数ある場合には、 このキーワードがユーザ指定それぞれに含まれていなければなりません。 以下に例を示します:
poll pop.provider.net proto pop3 port 3111
user "jsmith" with pass "secret1" is "smith" here
user jones with pass "secret2" is "jjones" here keep
これは、ローカルのユーザ名 `smith' を the pop.provider.net のユーザ名 `jsmith' に対応させ、 ローカルのユーザ名 `jjones' を pop.provider.net のユーザ名 `jones' に対応させます。 `jones' のメールはダウンロード後もサーバーに残されます。
マルチドロップメールボックス用の取得を行う簡単な設定がどんな感じかを 以下に示します:
poll pop.provider.net:
user maildrop with pass secret1 to golux 'hurkle'='happy' snark here
これは、サーバ上のアカウント `maildrop' がマルチドロップボックスであり、 その中のメッセージはサーバのユーザ名 `golux', `hurkle', `snark' に対して 展開するという指定です。 これはさらに、`golux' と `snark' はクライアントでも サーバと同じ名前を持つけれど、 サーバのユーザ `hurkle' 宛のメールは クライアントのユーザ `happy' に配送することも指定します。
別の種類のマルチドロップ接続の例を示します:
poll pop.provider.net localdomains loonytoons.org toons.org:
user maildrop with pass secret1 to * here
これも、サーバ上のアカウント `maildrop' が マルチドロップボックスであることを指定します。 これは fetchmail に対し、 loonytoons.org や toons.org ドメイン内のアドレス全て (`joe@daffy.loonytoons.org' のようなサブドメインのアドレスも含みます) は 変更せずにローカルの SMTP リスナへ渡すことを指示します。 これを行うときにはメールのループには注意してください!
ssh と plugin オプションを用いた一つの設定例を示します。 問い合わせは、ssh を経由して、imapd の標準入力と標準出力で直接行われます。 この設定では IMAP 認証が飛ばされることに注意して下さい。
poll mailhost.net with proto imap:
plugin "ssh %h /usr/sbin/imapd" auth ssh;
user esr is esr here
また、マルチドロップモードでは複製されたメールは 消される点にも注意してください。 あるメールが複製されていると判断されるのは、 直前のメッセージと同じメッセージ ID が付いていて、 複数のアドレスが指定されている場合です。 このようにメッセージが連続することは、 複数のユーザ宛の 1 通のメールのコピーが 1 つのマルチドロップメールボックスに配送された時に起こります。
fetchmail が envelope アドレスを推定できることも時々あります。 メールサーバの MTA が sendmail であり、メールの受信者が 1 人しかいない場合、MTA は envelope アドレスを Received ヘッダに与える `by/for' の項を書いているでしょう。 しかし、これは他の MTA でも確実に動作するとは言えませんし、 複数の受信者がいる場合にも動作しません。 デフォルトでは、fetchmail はこれらの行で envelope アドレスを探します。 -E "Received" または `envelope Received' を指定すると 動作をこのデフォルトに戻すことができます。
これを行う代わりに、一部の SMTP リスナやメールサーバは、 envelope アドレスのコピーを持つヘッダを各メッセージに挿入します。 このヘッダは (存在するならば) `X-Envelope-To' のことがよくあります。 -E オプションまたは `envelope' オプションを用いると、 fetchmail が想定するヘッダを変更することができます。 この種類の envelope ヘッダを書くと、(ブラインドコピーの受信者も含めた) 全ての受信者の名前がメッセージ受信者に明らかになってしまいます。 したがって、これをセキュリティ/プライバシーの問題であると 考えるシステム管理者もいます。
`X-Envelope-To' を少し変えたものが、 qmail がメールのループを避けるために追加する `Delivered-To' ヘッダです。 これは、通常はユーザのドメインに マッチする文字列の前に、ユーザ名を置いたものであることが多いです。 このプレフィックスを取り除くには、 -Q または `qvirtual' オプションを使います。
残念ながら、これらが両方ともうまく動作しないこともあります。 これらが全て失敗した場合、fetchmail は To/Cc/Bcc ヘッダから出直して、 受信者のアドレスを決めなければなりませんが、これらのヘッダは信頼できません。 特に、メーリングリストのソフトウェアが リスト全体のアドレスしか To ヘッダに付けないでメールを送ることがよくあります。
fetchmail がローカルの受信者アドレスを推定できず、 かつ本来の受信者のアドレスが fetchmail を実行したユーザ以外である場合、 メールは無くなってしまうでしょう。 これがマルチドロップ機能を危険にしている要因です。
これに関連する問題は、メールのメッセージをブラインドコピーするとき、 Bcc 情報は envelope アドレスとしてのみ伝えられるということです (X-Envelope ヘッダがなければ、fetchmail が読めるヘッダには書かれません)。 したがって、メールサーバのホストが常に X-Envelope ヘッダあるいはこれと 同等のヘッダをメールドロップに入れるメッセージに書くようになっていなければ、 fetchmail 経由でメールを取得するユーザ宛のブラインドコピーは失敗します。
サーバでは、`fetchmail-friends' を `esr' に エイリアス設定することができます。 それから、.fetchmailrc では `to esr fetchmail-friends here'を宣言します。 すると、`fetchmail-friends' をローカルアドレスとして含んでいる メールが取得されたとき、 メーリングリストの名前が SMTP リスナが見ている受信者のリストに追加されます。 したがって、エイリアスの展開はローカルで行われます。 必ず、`esr' を fetchmail-friends のローカルのエイリアス展開に含めてください。 さもないと、このメーリングリストだけが宛先になっている メールを絶対に見ることができません。 また、リスナの「自分にも」というオプションを必ずセットして (sendmail では -oXm コマンドラインオプションか、OXm 宣言です)、 あなたが送ったメッセージのエイリアス展開から あなたの名前が削除されないようにしてください。
しかし、このトリックに問題がないわけではありません。 あなたがローカル名として宣言して いないメーリングリストだけが宛先になっているメールが来ると、 その問題が明らかになるでしょう。 このようなメッセージのそれぞれには、 `X-Fetchmail-Warning' ヘッダが付いています。 このヘッダは、fetchmail が受信者アドレス中で 有効なローカル名を見つけられなかったために生成されるものです。 このようなメッセージは、デフォルトで (既に述べたように) fetchmail を実行しているローカルユーザに送られますが、 それが本当に正しい処置なのかをプログラム側から知る方法はありません。
もし、 fetchmail を使って 1 つのメールドロップから POP や IMAP 経由で 複数ユーザ宛のメールを取得しようと考えているならば、考え直してください (そして、前述のヘッダと envelope アドレスに関する セクションを読み直してください)。 メールは単にメールサーバのキューに入れておき、 fetchmail の ETRN や ODMR モードを使って定期的に SMTP での送信を行わせる方が賢いやりかたでしょう (この場合はもちろん、メールサーバでのメールの有効期限よりも短い間隔で ポーリングをしなければならないことになります)。 このような設定ができないのならば、UUCP による配送を設定してみてください。
どうしてもこの目的でマルチドロップを使わなければならないのであれば、 fetchmail が参照できる envelope アドレスヘッダを メールサーバが書き込むように必ずしてください。 さもなくば、メールはきっと無くなってしまい、 あなたを呪うために帰ってくることになるでしょう。
これはとても安全ですが、非常に遅い方法です。 これを高速化するためには、 `aka' を使ってメールサーバのエイリアスを予め宣言してください。 これらは DNS の参照を行う前にチェックされます。 aka のリストがメールサーバの DNS エイリアス (および、これを指す全ての MX 名) を 全て 含んでいることが確かであれば、`no dns' を宣言して DNS 参照を完全に止め、 aka リストに対してのみマッチングを行わせることができます。
fetchmail が返す終了コードを以下に示します:
fetchmail が複数のホストに問い合わせを行う場合、 いずれかの問い合わせでメールをうまく取得できれば、 ステータス 0 が返されます。 そうでないに返されるエラーステータスは、 最後に問い合わせを行ったホストのステータスとなります。
環境変数 FETCHMAILHOME が 実際に存在する正しいディレクトリ名に設定されている場合、 ファイル .fetchmailrc, .fetchids, .fetchmail.pid は、 起動したユーザのホームディレクトリではなく、 この環境変数で指定したディレクトリに置かれます (ファイル名の先頭にあるドットは取り除かれます)。 .netrc ファイルは、FETCHMAILHOME の設定に関係なく、 起動したユーザのホームディレクトリでロックされます。
デーモンモード fetchmail が root 権限以外で動作している場合、 デーモンを起こすには SIGUSR1 を使います (logout による SIGHUP がデフォルトの動作をそのまま持ち、 fetchmail を kill するかもしれないためです)。
バックグラウンドで fetchmail が動作しているときに、フォアグラウンドで fetchmail を実行すると、上記のうち適切なデーモンが起こされます。
マルチドロップモードで使われている RFC822 アドレスのパーザは、 技術的には正しいけれどおかしな @-アドレスで詰まってしまうことがあります。 また、クォートと埋め込みコメントの使い方がおかしいと、 パーザの動作がおかしくなりやすいです。
メッセージに複数の envelope ヘッダがある場合、 fetchmail には最後に処理されたヘッダしか見えません。 これを回避するには、 envelope ヘッダの内容全てを 1 つのヘッダにまとめるフィルタ (procmail, mailagent, maildrop に手順を指示すれば、 これはかなり簡単に行えます) をメールサーバ側で使ってください。
プロトコルのうちのいくつかを使う場合には、 プログラムが暗号化されていないパスワードを メールサーバまで TCP/IP 接続上で送る必要があります。 これは、パケットスニファ (packet sniffer) や もっと高機能な監視ソフトウェアによって 名前とパスワードの組を盗まれる危険性の元となります。 Linux と FreeBSD の場合、--interface オプションを使うと、 特定のローカルまたはリモートの IP アドレスを持つ 特定のインタフェースデバイスに対してのみ ポーリングが可能であるように制限できますが、 その場合でも (a) どちらかのホストが 無差別モード (promiscuous mode) でオープンできる ネットワークデバイスを持っているか、 (b) 間にあるネットワーク接続が盗聴可能であれば盗聴は可能です。 パスワードを暗号化するだけでなく、全ての通信を暗号化するためにも、 ssh(1) トンネリングの使用をお勧めします。
mda オプションで %F, %T エスケープを使うとセキュリティホールができます。 なぜなら、これらのエスケープは攻撃者が操作できるテキストを シェルコマンドに渡すからです。 シェル文字になる可能性があるものは、実行の前に `_' に置換されます。 fetchmail は MDA を実行している間、 SUID により得ることができた権限を一時的に全て破棄するので、 このセキュリティホールはかなり小さくなっています。 しかし、できるだけ安全にするために、 fetchmail をroot のアカウントから実行するときには、 %F, %T を含むmda コマンドを使ってはいけません。
fetchmail における bouncemail と spambounce の出し方では、 ローカルホストの 25 番ポートで SMTP 経由のメールが送れなければなりません。
このプロセスをバックグラウンドで実行している時に ~/.fetchmailrc を修正し、文法を間違ってしまうと、 バックグラウンドのプロセスは何も言わずに終了してしまいます。 悪いことに、このプログラムは何かを書き出して終了することができません。 なぜなら、syslog を有効にすべき否かが、まだ分からないからです。
(設定を標準入力から読み込む) -f - オプションは、 プラグインオプションとは互換性がありません。
UIDL コードは一般的にあまり当てにならないもので、 行を飛ばした場合やエラーの場合に、コードの状態を失いやすい傾向があります (そのため、古いメッセージが再度閲覧されてしまいます)。 このような場合は、IMAP4 に乗り換えて下さい。
`principal' オプションは Kerberos IV しか扱わず、 Kerberos V は扱いません。
コメント、バグ報告、苦情の類は、fetchmail-friends メーリングリスト <fetchmail-friends@lists.ccil.org> に送ってください。 HTML 版の FAQ が fetchmail のホームページにあります。 http://www.tuxedo.org/~esr/fetchmail へ行くか、 `fetchmail' 関連のページを WWW で検索してください。
[man1]
[man2]
[man3]
[man4]
[man5]
[man6]
[man7]
[man8]
[a]
[b]
[c]
[d]
[e]
[f]
[g]
[h]
[i]
[j]
[k]
[l]
[m]
[n]
[o]
[p]
[q]
[r]
[s]
[t]
[u]
[v]
[w]
[x]
[y]
[z]