mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 21:38:56 +00:00
143 lines
3.9 KiB
XML
143 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-setflag-full" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>imap_setflag_full</refname>
|
|
<refpurpose>Sets flags on messages</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_setflag_full</methodname>
|
|
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Causes a store to add the specified <parameter>flag</parameter> to the
|
|
flags set for the messages in the specified
|
|
<parameter>sequence</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&imap.imap-parameter.imap;
|
|
<varlistentry>
|
|
<term><parameter>sequence</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A sequence of message numbers. You can enumerate desired messages
|
|
with the <literal>X,Y</literal> syntax, or retrieve all messages
|
|
within an interval with the <literal>X:Y</literal> syntax
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flag</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The flags which you can set are <literal>\Seen</literal>,
|
|
<literal>\Answered</literal>, <literal>\Flagged</literal>,
|
|
<literal>\Deleted</literal>, and <literal>\Draft</literal> as
|
|
defined by <link xlink:href="&url.rfc;2060">RFC2060</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A bit mask that 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>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
&imap.changelog.imap-param;
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imap_setflag_full</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$mbox = imap_open("{imap.example.org: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>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>imap_clearflag_full</function></member>
|
|
</simplelist>
|
|
</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:"~/.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
|
|
-->
|