PHP - Manual: imap_setflag_full

2024-12-21

imap_setflag_full

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

imap_setflag_full — Sets flags on messages

说明

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

Causes a store to add the specified flag to the flags set for the messages in the specified sequence.

参数

imap

IMAP\Connection 实例。

sequence

A sequence of message numbers. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an interval with the X:Y syntax

flag

The flags which you can set are \Seen, \Answered, \Flagged, \Deleted, and \Draft as defined by » RFC2060.

options

A bit mask that may contain the single option:

ST_UID - The sequence argument contains UIDs instead of sequence numbers

返回值

成功时返回 true，或者在失败时返回 false。

更新日志

版本	说明
8.1.0	现在 `imap` 参数接受 IMAP\Connection 实例，之前接受资源(resource)。

范例

示例 #1 imap_setflag_full() example


<?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);
?>

参见

imap_clearflag_full() - Clears flags on messages

add a note

User Contributed Notes 10 notes

down

AJCartmell at ricardo dot com ¶

20 years ago


Spent ages trying to get this to work, then eventually remembered I had opened the mailbox READONLY - obviously you need write permission for setting flags!

down

daniel dot blackburn at galorwebservices dot com ¶

11 years ago


Where possible I would avoid using POP3 accounts. My host allowed me to upgrade to IMAP and it is so much easier. I think the only way to accurately create any form of mail client with POP3 is to download the messages into an SQL database which is a big task to start with, considering the IMAP standards have the functionality we need built in.
I experimented with flag setting in POP3 and it seems they do not stick at all, and it is almost impossible to retrieve the number of unread messages (ie. the Seen / Unseen thing does not work)
Converted to IMAP and it's working - the majority of the functions in this section seem to be IMAP focussed and WILL NOT generally work with POP3

down

php AT holtsmark DOT no ¶

20 years ago


Use the imap_clearflag_full function if you want to unset the \Seen flag.

http://www.php.net/manual/en/function.imap-clearflag-full.php

down

ming0 at mailinator dot com ¶

11 years ago


To correct phpidiot at avanca-a dot de

<?php

imap_setflag_full($mbox, '1', 'label1');

?>

down

phpidiot at avanca-a dot de ¶

12 years ago


"Keywords" aka "tags" aka "PERMANENTFLAGS" can be added if your server supports IMAP 4rev1 by using $label{label-nr}:

<?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", "\$label1");

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

imap_close($mbox);
?>

down

death at metalfield dot com ¶

21 years ago


Indeed POP3 does not support flags that indicate the "newness" of a message. There are other ways to work around this problem, though. For one, I have seen mail delivery systems that will add a header field Status: to indicate its status (see RFC2076). Another way most email clients and mail fetching programs seem to use is to keep a local list of UID's of messages that are downloaded. Upon fetching mail, the UID's of the messages can be checked against this list to see if it was already downloaded. POP3 supports a command UIDL to get a list of all UID's, but I doubt the IMAP lib uses this command. The only thing I know of that will thrash this work-around is the use of multiple mail clients. If another mail client fetches mail from the server, the first client has no way of knowing it has been downloaded.

down

-3

simoned at eisa dot net dot au ¶

22 years ago


I've finally managed to get some action out of this function. Here is some code that might work help some people out:


$headers = imap_headers($link); 

for($x=0; $x < count($headers); $x++) { 

    $id = substr($headers[$x],5,4);

    imap_setflag_full($link,imap_uid($link,$id),'\\SEEN',SE_UID);

}


Good luck.

down

-4

todsah at arise dot nl ¶

21 years ago


According to the rfc, pop3 does not have support for these flags, except perhaps for the deleted flag. I haven't tried if the delete flag works on pop3 or not.

down

-7

calmdown at abendstille dot at ¶

19 years ago


The imap_setflag_full-function works with pop3 as long as the connection is NOT closed. if you make

imap_setflag_full($mbox, imap_uid($mbox, 0), "\\Seen \\Flagged", ST_UID);
    
print_r( imap_headerinfo($mbox, 0) );

you see the flags set, but if you call the box again with another script, the flags are empty again.
I tried this on a WinNT (*ugly*) with IIS 4.0 and a running POP3-server with PHP 4.3.

down

-4

msh at onliners dot dk ¶

20 years ago


In reply to:
todsah@arise.nl
13-Oct-2000 06:51

The pop3 does indeed support the deleted flag - I have been working with the IMAP functions connection to a POP3 server this past week and lucky me it works.

add a note

官方地址：https://www.php.net/manual/en/function.imap-setflag-full.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络数据库 JAVA 面试 NoSQL C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 adodb手册 ADORecordSet对象 opcache预加载 Composer的Packagist资源 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet PHP json解析（json_decode）页面工具 mysql面试题 [原创]诡异的php-fpm超时问题 php中几种注释规范纯php实现DES以及TripleDES加密算法 php 修改图片大小支持php7的性能采集扩展 [鸟哥]PHP FFI详解 - 一种全新的PHP扩展方式

略微加速

PHP官方手册 - 互联网笔记

imap_setflag_full

说明

参数

返回值

更新日志

范例

参见

User Contributed Notes 10 notes