成功した場合は IMAP ストリームを、失敗した場合は FALSE を返します。 この関数は、POP3 や NNTP サーバへのストリームをオープンする際にも 使用可能です。しかし、いくつかの関数および機能は IMAP サーバでしか 利用できません。
メールボックス名(mailbox)は、サーバ名の部分と使用するサーバにおける メールボックスへのパスから構成されます。特別な名前 INBOX は、 カレントユーザの個人メールボックスを意味します。サーバ部は '{' および '}' で括られ、サーバ名または IP アドレス、オプションの ':' から始まるポート指定子、('/' で始まる)オプションのプロトコル指定子 から構成されます。サーバ部は、全ての mailbox パラメータで必須です。 ASCII 空間で出力可能な文字以外の外国文字を含むメールボックス名は imap_utf7_encode() でエンコードする必要があります。
{ で始まる名前はすべてリモート名で、 "{" remote_system_name [":" port] [flags] "}" [mailbox_name] のような形式となります。
remote_system_name - Internet ドメイン名 あるいは括弧でかこまれたサーバの IP アドレス。
port - オプションの TCP ポート番号。デフォルトは そのサービスのデフォルトポート。
flags - オプションのフラグ。以下の表を参照ください。
mailbox_name - リモートメールボックス名。デフォルトは INBOX 。
表 1. オプションのフラグ名
フラグ | 説明 |
---|---|
/service=service | メールボックスにアクセスするサービス。デフォルトは "imap" 。 |
/user=user | サーバへのログイン時のユーザ名。 |
/authuser=user | リモートの認証ユーザ。指定されていた場合は、このユーザのパスワードが 認証に使用されます(例: administrator)。 |
/anonymous | 匿名ユーザとしてアクセスします。 |
/debug | プロトコルの通信内容をアプリケーションのデバッグログに記録します。 |
/secure | ネットワーク越しにプレーンテキストのパスワードを送信しません。 |
/imap、/imap2、 /imap2bis、/imap4、 /imap4rev1 | /service=imap と同じです。 |
/pop3 | /service=pop3 と同じです。 |
/nntp | /service=nntp と同じです。 |
/norsh | 事前に認証済みの IMAP セッションを確立する際に、rsh や ssh を使用しません。 |
/ssl | セッションの暗号化に SSL(Secure Socket Layer)を使用します。 |
/validate-cert | TLS/SSL サーバの証明書を検証します(デフォルトの挙動です)。 |
/novalidate-cert | TLS/SSL サーバの証明書を検証しません。サーバが自己証明の 証明書を使用している際に必要となります。 |
/tls | セッションの暗号化に start-TLS の使用を強制し、それを サポートしていないサーバとの接続を拒否します。 |
/notls | たとえサーバがそれをサポートしていたとしても、 セッションで start-TLS による暗号化を使用しません。 |
/readonly | 読み込み専用でのメールボックスのオープンを要求します(IMAP のみ。 NNTP では無視され、SMTP および POP3 ではエラーとなります)。 |
options はビットマスクであり、以下の組み合わせとなります。
OP_READONLY - メールボックスを読み込み専用でオープンします。
OP_ANONYMOUS - news に関して .newsrc を使用せず、更新もしません(NNTP のみ)。
OP_HALFOPEN - IMAP 及び NNTP 名について、 接続をオープンしますがメールボックスはオープンしません。
CL_EXPUNGE - メールボックスを閉じる際に、 自動的にメールボックスを削除します(imap_delete() および imap_expunge() も参照ください)。
OP_DEBUG - プロトコルネゴシエーションをデバッグします。
OP_SHORTCACHE - 短い(elt-only)キャッシングを行います。
OP_SILENT - イベントを受信しません(内部で使用します)。
OP_PROTOTYPE - ドライバのプロトタイプを返します。
OP_EXPUNGE - リサイクルストリームを削除します。
OP_SECURE - セキュアでない認証を行いません。
例 2. imap_open() の例
|