<!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>Predefined Constants</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="imap.resources.html">Resource Types</a></div> <div class="next" style="text-align: right; float: right;"><a href="ref.imap.html">IMAP Functions</a></div> <div class="up"><a href="book.imap.html">IMAP</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="imap.constants" class="appendix"> <h1>Predefined Constants</h1> <p class="simpara"> The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime. </p> <dl> <dt id="constant.nil"> <span class="term"> <strong><code>NIL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.op-debug"> <span class="term"> <strong><code>OP_DEBUG</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.op-readonly"> <span class="term"> <strong><code>OP_READONLY</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Open mailbox read-only </span> </dd> </dt> <dt id="constant.op-anonymous"> <span class="term"> <strong><code>OP_ANONYMOUS</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Don't use or update a <var class="filename">.newsrc</var> for news (NNTP only) </span> </dd> </dt> <dt id="constant.op-shortcache"> <span class="term"> <strong><code>OP_SHORTCACHE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.op-silent"> <span class="term"> <strong><code>OP_SILENT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.op-prototype"> <span class="term"> <strong><code>OP_PROTOTYPE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.op-halfopen"> <span class="term"> <strong><code>OP_HALFOPEN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> 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> </dd> </dt> <dt id="constant.op-expunge"> <span class="term"> <strong><code>OP_EXPUNGE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.op-secure"> <span class="term"> <strong><code>OP_SECURE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.cl-expunge"> <span class="term"> <strong><code>CL_EXPUNGE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> silently expunge the mailbox before closing when calling <span class="function"><a href="function.imap-close.html" class="function">imap_close()</a></span> </span> </dd> </dt> <dt id="constant.ft-uid"> <span class="term"> <strong><code>FT_UID</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> The parameter is a UID </span> </dd> </dt> <dt id="constant.ft-peek"> <span class="term"> <strong><code>FT_PEEK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Do not set the \Seen flag if not already set </span> </dd> </dt> <dt id="constant.ft-not"> <span class="term"> <strong><code>FT_NOT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.ft-internal"> <span class="term"> <strong><code>FT_INTERNAL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> The return string is in internal format, will not canonicalize to CRLF. </span> </dd> </dt> <dt id="constant.ft-prefetchtext"> <span class="term"> <strong><code>FT_PREFETCHTEXT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.st-uid"> <span class="term"> <strong><code>ST_UID</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> The sequence argument contains UIDs instead of sequence numbers </span> </dd> </dt> <dt id="constant.st-silent"> <span class="term"> <strong><code>ST_SILENT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.st-set"> <span class="term"> <strong><code>ST_SET</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.cp-uid"> <span class="term"> <strong><code>CP_UID</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> the sequence numbers contain UIDS </span> </dd> </dt> <dt id="constant.cp-move"> <span class="term"> <strong><code>CP_MOVE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Delete the messages from the current mailbox after copying with <span class="function"><a href="function.imap-mail-copy.html" class="function">imap_mail_copy()</a></span> </span> </dd> </dt> <dt id="constant.se-uid"> <span class="term"> <strong><code>SE_UID</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Return UIDs instead of sequence numbers </span> </dd> </dt> <dt id="constant.se-free"> <span class="term"> <strong><code>SE_FREE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.se-noprefetch"> <span class="term"> <strong><code>SE_NOPREFETCH</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Don't prefetch searched messages </span> </dd> </dt> <dt id="constant.so-free"> <span class="term"> <strong><code>SO_FREE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.so-noserver"> <span class="term"> <strong><code>SO_NOSERVER</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.sa-messages"> <span class="term"> <strong><code>SA_MESSAGES</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.sa-recent"> <span class="term"> <strong><code>SA_RECENT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.sa-unseen"> <span class="term"> <strong><code>SA_UNSEEN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.sa-uidnext"> <span class="term"> <strong><code>SA_UIDNEXT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.sa-uidvalidity"> <span class="term"> <strong><code>SA_UIDVALIDITY</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.sa-all"> <span class="term"> <strong><code>SA_ALL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.latt-noinferiors"> <span class="term"> <strong><code>LATT_NOINFERIORS</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> This mailbox has no "children" (there are no mailboxes below this one). </span> </dd> </dt> <dt id="constant.latt-noselect"> <span class="term"> <strong><code>LATT_NOSELECT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> This is only a container, not a mailbox - you cannot open it. </span> </dd> </dt> <dt id="constant.latt-marked"> <span class="term"> <strong><code>LATT_MARKED</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> This mailbox is marked. Only used by UW-IMAPD. </span> </dd> </dt> <dt id="constant.latt-unmarked"> <span class="term"> <strong><code>LATT_UNMARKED</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> This mailbox is not marked. Only used by UW-IMAPD. </span> </dd> </dt> <dt id="constant.sortdate"> <span class="term"> <strong><code>SORTDATE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: message Date </span> </dd> </dt> <dt id="constant.sortarrival"> <span class="term"> <strong><code>SORTARRIVAL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: arrival date </span> </dd> </dt> <dt id="constant.sortfrom"> <span class="term"> <strong><code>SORTFROM</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: mailbox in first From address </span> </dd> </dt> <dt id="constant.sortsubject"> <span class="term"> <strong><code>SORTSUBJECT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: message subject </span> </dd> </dt> <dt id="constant.sortto"> <span class="term"> <strong><code>SORTTO</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: mailbox in first To address </span> </dd> </dt> <dt id="constant.sortcc"> <span class="term"> <strong><code>SORTCC</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: mailbox in first cc address </span> </dd> </dt> <dt id="constant.sortsize"> <span class="term"> <strong><code>SORTSIZE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Sort criteria for <span class="function"><a href="function.imap-sort.html" class="function">imap_sort()</a></span>: size of message in octets </span> </dd> </dt> <dt id="constant.typetext"> <span class="term"> <strong><code>TYPETEXT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typemultipart"> <span class="term"> <strong><code>TYPEMULTIPART</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typemessage"> <span class="term"> <strong><code>TYPEMESSAGE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typeapplication"> <span class="term"> <strong><code>TYPEAPPLICATION</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typeaudio"> <span class="term"> <strong><code>TYPEAUDIO</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typeimage"> <span class="term"> <strong><code>TYPEIMAGE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typevideo"> <span class="term"> <strong><code>TYPEVIDEO</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typeother"> <span class="term"> <strong><code>TYPEOTHER</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.enc7bit"> <span class="term"> <strong><code>ENC7BIT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.enc8bit"> <span class="term"> <strong><code>ENC8BIT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.encbinary"> <span class="term"> <strong><code>ENCBINARY</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.encbase64"> <span class="term"> <strong><code>ENCBASE64</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.encquotedprintable"> <span class="term"> <strong><code>ENCQUOTEDPRINTABLE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.encother"> <span class="term"> <strong><code>ENCOTHER</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.imap-opentimeout"> <span class="term"> <strong><code>IMAP_OPENTIMEOUT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.imap-readtimeout"> <span class="term"> <strong><code>IMAP_READTIMEOUT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.imap-writetimeout"> <span class="term"> <strong><code>IMAP_WRITETIMEOUT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.imap-closetimeout"> <span class="term"> <strong><code>IMAP_CLOSETIMEOUT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.latt-referral"> <span class="term"> <strong><code>LATT_REFERRAL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.latt-haschildren"> <span class="term"> <strong><code>LATT_HASCHILDREN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.latt-hasnochildren"> <span class="term"> <strong><code>LATT_HASNOCHILDREN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.typemodel"> <span class="term"> <strong><code>TYPEMODEL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.imap-gc-elt"> <span class="term"> <strong><code>IMAP_GC_ELT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Garbage collector, clear message cache elements. </span> </dd> </dt> <dt id="constant.imap-gc-env"> <span class="term"> <strong><code>IMAP_GC_ENV</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Garbage collector, clear envelopes and bodies. </span> </dd> </dt> <dt id="constant.imap-gc-texts"> <span class="term"> <strong><code>IMAP_GC_TEXTS</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Garbage collector, clear texts. </span> </dd> </dt> </dl> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="imap.resources.html">Resource Types</a></div> <div class="next" style="text-align: right; float: right;"><a href="ref.imap.html">IMAP Functions</a></div> <div class="up"><a href="book.imap.html">IMAP</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>