mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
45b4dc6dc3
Fix doc bug #63997 (NIL instead of NULL). git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329153 c90b9560-bf6c-de11-be94-00142212c4b1
403 lines
13 KiB
XML
403 lines
13 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-open" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_open</refname>
|
|
<refpurpose>Open an <acronym>IMAP</acronym> stream to a mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>imap_open</methodname>
|
|
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>n_retries</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>params</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Opens an <acronym>IMAP</acronym> stream to a <parameter>mailbox</parameter>.
|
|
</para>
|
|
<para>
|
|
This function can also be used to open streams to <acronym>POP3</acronym> and
|
|
<acronym>NNTP</acronym> servers, but some functions and features are only
|
|
available on <acronym>IMAP</acronym> servers.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>mailbox</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A mailbox name consists of a server and a mailbox path on this server.
|
|
The special name <literal>INBOX</literal> stands for the current users
|
|
personal mailbox. Mailbox names that contain international characters
|
|
besides those in the printable ASCII space have to be encoded width
|
|
<function>imap_utf7_encode</function>.
|
|
</para>
|
|
<para>
|
|
The server part, which is enclosed in '{' and '}', consists of the servers
|
|
name or ip address, an optional port (prefixed by ':'), and an optional
|
|
protocol specification (prefixed by '/').
|
|
</para>
|
|
<para>
|
|
The server part is mandatory in all mailbox
|
|
parameters.
|
|
</para>
|
|
<para>
|
|
All names which start with <literal>{</literal> are remote names, and are
|
|
in the form <literal>"{" remote_system_name [":" port] [flags] "}"
|
|
[mailbox_name]</literal> where:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>remote_system_name</literal> - Internet domain name or
|
|
bracketed IP address of server.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>port</literal> - optional TCP port number, default is the
|
|
default port for that service
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>flags</literal> - optional flags, see following table.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>mailbox_name</literal> - remote mailbox name, default is INBOX
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<table>
|
|
<title>Optional flags for names</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Flag</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><literal>/service=</literal><emphasis>service</emphasis></entry>
|
|
<entry>mailbox access service, default is "imap"</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/user=</literal><emphasis>user</emphasis></entry>
|
|
<entry>remote user name for login on the server</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/authuser=</literal><emphasis>user</emphasis></entry>
|
|
<entry>remote authentication user; if specified this is the user name
|
|
whose password is used (e.g. administrator)</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/anonymous</literal></entry>
|
|
<entry>remote access as anonymous user</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/debug</literal></entry>
|
|
<entry>record protocol telemetry in application's debug log</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/secure</literal></entry>
|
|
<entry>do not transmit a plaintext password over the network</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/imap</literal>, <literal>/imap2</literal>,
|
|
<literal>/imap2bis</literal>, <literal>/imap4</literal>,
|
|
<literal>/imap4rev1</literal></entry>
|
|
<entry>equivalent to <literal>/service=imap</literal></entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/pop3</literal></entry>
|
|
<entry>equivalent to <literal>/service=pop3</literal></entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/nntp</literal></entry>
|
|
<entry>equivalent to <literal>/service=nntp</literal></entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/norsh</literal></entry>
|
|
<entry>do not use rsh or ssh to establish a preauthenticated IMAP
|
|
session</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/ssl</literal></entry>
|
|
<entry>use the <literal>Secure Socket Layer</literal> to encrypt the session</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/validate-cert</literal></entry>
|
|
<entry>validate certificates from TLS/SSL server (this is the default
|
|
behavior)</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/novalidate-cert</literal></entry>
|
|
<entry>do not validate certificates from TLS/SSL server, needed if
|
|
server uses self-signed certificates</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/tls</literal></entry>
|
|
<entry>force use of <literal>start-TLS</literal> to encrypt the session, and reject
|
|
connection to servers that do not support it</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/notls</literal></entry>
|
|
<entry>do not do <literal>start-TLS</literal> to encrypt the session, even with servers
|
|
that support it</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/readonly</literal></entry>
|
|
<entry>request read-only mailbox open (IMAP only; ignored on NNTP, and
|
|
an error with SMTP and POP3)</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The user name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The password associated with the <parameter>username</parameter>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>options</parameter> are a bit mask with one or more of
|
|
the following:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_READONLY</constant> - Open mailbox read-only
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_ANONYMOUS</constant> - Don't use or update a
|
|
<filename>.newsrc</filename> for news (NNTP only)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_HALFOPEN</constant> - For <acronym>IMAP</acronym>
|
|
and <acronym>NNTP</acronym> names, open a connection but
|
|
don't open a mailbox.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close
|
|
(see also <function>imap_delete</function> and
|
|
<function>imap_expunge</function>)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_DEBUG</constant> - Debug protocol negotiations
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_SHORTCACHE</constant> - Short (<literal>elt</literal>-only) caching
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_SILENT</constant> - Don't pass up events (internal use)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_PROTOTYPE</constant> - Return driver prototype
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_SECURE</constant> - Don't do non-secure authentication
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>n_retries</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Number of maximum connect attempts
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>params</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Connection parameters, the following (string) keys maybe used
|
|
to set one or more connection parameters:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>DISABLE_AUTHENTICATOR</literal> - Disable authentication properties
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an IMAP stream on success or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.3.2</entry>
|
|
<entry><parameter>params</parameter> added</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.2.0</entry>
|
|
<entry><parameter>n_retries</parameter> added</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Different use of <function>imap_open</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// To connect to an IMAP server running on port 143 on the local machine,
|
|
// do the following:
|
|
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");
|
|
|
|
// To connect to a POP3 server on port 110 on the local server, use:
|
|
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");
|
|
|
|
// To connect to an SSL IMAP or POP3 server, add /ssl after the protocol
|
|
// specification:
|
|
$mbox = imap_open ("{localhost:993/imap/ssl}INBOX", "user_id", "password");
|
|
|
|
// To connect to an SSL IMAP or POP3 server with a self-signed certificate,
|
|
// add /ssl/novalidate-cert after the protocol specification:
|
|
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");
|
|
|
|
// To connect to an NNTP server on port 119 on the local server, use:
|
|
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");
|
|
// To connect to a remote server replace "localhost" with the name or the
|
|
// IP address of the server you want to connect to.
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title><function>imap_open</function> example</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 "Call failed<br />\n";
|
|
} else {
|
|
foreach ($folders as $val) {
|
|
echo $val . "<br />\n";
|
|
}
|
|
}
|
|
|
|
echo "<h1>Headers in INBOX</h1>\n";
|
|
$headers = imap_headers($mbox);
|
|
|
|
if ($headers == false) {
|
|
echo "Call failed<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
|
|
-->
|