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!
imap_setflag_full
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_setflag_full — Sets flags on messages
Description
Causes a store to add the specified flag to the
flags set for the messages in the specified
sequence.
Parameters
-
imap -
An IMAP\Connection instance.
-
sequence -
A sequence of message numbers. You can enumerate desired messages with the
X,Ysyntax, or retrieve all messages within an interval with theX:Ysyntax -
flag -
The flags which you can set are
\Seen,\Answered,\Flagged,\Deleted, and\Draftas defined by » RFC2060. -
options -
A bit mask that may contain the single option:
-
ST_UID- The sequence argument contains UIDs instead of sequence numbers
-
Return Values
Always returns true.
Errors/Exceptions
Throws a ValueError if options
is invalid.
Changelog
| Version | Description |
|---|---|
| 8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap resource was expected.
|
| 8.0.0 |
A ValueError is now thrown on invalid
options parameter values. Previously,
a warning was emitted and the function returned false.
|
Examples
Example #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);
?>
add a note
User Contributed Notes 10 notes
AJCartmell at ricardo dot com ¶
22 years ago
daniel dot blackburn at galorwebservices dot com ¶
14 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
ming0 at mailinator dot com ¶
14 years ago
To correct phpidiot at avanca-a dot de
<?php
imap_setflag_full($mbox, '1', 'label1');
?>
php AT holtsmark DOT no ¶
22 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
death at metalfield dot com ¶
23 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.
simoned at eisa dot net dot au ¶
24 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.
phpidiot at avanca-a dot de ¶
15 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);
?>
todsah at arise dot nl ¶
24 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.
calmdown at abendstille dot at ¶
21 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.
msh at onliners dot dk ¶
22 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.
