<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Open an IMAP stream to a mailbox</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-num-recent.html">imap_num_recent</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-ping.html">imap_ping</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-open" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_open</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_open</span> — <span class="dc-title">Open an <acronym title="Internet Message Access Protocol">IMAP</acronym> stream to a mailbox</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-open-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>imap_open</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$mailbox</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$n_retries</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$params</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
]]] )</div>
<p class="para rdfs-comment">
Opens an <acronym title="Internet Message Access Protocol">IMAP</acronym> stream to a <em><code class="parameter">mailbox</code></em>.
</p>
<p class="para">
This function can also be used to open streams to <acronym title="Post Office Protocol version 3">POP3</acronym> and
<acronym title="Network News Transfer Protocol">NNTP</acronym> servers, but some functions and features are only
available on <acronym title="Internet Message Access Protocol">IMAP</acronym> servers.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-open-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">mailbox</code></em></span>
<dd>
<p class="para">
A mailbox name consists of a server and a mailbox path on this server.
The special name <em>INBOX</em> 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
<span class="function"><a href="function.imap-utf7-encode.html" class="function">imap_utf7_encode()</a></span>.
</p>
<p class="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 '/').
</p>
<p class="para">
The server part is mandatory in all mailbox
parameters.
</p>
<p class="para">
All names which start with <em>{</em> are remote names, and are
in the form <em>"{" remote_system_name [":" port] [flags] "}"
[mailbox_name]</em> where:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em>remote_system_name</em> - Internet domain name or
bracketed IP address of server.
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>port</em> - optional TCP port number, default is the
default port for that service
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>flags</em> - optional flags, see following table.
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>mailbox_name</em> - remote mailbox name, default is INBOX
</span>
</li>
</ul>
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Optional flags for names</strong></caption>
<thead>
<tr>
<th>Flag</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><em>/service=</em><em class="emphasis">service</em></td>
<td>mailbox access service, default is "imap"</td>
</tr>
<tr>
<td><em>/user=</em><em class="emphasis">user</em></td>
<td>remote user name for login on the server</td>
</tr>
<tr>
<td><em>/authuser=</em><em class="emphasis">user</em></td>
<td>remote authentication user; if specified this is the user name
whose password is used (e.g. administrator)</td>
</tr>
<tr>
<td><em>/anonymous</em></td>
<td>remote access as anonymous user</td>
</tr>
<tr>
<td><em>/debug</em></td>
<td>record protocol telemetry in application's debug log</td>
</tr>
<tr>
<td><em>/secure</em></td>
<td>do not transmit a plaintext password over the network</td>
</tr>
<tr>
<td><em>/imap</em>, <em>/imap2</em>,
<em>/imap2bis</em>, <em>/imap4</em>,
<em>/imap4rev1</em></td>
<td>equivalent to <em>/service=imap</em></td>
</tr>
<tr>
<td><em>/pop3</em></td>
<td>equivalent to <em>/service=pop3</em></td>
</tr>
<tr>
<td><em>/nntp</em></td>
<td>equivalent to <em>/service=nntp</em></td>
</tr>
<tr>
<td><em>/norsh</em></td>
<td>do not use rsh or ssh to establish a preauthenticated IMAP
session</td>
</tr>
<tr>
<td><em>/ssl</em></td>
<td>use the <em>Secure Socket Layer</em> to encrypt the session</td>
</tr>
<tr>
<td><em>/validate-cert</em></td>
<td>validate certificates from TLS/SSL server (this is the default
behavior)</td>
</tr>
<tr>
<td><em>/novalidate-cert</em></td>
<td>do not validate certificates from TLS/SSL server, needed if
server uses self-signed certificates</td>
</tr>
<tr>
<td><em>/tls</em></td>
<td>force use of <em>start-TLS</em> to encrypt the session, and reject
connection to servers that do not support it</td>
</tr>
<tr>
<td><em>/notls</em></td>
<td>do not do <em>start-TLS</em> to encrypt the session, even with servers
that support it</td>
</tr>
<tr>
<td><em>/readonly</em></td>
<td>request read-only mailbox open (IMAP only; ignored on NNTP, and
an error with SMTP and POP3)</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">username</code></em></span>
<dd>
<p class="para">
The user name
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">password</code></em></span>
<dd>
<p class="para">
The password associated with the <em><code class="parameter">username</code></em>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
The <em><code class="parameter">options</code></em> are a bit mask with one or more of
the following:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>OP_READONLY</code></strong> - Open mailbox read-only
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_ANONYMOUS</code></strong> - Don't use or update a
<var class="filename">.newsrc</var> for news (NNTP only)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_HALFOPEN</code></strong> - For <acronym title="Internet Message Access Protocol">IMAP</acronym>
and <acronym title="Network News Transfer Protocol">NNTP</acronym> names, open a connection but
don't open a mailbox.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>CL_EXPUNGE</code></strong> - Expunge mailbox automatically upon mailbox close
(see also <span class="function"><a href="function.imap-delete.html" class="function">imap_delete()</a></span> and
<span class="function"><a href="function.imap-expunge.html" class="function">imap_expunge()</a></span>)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_DEBUG</code></strong> - Debug protocol negotiations
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_SHORTCACHE</code></strong> - Short (<em>elt</em>-only) caching
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_SILENT</code></strong> - Don't pass up events (internal use)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_PROTOTYPE</code></strong> - Return driver prototype
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_SECURE</code></strong> - Don't do non-secure authentication
</span>
</li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">n_retries</code></em></span>
<dd>
<p class="para">
Number of maximum connect attempts
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">params</code></em></span>
<dd>
<p class="para">
Connection parameters, the following (string) keys maybe used
to set one or more connection parameters:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em>DISABLE_AUTHENTICATOR</em> - Disable authentication properties
</span>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-open-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an IMAP stream on success or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.imap-open-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.3.2</td>
<td><em><code class="parameter">params</code></em> added</td>
</tr>
<tr>
<td>5.2.0</td>
<td><em><code class="parameter">n_retries</code></em> added</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-open-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3367">
<p><strong>Example #1 Different use of <span class="function"><strong>imap_open()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// To connect to an IMAP server running on port 143 on the local machine,<br />// do the following:<br /></span><span style="color: #0000BB">$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{localhost:143}INBOX"</span><span style="color: #007700">, </span><span style="color: #DD0000">"user_id"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// To connect to a POP3 server on port 110 on the local server, use:<br /></span><span style="color: #0000BB">$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open </span><span style="color: #007700">(</span><span style="color: #DD0000">"{localhost:110/pop3}INBOX"</span><span style="color: #007700">, </span><span style="color: #DD0000">"user_id"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// To connect to an SSL IMAP or POP3 server, add /ssl after the protocol<br />// specification:<br /></span><span style="color: #0000BB">$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open </span><span style="color: #007700">(</span><span style="color: #DD0000">"{localhost:993/imap/ssl}INBOX"</span><span style="color: #007700">, </span><span style="color: #DD0000">"user_id"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// To connect to an SSL IMAP or POP3 server with a self-signed certificate,<br />// add /ssl/novalidate-cert after the protocol specification:<br /></span><span style="color: #0000BB">$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open </span><span style="color: #007700">(</span><span style="color: #DD0000">"{localhost:995/pop3/ssl/novalidate-cert}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"user_id"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// To connect to an NNTP server on port 119 on the local server, use:<br /></span><span style="color: #0000BB">$nntp </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open </span><span style="color: #007700">(</span><span style="color: #DD0000">"{localhost:119/nntp}comp.test"</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// To connect to a remote server replace "localhost" with the name or the<br />// IP address of the server you want to connect to.<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-3368">
<p><strong>Example #2 <span class="function"><strong>imap_open()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org:143}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"<h1>Mailboxes</h1>\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$folders </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_listmailbox</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org:143}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"*"</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$folders </span><span style="color: #007700">== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Call failed<br />\n"</span><span style="color: #007700">;<br />} else {<br /> foreach (</span><span style="color: #0000BB">$folders </span><span style="color: #007700">as </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> }<br />}<br /><br />echo </span><span style="color: #DD0000">"<h1>Headers in INBOX</h1>\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$headers </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_headers</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$headers </span><span style="color: #007700">== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Call failed<br />\n"</span><span style="color: #007700">;<br />} else {<br /> foreach (</span><span style="color: #0000BB">$headers </span><span style="color: #007700">as </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-open-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imap-close.html" class="function" rel="rdfs-seeAlso">imap_close()</a> - Close an IMAP stream</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-num-recent.html">imap_num_recent</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-ping.html">imap_ping</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
