<!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">
<strong><code>NIL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.op-debug">
<strong><code>OP_DEBUG</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.op-readonly">
<strong><code>OP_READONLY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Open mailbox read-only
</span>
</dd>
<dt id="constant.op-anonymous">
<strong><code>OP_ANONYMOUS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Don't use or update a <var class="filename">.newsrc</var> for news
(NNTP only)
</span>
</dd>
<dt id="constant.op-shortcache">
<strong><code>OP_SHORTCACHE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.op-silent">
<strong><code>OP_SILENT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.op-prototype">
<strong><code>OP_PROTOTYPE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.op-halfopen">
<strong><code>OP_HALFOPEN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.op-expunge">
<strong><code>OP_EXPUNGE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.op-secure">
<strong><code>OP_SECURE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.cl-expunge">
<strong><code>CL_EXPUNGE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.ft-uid">
<strong><code>FT_UID</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
The parameter is a UID
</span>
</dd>
<dt id="constant.ft-peek">
<strong><code>FT_PEEK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Do not set the \Seen flag if not already set
</span>
</dd>
<dt id="constant.ft-not">
<strong><code>FT_NOT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.ft-internal">
<strong><code>FT_INTERNAL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
The return string is in internal format, will not canonicalize to CRLF.
</span>
</dd>
<dt id="constant.ft-prefetchtext">
<strong><code>FT_PREFETCHTEXT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.st-uid">
<strong><code>ST_UID</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
The sequence argument contains UIDs instead of sequence numbers
</span>
</dd>
<dt id="constant.st-silent">
<strong><code>ST_SILENT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.st-set">
<strong><code>ST_SET</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.cp-uid">
<strong><code>CP_UID</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
the sequence numbers contain UIDS
</span>
</dd>
<dt id="constant.cp-move">
<strong><code>CP_MOVE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.se-uid">
<strong><code>SE_UID</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Return UIDs instead of sequence numbers
</span>
</dd>
<dt id="constant.se-free">
<strong><code>SE_FREE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.se-noprefetch">
<strong><code>SE_NOPREFETCH</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Don't prefetch searched messages
</span>
</dd>
<dt id="constant.so-free">
<strong><code>SO_FREE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.so-noserver">
<strong><code>SO_NOSERVER</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.sa-messages">
<strong><code>SA_MESSAGES</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.sa-recent">
<strong><code>SA_RECENT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.sa-unseen">
<strong><code>SA_UNSEEN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.sa-uidnext">
<strong><code>SA_UIDNEXT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.sa-uidvalidity">
<strong><code>SA_UIDVALIDITY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.sa-all">
<strong><code>SA_ALL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.latt-noinferiors">
<strong><code>LATT_NOINFERIORS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This mailbox has no "children" (there are no
mailboxes below this one).
</span>
</dd>
<dt id="constant.latt-noselect">
<strong><code>LATT_NOSELECT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This is only a container, not a mailbox - you
cannot open it.
</span>
</dd>
<dt id="constant.latt-marked">
<strong><code>LATT_MARKED</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This mailbox is marked. Only used by UW-IMAPD.
</span>
</dd>
<dt id="constant.latt-unmarked">
<strong><code>LATT_UNMARKED</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This mailbox is not marked. Only used by
UW-IMAPD.
</span>
</dd>
<dt id="constant.latt-referral">
<strong><code>LATT_REFERRAL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This container has a referral to a remote mailbox.
</span>
</dd>
<dt id="constant.latt-haschildren">
<strong><code>LATT_HASCHILDREN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This mailbox has selectable inferiors.
</span>
</dd>
<dt id="constant.latt-hasnochildren">
<strong><code>LATT_HASNOCHILDREN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
This mailbox has no selectable inferiors.
</span>
</dd>
<dt id="constant.sortdate">
<strong><code>SORTDATE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.sortarrival">
<strong><code>SORTARRIVAL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.sortfrom">
<strong><code>SORTFROM</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.sortsubject">
<strong><code>SORTSUBJECT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.sortto">
<strong><code>SORTTO</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.sortcc">
<strong><code>SORTCC</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.sortsize">
<strong><code>SORTSIZE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<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 id="constant.typetext">
<strong><code>TYPETEXT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: unformatted text
</span>
</dd>
<dt id="constant.typemultipart">
<strong><code>TYPEMULTIPART</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: multiple part
</span>
</dd>
<dt id="constant.typemessage">
<strong><code>TYPEMESSAGE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: encapsulated message
</span>
</dd>
<dt id="constant.typeapplication">
<strong><code>TYPEAPPLICATION</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: application data
</span>
</dd>
<dt id="constant.typeaudio">
<strong><code>TYPEAUDIO</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: audio
</span>
</dd>
<dt id="constant.typeimage">
<strong><code>TYPEIMAGE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: static image
</span>
</dd>
<dt id="constant.typevideo">
<strong><code>TYPEVIDEO</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: video
</span>
</dd>
<dt id="constant.typemodel">
<strong><code>TYPEMODEL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: model
</span>
</dd>
<dt id="constant.typeother">
<strong><code>TYPEOTHER</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Primary body type: unknown
</span>
</dd>
<dt id="constant.enc7bit">
<strong><code>ENC7BIT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Body encoding: 7 bit SMTP semantic data
</span>
</dd>
<dt id="constant.enc8bit">
<strong><code>ENC8BIT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Body encoding: 8 bit SMTP semantic data
</span>
</dd>
<dt id="constant.encbinary">
<strong><code>ENCBINARY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Body encoding: 8 bit binary data
</span>
</dd>
<dt id="constant.encbase64">
<strong><code>ENCBASE64</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Body encoding: base-64 encoded data
</span>
</dd>
<dt id="constant.encquotedprintable">
<strong><code>ENCQUOTEDPRINTABLE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Body encoding: human-readable 8-as-7 bit data
</span>
</dd>
<dt id="constant.encother">
<strong><code>ENCOTHER</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Body encoding: unknown
</span>
</dd>
<dt id="constant.imap-opentimeout">
<strong><code>IMAP_OPENTIMEOUT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.imap-readtimeout">
<strong><code>IMAP_READTIMEOUT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.imap-writetimeout">
<strong><code>IMAP_WRITETIMEOUT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.imap-closetimeout">
<strong><code>IMAP_CLOSETIMEOUT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
</span>
</dd>
<dt id="constant.imap-gc-elt">
<strong><code>IMAP_GC_ELT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Garbage collector, clear message cache elements.
</span>
</dd>
<dt id="constant.imap-gc-env">
<strong><code>IMAP_GC_ENV</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Garbage collector, clear envelopes and bodies.
</span>
</dd>
<dt id="constant.imap-gc-texts">
<strong><code>IMAP_GC_TEXTS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Garbage collector, clear texts.
</span>
</dd>
</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>
