imap_delete
Marks messages listed in message_nums for deletion. Messages marked for deletion will stay in the mailbox until either imap_expunge is called or imap_close is called with the optional parameter CL_EXPUNGE.
Parameters
- imap
An IMAP\Connection instance.
- message_nums
-
A string representing one or more messages in IMAP4-style sequence format ("n", "n:m", or combination of these delimited by commas).
- flags
-
You can set the FT_UID which tells the function to treat the message_nums argument as a UID.
Return Values
Returns true.
Notes
Note:
IMAP mailboxes may not have their message flags saved between connections, so imap_expunge should be called during the same connection in order to guarantee that messages marked for deletion will actually be purged.
Changelog
| Version | Description |
| 8.1.0 | The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected. |