Mail_IMAP::setFlags()
- Home
- ->Mail_IMAP::setFlags()
bool setFlags(array $mids, array $flags[, str $action = 'set'])
Sets or clears flags using imap_setflag_full or imap_clearflag_full.
Accepts an array of message ids in the $mids argument and an array of flags to set on those messages in the $flags argument. The $action argument may be one of set|clear and it's used to toggle between imap_setflag_full and imap_clearflag_full.
Method summary:
| param | array | $mids See above. |
| param | array | $flags See above. |
| param | str | $action (optional) See above. |
| return | bool | |
| throws | ErrorStack: Argument requires array. | Both the $mids argument and $flags argument must be arrays. |
| throws | ErrorStack: Invalid action. | The $action argument must be one of 'set' or 'clear'. |
| access | public | |
| see | imap_setflag_full imap_clearflag_full |
|
Posted: 04/22/07 03:04 pm by Richard York
