XLIII. IMAP,POP3,NNTP関数

導入

以下の関数は、その名前から連想されるようにIMAP プロトコルのみを扱うわけではありません。実装レベルのc-client ライブラリは、NNTP、POP3、ローカルなメールボックスのアクセスメソッドもサポートします。

要件

この拡張モジュールは、c-clientライブラリがインストールされていることを要します。ftp://ftp.cac.washington.edu/imap/から最新版を入手し、コンパイルして下さい。

いくつかのファイルをリンクパス(例: /usr/local/lib/)およびインクルードディレクトリ(例: /usr/local/include)にコピーする必要があります。コピーするべきファイルは、 make を実行した後に imap-200x/c-lient の下のソースツリーにあります。 c-client.aを /usr/local/lib/libc-client.a または リンクパスの他のディレクトリにコピーして下さい。

注意: c-client.a をリンクパスに libc-client.aという名前でコピーして下さい。

以下のファイルを/usr/local/include または インクルードパスの他のディレクトリにコピーして下さい。

c-client.h

imap4r1.h

rfc822.h

mail.h

linkage.h

env.h

env_unix.h

fs.h

ftl.h

misc.h

nntp.h

nl.h

osdep.h

smtp.h

tcp.h

注意: env_unix.hの名前は、使用するOSに依存します。以下のシンボリックオプションを指定してこのファイルをコピーするようにして下さい。SSLまたはKerberosサポートを指定してc-clientライブラリを構築するには、パッケージに付属するドキュメントを読んで下さい。

インストール手順

以下の関数を動作させるには、--with-imap=[DIR]を指定してPHPをコンパイルする必要があります。ただし、DIRはc-clientインストールプレフィックスです。

注意: c-clientの設定によっては、 --with-imap-ssl=/path/to/openssl/ または --with-kerberos=/path/to/kerberos をconfigureのオプションに指定する必要があります。

実行用の設定

この拡張モジュールは設定ディレクティブを全く定義しません。

リソース型

定義済みの定数

これらの定数は、この拡張モジュールで定義されており、この拡張モジュールがPHP内部にコンパイルされているか実行時に動的にロードされるかのどちらかの場合のみ使用可能です。

NIL (integer)
OP_DEBUG (integer)
OP_READONLY (integer): Open mailbox read-only
OP_ANONYMOUS (integer): Don't use or update a .newsrc for news (NNTP only)
OP_SHORTCACHE (integer)
OP_SILENT (integer)
OP_PROTOTYPE (integer)
OP_HALFOPEN (integer): For IMAP and NNTP names, open a connection but don't open a mailbox.
OP_EXPUNGE (integer)
OP_SECURE (integer)
CL_EXPUNGE (integer): silently expunge the mailbox before closing when calling imap_close()
FT_UID (integer): The parameter is a UID
FT_PEEK (integer): Do not set the \Seen flag if not already set
FT_NOT (integer)
FT_INTERNAL (integer): The return string is in internal format, will not canonicalize to CRLF.
FT_PREFETCHTEXT (integer)
ST_UID (integer): The sequence argument contains UIDs instead of sequence numbers
ST_SILENT (integer)
ST_SET (integer)
CP_UID (integer): the sequence numbers contain UIDS
CP_MOVE (integer): Delete the messages from the current mailbox after copying with imap_mail_copy()
SE_UID (integer): Return UIDs instead of sequence numbers
SE_FREE (integer)
SE_NOPREFETCH (integer): Don't prefetch searched messages
SO_FREE (integer)
SO_NOSERVER (integer)
SA_MESSAGES (integer)
SA_RECENT (integer)
SA_UNSEEN (integer)
SA_UIDNEXT (integer)
SA_UIDVALIDITY (integer)
SA_ALL (integer)
LATT_NOINFERIORS (integer): This mailbox has no "children" (there are no mailboxes below this one).
LATT_NOSELECT (integer): This is only a container, not a mailbox - you cannot open it.
LATT_MARKED (integer): This mailbox is marked. Only used by UW-IMAPD.
LATT_UNMARKED (integer): This mailbox is not marked. Only used by UW-IMAPD.
SORTDATE (integer): Sort criteria for imap_sort(): message Date
SORTARRIVAL (integer): Sort criteria for imap_sort(): arrival date
SORTFROM (integer): Sort criteria for imap_sort(): mailbox in first From address
SORTSUBJECT (integer): Sort criteria for imap_sort(): message subject
SORTTO (integer): Sort criteria for imap_sort(): mailbox in first To address
SORTCC (integer): Sort criteria for imap_sort(): mailbox in first cc address
SORTSIZE (integer): Sort criteria for imap_sort(): size of message in octets
TYPETEXT (integer)
TYPEMULTIPART (integer)
TYPEMESSAGE (integer)
TYPEAPPLICATION (integer)
TYPEAUDIO (integer)
TYPEIMAGE (integer)
TYPEVIDEO (integer)
TYPEOTHER (integer)
ENC7BIT (integer)
ENC8BIT (integer)
ENCBINARY (integer)
ENCBASE64 (integer)
ENCQUOTEDPRINTABLE (integer)
ENCOTHER (integer)

以下も参照下さい:

この文書では、提供される関数に関する全ての話題の詳細について立ち入ることはできません。より詳細な情報については、Cクライアントライブラリのソースに付属するドキュメント (docs/internal.txt)および以下のRFCドキュメントで提供されています。

RFC2821: Simple Mail Transfer Protocol (SMTP).
RFC2822: Standard for ARPA internet text messages.
RFC2060: Internet Message Access Protocol (IMAP) Version 4rev1.
RFC1939: Post Office Protocol Version 3 (POP3).
RFC977: Network News Transfer Protocol (NNTP).
RFC2076: Common Internet Message Headers.
RFC2045 , RFC2046 , RFC2047 , RFC2048 & RFC2049: Multipurpose Internet Mail Extensions (MIME).

詳しい概観については、David Woodによる本 Programming Internet Email や Dianna Mullet と Kevin Mullet によるManaging IMAPでも得ることができます。

警告

recode拡張モジュールとともにこの拡張モジュールをロードした際に PHP がクラッシュしたり、起動できないという問題が発生する可能性があります。詳細な情報については、recode 拡張モジュールを参照下さい。

目次
imap_8bit -- 8bit 文字列を quoted-printable 文字列に変換する
imap_alerts -- ページリクエストの間または最後にスタックがリセットされて以来発生した全てのIMAP警告メッセージを返す
imap_append -- 指定されたメールボックスに文字列メッセージを追加する
imap_base64 -- BASE64 でエンコードされたテキストのデコード
imap_binary -- 8ビット文字列をbase64文字列に変換する
imap_body -- メッセージ本文を読む
imap_bodystruct -- 指定したメッセージの指定したbodyセクションの構造を読み込む
imap_check -- 現在のメールボックスをチェックする
imap_clearflag_full -- メッセージのフラグをクリアする
imap_close -- IMAP ストリームをクローズする
imap_createmailbox -- 新しいメールボックスを作る
imap_delete -- 現在のメールボックスから削除するメッセージに印を付ける
imap_deletemailbox -- メールボックスを削除する
imap_errors -- ページのリクエストの間かエラースタックがリセットされて以来生じた全てのIMAPエラーを返す
imap_expunge -- 削除用にマークされたすべてのメッセージを削除する
imap_fetch_overview -- 指定したメッセージのヘッダ情報の概要を読む
imap_fetchbody -- メッセージ本文中の特定のセクションを取り出す
imap_fetchheader -- メッセージのヘッダを返す
imap_fetchstructure -- 特定のメッセージの構造を読み込む
imap_get_quota -- クオータレベルの設定、メールボックス毎の使用状況を取得する
imap_get_quotaroot -- Retrieve the quota settings per user
imap_getacl -- Gets the ACL for a given mailbox
imap_getmailboxes -- メールボックスのリストを読み込み、各ボックスに関する詳細な情報を返す
imap_getsubscribed -- 購読中の全メールボックスの一覧
imap_header -- メッセージのヘッダを読む
imap_headerinfo -- メッセージヘッダを読み込む
imap_headers -- メールボックス内の、すべてのメッセージのヘッダを返す
imap_last_error -- ページリクエスト時に生じた直近の IMAP エラーを返す
imap_list -- Read the list of mailboxes
imap_listmailbox -- メールボックスのリストを読む
imap_listscan -- Read the list of mailboxes, takes a string to search for in the text of the mailbox
imap_listsubscribed -- 購読中のすべてのメールボックス一覧
imap_lsub -- List all the subscribed mailboxes
imap_mail_compose -- 指定したエンベロープおよびボディーセクションに基づきMIMEメッセージを作成
imap_mail_copy -- 指定されたメッセージをメールボックスにコピーする
imap_mail_move -- 指定されたメッセージをメールボックスに移動する
imap_mail -- e-mailメッセージを送信する
imap_mailboxmsginfo -- 現在のメールボックスに関する情報を得る
imap_mime_header_decode -- MIMEヘッダーエレメントをデコードする
imap_msgno -- 指定したUIDのメッセージ番号を返す
imap_num_msg -- 現在のメールボックスのメッセージ数を取得する
imap_num_recent -- 現在のメールボックスにある新規メッセージの数の取得
imap_open -- メールボックスへのIMAPストリームをオープンする
imap_ping -- IMAP ストリームの有効性チェック
imap_qprint -- quoted-printable 文字列を 8 ビット文字列に変換する
imap_renamemailbox -- メールボックスの名前を変更する
imap_reopen -- 新規メールボックスへのIMAP ストリームを再度オープンする
imap_rfc822_parse_adrlist -- アドレス文字列を解釈します
imap_rfc822_parse_headers -- 文字列からメールヘッダを解釈する
imap_rfc822_write_address -- 指定したメールボックス、ホスト、個人情報を適当にフォーマットされた電子メールアドレスにして返す
imap_scanmailbox -- メールボックスのリストを読み、メールボックスのテキストにおいて文字列を検索する
imap_search -- 指定した検索条件にマッチするメッセージを配列として返す
imap_set_quota -- 指定したメールボックスにクオータを設定する
imap_setacl -- 指定したメールボックスのACLを設定する
imap_setflag_full -- メッセージにフラグをセットする
imap_sort --
imap_status -- 現在のメールボックス以外のメールボックスのステータス情報を返す
imap_subscribe -- メールボックスの購読
imap_thread -- REFERENCESツリーによりスレッド化して返す
imap_timeout -- Set or fetch imap timeout
imap_uid -- 指定したメッセージシーケンス番号の UID を返す
imap_undelete -- 削除マークがついているメッセージのマークをはずす
imap_unsubscribe -- メールボックスの購読をやめる
imap_utf7_decode -- 修正版UTF-7 エンコードされた文字列をデコードする
imap_utf7_encode -- 8ビットデータを修正版UTF-7テキストにに変換する
imap_utf8 -- テキストをUTF8に変換する