imap-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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>
   Открывает поток <acronym>IMAP</acronym> к <parameter>mailbox</parameter>.
  </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>
       Имя почтового ящика состоит из сервера и пути к почтовому ящику на нем.
       Специальное имя <literal>INBOX</literal> используется для почтового ящика
       текущего пользователя. Имена почтовых ящиков, содержащих интернациональные
       символы кроме входящих в печатное пространство ASCII, должны быть закодированы
       с помощью <function>imap_utf7_encode</function>.
      </para>
      &imap.mailboxname.insecure;
      <para>
       Серверная часть, заключённая в фигурные скобки '{' и '}', состоит из
       имени или IP-адреса сервера, опционального порта (предварённого двоеточием)
       и опциональных спецификаций протокола (предварённых слешем '/').
      </para>
      <para>
       Серверная часть является обязательной во всех параметрах почтового ящика.
      </para>
      <para>
       Все имена, начинающиеся с <literal>{</literal> являются удалёнными именами и
       имеют такой синтаксис <literal>"{" remote_system_name [":" port] [flags] "}"
       [mailbox_name]</literal> где:
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>remote_system_name</literal> - полное доменное имя сервера, либо
          IP-адрес в квадратных скобках.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>port</literal> - необязательный параметр. Определяет порт сервера
         </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>не использовать rsh или ssh для установки преавторизованной
            сессии IMAP</entry>
          </row>
          <row>
           <entry><literal>/ssl</literal></entry>
           <entry>использовать <literal>SSL</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> - не использовать и не обновлять
          <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>)
         </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
// Для подключения к серверу IMAP, работающему на порту 143 на локальной машине, сделать следующее:
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");

// Для подключения к серверу POP3, работающему на порту 110 на локальной машине, использовать:
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");

// Для подключения к серверу SSL IMAP или POP3, добавить /ssl после протокола
// specification:
$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");

// Для подключения к серверу NNTP, работающему на порту 119 на локальной машине, использовать:
$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>Почтовые ящики</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
-->