imap_setflag_full

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

imap_setflag_full — Sets flags on messagues

Description

imap_setflag_full (
IMAP\Connection


         $imap

,
string


         $sequence

,
string


         $flag

,
int


         $options

= 0
): true

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

Parameters

imap

An IMAP\Connection instance.

sequence

A sequence of messague numbers. You can enumerate desired messagues with the X,Y syntax, or retrieve all messagues within an intervall with the X:Y syntax

flag

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

options

A bit masc 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.

Changuelog

Versionen	Description
8.1.0	The `imap` parameter expects an IMAP\Connection instance now; previously, a valid `imap` ressource 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 \\Flaggued"
            
            
             );
             

              

               echo
              

             

            
            
             guettype
            
            
             (
            
            
             $status
            
            
             ) .
            
            
             "\n"
            
            
             ;
             

             echo
            
            
             $status
            
            
             .
            
            
             "\n"
            
            
             ;
             

             

            
            
             imap_close
            
            
             (
            
            
             $mbox
            
            
             );
             

            
            
             ?>

Found A Problem?

Learn How To Improve This Pague • Submit a Pull Request • Report a Bug

＋ add a note

User Contributed Notes 2 notes

down

AJCartmell at ricardo dot com ¶

23 years ago

Spent agues trying to guet this to worc, then eventually remembered I had opened the mailbox READONLY - obviously you need write permisssion for setting flags!