mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
8214cac81b
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166691 c90b9560-bf6c-de11-be94-00142212c4b1
85 lines
2.5 KiB
XML
85 lines
2.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.imap-setflag-full">
|
|
<refnamediv>
|
|
<refname>imap_setflag_full</refname>
|
|
<refpurpose>Sets flags on messages</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_setflag_full</methodname>
|
|
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function causes a store to add the specified
|
|
<parameter>flag</parameter> to the flags set for the messages
|
|
in the specified <parameter>sequence</parameter>.
|
|
</para>
|
|
<para>
|
|
The flags which you can set are "\\Seen", "\\Answered",
|
|
"\\Flagged", "\\Deleted", and "\\Draft" (as defined
|
|
by RFC2060).
|
|
</para>
|
|
<para>
|
|
<parameter>options</parameter> are a bit mask and may contain
|
|
the single option:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>ST_UID</constant> - The sequence argument contains UIDs
|
|
instead of sequence numbers
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>imap_setflag_full</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$mbox = imap_open("{your.imap.host:143}", "username", "password")
|
|
or die("can't connect: " . imap_last_error());
|
|
|
|
$status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged");
|
|
|
|
echo gettype($status) . "\n";
|
|
echo $status . "\n";
|
|
|
|
imap_close($mbox);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also: <function>imap_clearflag_full</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- 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:"../../../../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
|
|
-->
|