php-doc-en/reference/imap/constants.xml
Jakub Vrana 4de5cce5d8 Linkable reference constants
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323624 c90b9560-bf6c-de11-be94-00142212c4b1
2012-02-28 13:22:09 +00:00

791 lines
16 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="imap.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry xml:id="constant.nil">
<term>
<constant>NIL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-debug">
<term>
<constant>OP_DEBUG</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-readonly">
<term>
<constant>OP_READONLY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Open mailbox read-only
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-anonymous">
<term>
<constant>OP_ANONYMOUS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Don't use or update a <filename>.newsrc</filename> for news
(NNTP only)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-shortcache">
<term>
<constant>OP_SHORTCACHE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-silent">
<term>
<constant>OP_SILENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-prototype">
<term>
<constant>OP_PROTOTYPE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-halfopen">
<term>
<constant>OP_HALFOPEN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
For <acronym>IMAP</acronym> and <acronym>NNTP</acronym>
names, open a connection but don't open a mailbox.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-expunge">
<term>
<constant>OP_EXPUNGE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.op-secure">
<term>
<constant>OP_SECURE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.cl-expunge">
<term>
<constant>CL_EXPUNGE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
silently expunge the mailbox before closing when
calling <function>imap_close</function>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ft-uid">
<term>
<constant>FT_UID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
The parameter is a UID
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ft-peek">
<term>
<constant>FT_PEEK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Do not set the \Seen flag if not already set
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ft-not">
<term>
<constant>FT_NOT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ft-internal">
<term>
<constant>FT_INTERNAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
The return string is in internal format, will not canonicalize to CRLF.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ft-prefetchtext">
<term>
<constant>FT_PREFETCHTEXT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.st-uid">
<term>
<constant>ST_UID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
The sequence argument contains UIDs instead of sequence numbers
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.st-silent">
<term>
<constant>ST_SILENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.st-set">
<term>
<constant>ST_SET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.cp-uid">
<term>
<constant>CP_UID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
the sequence numbers contain UIDS
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.cp-move">
<term>
<constant>CP_MOVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Delete the messages from the current mailbox after copying
with <function>imap_mail_copy</function>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.se-uid">
<term>
<constant>SE_UID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Return UIDs instead of sequence numbers
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.se-free">
<term>
<constant>SE_FREE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.se-noprefetch">
<term>
<constant>SE_NOPREFETCH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Don't prefetch searched messages
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.so-free">
<term>
<constant>SO_FREE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.so-noserver">
<term>
<constant>SO_NOSERVER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sa-messages">
<term>
<constant>SA_MESSAGES</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sa-recent">
<term>
<constant>SA_RECENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sa-unseen">
<term>
<constant>SA_UNSEEN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sa-uidnext">
<term>
<constant>SA_UIDNEXT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sa-uidvalidity">
<term>
<constant>SA_UIDVALIDITY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sa-all">
<term>
<constant>SA_ALL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-noinferiors">
<term>
<constant>LATT_NOINFERIORS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This mailbox has no "children" (there are no
mailboxes below this one).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-noselect">
<term>
<constant>LATT_NOSELECT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This is only a container, not a mailbox - you
cannot open it.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-marked">
<term>
<constant>LATT_MARKED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This mailbox is marked. Only used by UW-IMAPD.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-unmarked">
<term>
<constant>LATT_UNMARKED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This mailbox is not marked. Only used by
UW-IMAPD.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortdate">
<term>
<constant>SORTDATE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
message Date
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortarrival">
<term>
<constant>SORTARRIVAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
arrival date
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortfrom">
<term>
<constant>SORTFROM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
mailbox in first From address
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortsubject">
<term>
<constant>SORTSUBJECT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
message subject
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortto">
<term>
<constant>SORTTO</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
mailbox in first To address
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortcc">
<term>
<constant>SORTCC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
mailbox in first cc address
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sortsize">
<term>
<constant>SORTSIZE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Sort criteria for <function>imap_sort</function>:
size of message in octets
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typetext">
<term>
<constant>TYPETEXT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typemultipart">
<term>
<constant>TYPEMULTIPART</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typemessage">
<term>
<constant>TYPEMESSAGE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typeapplication">
<term>
<constant>TYPEAPPLICATION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typeaudio">
<term>
<constant>TYPEAUDIO</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typeimage">
<term>
<constant>TYPEIMAGE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typevideo">
<term>
<constant>TYPEVIDEO</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typeother">
<term>
<constant>TYPEOTHER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.enc7bit">
<term>
<constant>ENC7BIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.enc8bit">
<term>
<constant>ENC8BIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.encbinary">
<term>
<constant>ENCBINARY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.encbase64">
<term>
<constant>ENCBASE64</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.encquotedprintable">
<term>
<constant>ENCQUOTEDPRINTABLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.encother">
<term>
<constant>ENCOTHER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-opentimeout">
<term>
<constant>IMAP_OPENTIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-readtimeout">
<term>
<constant>IMAP_READTIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-writetimeout">
<term>
<constant>IMAP_WRITETIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-closetimeout">
<term>
<constant>IMAP_CLOSETIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-referral">
<term>
<constant>LATT_REFERRAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-haschildren">
<term>
<constant>LATT_HASCHILDREN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.latt-hasnochildren">
<term>
<constant>LATT_HASNOCHILDREN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.typemodel">
<term>
<constant>TYPEMODEL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-gc-elt">
<term>
<constant>IMAP_GC_ELT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Garbage collector, clear message cache elements.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-gc-env">
<term>
<constant>IMAP_GC_ENV</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Garbage collector, clear envelopes and bodies.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.imap-gc-texts">
<term>
<constant>IMAP_GC_TEXTS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Garbage collector, clear texts.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- 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
-->