PHPのお勉強!

PHP TOP

IMAP 関数

参考

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

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

目次

  • imap_8bit — 8 ビット文字列を 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_create — imap_createmailbox のエイリアス
  • imap_createmailbox — 新しいメールボックスを作る
  • imap_delete — 現在のメールボックスから削除するメッセージに印を付ける
  • imap_deletemailbox — メールボックスを削除する
  • imap_errors — 発生したすべての IMAP エラーを返す
  • imap_expunge — 削除用にマークされたすべてのメッセージを削除する
  • imap_fetch_overview — 指定したメッセージのヘッダ情報の概要を読む
  • imap_fetchbody — メッセージ本文中の特定のセクションを取り出す
  • imap_fetchheader — メッセージのヘッダを返す
  • imap_fetchmime — メッセージの特定のセクションに対する MIME ヘッダを取り出します
  • imap_fetchstructure — 特定のメッセージの構造を読み込む
  • imap_fetchtext — imap_body のエイリアス
  • imap_gc — IMAP キャッシュをクリアする
  • imap_get_quota — クオータレベルの設定、メールボックス毎の使用状況を取得する
  • imap_get_quotaroot — ユーザー単位のクォータ設定を取得する
  • imap_getacl — 与えられたメールボックスの ACL を取得する
  • imap_getmailboxes — メールボックスのリストを読み込み、各ボックスに関する詳細な情報を返す
  • imap_getsubscribed — 購読中の全メールボックスの一覧を取得する
  • imap_header — imap_headerinfo のエイリアス
  • imap_headerinfo — メッセージヘッダを読み込む
  • imap_headers — メールボックス内のすべてのメッセージのヘッダを返す
  • imap_is_open — IMAP ストリームがまだ有効かを調べる
  • imap_last_error — ページリクエスト時に生じた直近の IMAP エラーを返す
  • imap_list — メールボックスのリストを読み込む
  • imap_listmailbox — imap_list のエイリアス
  • imap_listscan — 指定したテキストにマッチするメールボックスの一覧を返す
  • imap_listsubscribed — imap_lsub のエイリアス
  • imap_lsub — 購読しているすべてのメールボックスの一覧を得る
  • imap_mail — e-mail メッセージを送信する
  • imap_mail_compose — 指定したエンベロープおよびボディセクションに基づいて MIME メッセージを作成する
  • imap_mail_copy — 指定されたメッセージをメールボックスにコピーする
  • imap_mail_move — 指定されたメッセージをメールボックスに移動する
  • imap_mailboxmsginfo — 現在のメールボックスに関する情報を得る
  • imap_mime_header_decode — MIME ヘッダ要素をデコードする
  • imap_msgno — 指定した UID のメッセージ番号を返す
  • imap_mutf7_to_utf8 — 修正UTF-7文字列をUTF-8にデコードする
  • imap_num_msg — 現在のメールボックスのメッセージ数を取得する
  • imap_num_recent — 現在のメールボックスにある新規メッセージ数を取得する
  • imap_open — メールボックスへの IMAP ストリームをオープンする
  • imap_ping — IMAP ストリームがアクティブかどうかを調べる
  • imap_qprint — quoted-printable 文字列を 8 ビット文字列に変換する
  • imap_rename — imap_renamemailbox のエイリアス
  • imap_renamemailbox — メールボックスの名前を変更する
  • imap_reopen — 新規メールボックスへの IMAP ストリームを再度オープンする
  • imap_rfc822_parse_adrlist — アドレス文字列を解釈します
  • imap_rfc822_parse_headers — 文字列からメールヘッダを解釈する
  • imap_rfc822_write_address — 指定したメールボックス、ホスト、個人情報を、 電子メールアドレスとして適当な形式にして返す
  • imap_savebody — 指定した本文部をファイルに保存する
  • imap_scan — imap_listscan のエイリアス
  • imap_scanmailbox — imap_listscan のエイリアス
  • imap_search — 指定した検索条件にマッチするメッセージを配列として返す
  • imap_set_quota — 指定したメールボックスにクォータを設定する
  • imap_setacl — 指定したメールボックスの ACL を設定する
  • imap_setflag_full — メッセージにフラグをセットする
  • imap_sort — メッセージヘッダの配列をソートする
  • imap_status — 現在のメールボックス以外のメールボックスのステータス情報を返す
  • imap_subscribe — メールボックスを購読する
  • imap_thread — スレッド化したメッセージのツリーを返す
  • imap_timeout — imap タイムアウトを設定あるいは取得する
  • imap_uid — 指定したメッセージシーケンス番号の UID を返す
  • imap_undelete — 削除マークがついているメッセージのマークをはずす
  • imap_unsubscribe — メールボックスの購読をやめる
  • imap_utf7_decode — 修正版 UTF-7 エンコードされた文字列をデコードする
  • imap_utf7_encode — ISO-8859-1 文字列を修正版 UTF-7 テキストに変換する
  • imap_utf8 — MIME エンコードされたテキストを UTF-8 に変換する
  • imap_utf8_to_mutf7 — UTF-8 文字列を修正UTF-7にエンコードする
add a note

User Contributed Notes 21 notes

up
104
v dot 0000000001 dot -0006398047 at vertabiz dot com
19 years ago
Since this library at a whole is fairly poorly documented, and it doesn't help that there's 30-something functions, and many of the functions do the same things, I have gone through and categorized the functions. Hopefully this will help somebody else, I know it will help me!! -Justin

CONNECTION, ERRORS & QUOTAS
===========================
imap_timeout
imap_ping
imap_open
imap_reopen
imap_close
imap_check **(fairly useless)
imap_alerts
imap_errors
imap_last_error
imap_get_quota
imap_get_quotaroot
imap_set_quota

MESSAGES - READING
==================
imap_uid
imap_msgno
imap_fetchbody
imap_fetchheader
imap_fetchstructure
imap_fetch_overview
imap_body
imap_rfc822_parse_adrlist
imap_rfc822_parse_headers

MESSAGES - WRITING
==================
imap_mail_compose
imap_mail
imap_append
imap_rfc822_write_address

MESSAGES - OPERATIONS
=====================
imap_undelete
imap_thread
imap_delete
imap_mail_copy
imap_mail_move
imap_expunge
imap_clearflag_full
imap_setflag_full

MESSAGES - DECODE/ENCODE
========================
imap_utf7_decode
imap_utf7_encode
imap_utf8
imap_8bit
imap_base64
imap_binary
imap_mime_header_decode
imap_qprint

FOLDERS
=======
imap_createmailbox
imap_deletemailbox
imap_getmailboxes
imap_mailboxmsginfo
imap_renamemailbox
imap_headers **(fairly useless)
imap_status
imap_sort
imap_search
imap_listscan

NNTP
====
imap_unsubscribe
imap_subscribe
imap_getsubscribed

Others
=============================
imap_num_msg - use imap_mailboxmsginfo()
imap_num_recent - use imap_mailboxmsginfo()
imap_header - alias of imap_headerinfo()
imap_scanmailbox - alias of imap_listscan()
imap_listsubscribed - alias of imap_lsub()
imap_listmailbox - alias of imap_list()
imap_lsub - use imap_getsubscribed()
imap_list - use imap_getmailboxes()
imap_bodystruct - not documented
imap_getacl - not documented
imap_setacl - not documented
imap_headerinfo - use imap_fetch_overview()
up
4
BjarneDM macintosh at mathiesen dot info
18 years ago
Mac OS X client install notes with DarwinPorts

The c-client.a isn't present on your system after you've installed the imap-uw package. !But! it's actually present at a specific time during the install phase as it's being complied from source - it's just deleted at the end of the compilation process. So, we'll have to break the install process down into it's component processes and get hold of what we need at the appropriate time:

sudo port fetch imap-uw
sudo port extract imap-uw
sudo port patch imap-uw
sudo port configure imap-uw
sudo port build imap-uw
imapLib=/darwinports/var/db/dports/distfiles/imap-uw/lib
imapIncludes=/darwinports/var/db/dports/distfiles/imap-uw/include
sudo mkdir ${imapLib} ${imapInclude}
cd /darwinports/var/db/dports/build/*/*/*/c-client
sudo cp *.c ${imapLib}
sudo cp *.h ${imapIncludes}
sudo cp c-client.a ${imapLib}/libc-client.a
cd ${imapLib}
ranlib - libc-client.a
sudo port install imap-uw

Now, you can just specify:
--with-imap=/darwinports/var/db/dports/distfiles/imap-uw \
--with-imap-ssl=/darwinports \
in your ./configure command.