imap-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.imap-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_open</refname>
  <refpurpose>メールボックスへの <acronym>IMAP</acronym> ストリームをオープンする</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>IMAP\Connection</type><type>false</type></type><methodname>imap_open</methodname>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
   <methodparam><type>string</type><parameter>user</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>mailbox</parameter> への <acronym>IMAP</acronym> ストリームをオープンします。
  </para>
  <para>
   この関数は、<acronym>POP3</acronym> や <acronym>NNTP</acronym>
   サーバーへのストリームをオープンする際にも使用可能です。
   しかし、いくつかの関数および機能は <acronym>IMAP</acronym> サーバーでしか利用できません。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mailbox</parameter></term>
     <listitem>
      <para>
       メールボックス名(mailbox)は、サーバー名の部分と使用するサーバーにおける
       メールボックスへのパスから構成されます。特別な名前 <literal>INBOX</literal> は、
       カレントユーザーの個人メールボックスを意味します。
       ASCII 空間で出力可能な文字以外の外国文字を含むメールボックス名は
       <function>imap_utf7_encode</function> でエンコードする必要があります。
      </para>
      &imap.mailboxname.insecure;
      <para>
       サーバー部は '{'
       および '}' で括られ、サーバー名または IP アドレス、オプションの ':'
       から始まるポート指定子、('/' で始まる)オプションのプロトコル指定子
       から構成されます。
      </para>
      <para>
       サーバー部は、全ての mailbox パラメータで必須です。
      </para>
      <para>
       <literal>{</literal> で始まる名前はすべてリモート名で、
       <literal>"{" remote_system_name [":" port] [flags] "}"
       [mailbox_name]</literal> のような形式となります。
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>remote_system_name</literal> - Internet ドメイン名
          あるいは括弧でかこまれたサーバーの IP アドレス。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>port</literal> - オプションの TCP ポート番号。デフォルトは
          そのサービスのデフォルトポート。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>flags</literal> - オプションのフラグ。以下の表を参照ください。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>mailbox_name</literal> - リモートメールボックス名。デフォルトは INBOX 。
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
      <para>
       <table>
        <title>オプションのフラグ名</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>フラグ</entry>
           <entry>説明</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>/service=</literal><emphasis>service</emphasis></entry>
           <entry>メールボックスにアクセスするサービス。デフォルトは "imap" 。</entry>
          </row>
          <row>
           <entry><literal>/user=</literal><emphasis>user</emphasis></entry>
           <entry>サーバーへのログイン時のユーザー名。</entry>
          </row>
          <row>
           <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry>
           <entry>リモートの認証ユーザー。指定されていた場合は、このユーザーのパスワードが
            認証に使用されます（例: administrator）。</entry>
          </row>
          <row>
           <entry><literal>/anonymous</literal></entry>
           <entry>匿名ユーザーとしてアクセスします。</entry>
          </row>
          <row>
           <entry><literal>/debug</literal></entry>
           <entry>プロトコルの通信内容をアプリケーションのデバッグログに記録します。</entry>
          </row>
          <row>
           <entry><literal>/secure</literal></entry>
           <entry>ネットワーク越しにプレーンテキストのパスワードを送信しません。</entry>
          </row>
          <row>
           <entry><literal>/imap</literal>, <literal>/imap2</literal>,
            <literal>/imap2bis</literal>, <literal>/imap4</literal>,
            <literal>/imap4rev1</literal></entry>
           <entry><literal>/service=imap</literal> と同じです。</entry>
          </row>
          <row>
           <entry><literal>/pop3</literal></entry>
           <entry><literal>/service=pop3</literal> と同じです。</entry>
          </row>
          <row>
           <entry><literal>/nntp</literal></entry>
           <entry><literal>/service=nntp</literal> と同じです。</entry>
          </row>
          <row>
           <entry><literal>/norsh</literal></entry>
           <entry>事前に認証済みの IMAP セッションを確立する際に、rsh や ssh
            を使用しません。</entry>
          </row>
          <row>
           <entry><literal>/ssl</literal></entry>
           <entry>セッションの暗号化に <literal>Secure Socket Layer</literal> を使用します。</entry>
          </row>
          <row>
           <entry><literal>/validate-cert</literal></entry>
           <entry>TLS/SSL サーバーの証明書を検証します（デフォルトの挙動です）。</entry>
          </row>
          <row>
           <entry><literal>/novalidate-cert</literal></entry>
           <entry>TLS/SSL サーバーの証明書を検証しません。サーバーが自己証明の
            証明書を使用している際に必要となります。</entry>
          </row>
          <row>
           <entry><literal>/tls</literal></entry>
           <entry>セッションの暗号化に <literal>start-TLS</literal> の使用を強制し、それを
            サポートしていないサーバーとの接続を拒否します。</entry>
          </row>
          <row>
           <entry><literal>/notls</literal></entry>
           <entry>たとえサーバーがそれをサポートしていたとしても、
            セッションで <literal>start-TLS</literal> による暗号化を使用しません。</entry>
          </row>
          <row>
           <entry><literal>/readonly</literal></entry>
           <entry>読み込み専用でのメールボックスのオープンを要求します（IMAP のみ。
            NNTP では無視され、SMTP および POP3 ではエラーとなります）。</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>user</parameter></term>
     <listitem>
      <para>
       ユーザー名。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       <parameter>user</parameter> のパスワード。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> はビットマスクであり、以下の組み合わせとなります。
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>OP_READONLY</constant> - メールボックスを読み込み専用でオープンします。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_ANONYMOUS</constant> - news に関して
          <filename>.newsrc</filename> を使用せず、更新もしません（NNTP のみ）。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_HALFOPEN</constant> - <acronym>IMAP</acronym> 及び <acronym>NNTP</acronym> 名について、
          接続をオープンしますがメールボックスはオープンしません。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CL_EXPUNGE</constant> - メールボックスを閉じる際に、
          自動的にメールボックスを削除します（<function>imap_delete</function>
          および <function>imap_expunge</function> も参照ください）。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_DEBUG</constant> - プロトコルネゴシエーションをデバッグします。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SHORTCACHE</constant> - 短い（<literal>elt</literal>-only）キャッシングを行います。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SILENT</constant> - イベントを受信しません（内部で使用します）。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_PROTOTYPE</constant> - ドライバのプロトタイプを返します。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SECURE</constant> - セキュアでない認証を行いません。
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>retries</parameter></term>
     <listitem>
      <para>
       接続試行の最大数。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       接続パラメータ。次の (文字列の) キーを使って接続パラメータを設定することができます。
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>DISABLE_AUTHENTICATOR</literal> - 認証プロパティを無効にする
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合は、
   <classname>IMAP\Connection</classname> クラスのインスタンスを返します。
   &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       <classname>IMAP\Connection</classname>
       のインスタンスを返すようになりました。
       これより前のバージョンでは、
       &resource; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_open</function> のさまざまな使用例</title>
    <programlisting role="php">
<![CDATA[
<?php
// ローカルマシンのポート 143 で稼動している IMAP サーバーに接続するには
// 以下のようにします。
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");

// ローカルマシンのポート 110 で稼動している POP3 サーバーに接続するには、
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");

// SSL IMAP あるいは POP3 サーバーに接続するには、プロトコル指定のあとに
// /ssl を追加します。
$mbox = imap_open ("{localhost:993/imap/ssl}INBOX", "user_id", "password");

// 自分でサインした証明書で SSL IMAP あるいは POP3 サーバーに接続するには、
// プロトコル指定のあとに /ssl/novalidate-cert を追加します。
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");

// ローカルマシンのポート 119 で稼動している NNTP サーバーに接続するには、
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");
// リモートサーバーに接続する際は、"localhost" を接続したいサーバーの
// 名前または IP アドレスに置き換えます。
?>
]]>
    </programlisting>
   </example>
   <example>
    <title><function>imap_open</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");

echo "<h1>Mailboxes</h1>\n";
$folders = imap_listmailbox($mbox, "{imap.example.org:143}", "*");

if ($folders == false) {
    echo "コールが失敗しました<br />\n";
} else {
    foreach ($folders as $val) {
        echo $val . "<br />\n";
    }
}

echo "<h1>INBOX のヘッダ</h1>\n";
$headers = imap_headers($mbox);

if ($headers == false) {
    echo "コールが失敗しました<br />\n";
} else {
    foreach ($headers as $val) {
        echo $val . "<br />\n";
    }
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_close</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->