imap_setflag_full

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_setflag_full — Устанавливает флаги на сообщения

Описание

imap_setflag_full(
    IMAP\Connection $imap,
    string $sequence,
    string $flag,
    int $options = 0
): true

Сообщает серверу, что надо добавить флаг flag к набору флагов, заданным в sequence сообщениям.

Список параметров

imap

Экземпляр класса IMAP\Connection.

sequence

Последовательность номеров сообщений.Вы можете перечислить несколько сообщений, используя как разделитель запятую (X,Y), или задать интервал сообщений с помощью двоеточия X:Y

flag

Флаги, которые можно установить: \Seen, \Answered, \Flagged, \Deleted и \Draft, как определено в » RFC2060.

options

Битовая маска, которая может принимать только одно значение:

  • ST_UID - последовательность сообщений задана не их номерами, а с помощью UID

Возвращаемые значения

Функция возвращает логическое значение true.

Ошибки

Выбрасывает исключение ValueError, если значение параметра options недопустимо.

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.
8.0.0 Теперь выбрасывается исключение ValueError при недопустимых значениях параметра options. Ранее возникало предупреждение и функция возвращала логическое значение false.

Примеры

Пример #1 Пример использования imap_setflag_full()

<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password")
or die("не удалось подключиться: " . imap_last_error());

$status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged");

echo gettype($status) . "\n";
echo $status . "\n";

imap_close($mbox);
?>

Смотрите также