<!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>This function returns the UID for the given message sequence number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-timeout.html">imap_timeout</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-undelete.html">imap_undelete</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-uid" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_uid</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_uid</span> — <span class="dc-title">This function returns the UID for the given message sequence number</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-uid-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>imap_uid</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$msg_number</code></span>
)</div>
<p class="para rdfs-comment">
This function returns the UID for the given message sequence
number. An UID is a unique identifier that will not change over
time while a message sequence number may change whenever the
content of the mailbox changes.
</p>
<p class="para">
This function is the inverse of <span class="function"><a href="function.imap-msgno.html" class="function">imap_msgno()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-uid-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
imap_stream</code></em></span><dd>
<p class="para">An IMAP stream returned by
<span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">msg_number</code></em></span>
<dd>
<p class="para">
The message number.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-uid-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The UID of the given message.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imap-uid-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function is not supported by POP3 mailboxes.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-uid-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imap-msgno.html" class="function" rel="rdfs-seeAlso">imap_msgno()</a> - Gets the message sequence number for the given UID</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-timeout.html">imap_timeout</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-undelete.html">imap_undelete</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>
