Home > PHP > Function > IMAP > imap_delete()

imap_delete()

imap_delete - Mark a message for deletion from current mailbox

Syntax

bool imap_delete (resource $imap_stream, int $msg_number, int $options)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • msg_number - The message number
  • options - You can set the FT_UID which tells the function to treat the msg_number argument as an UID.

Description

Marks messages listed in msg_number 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.

Version

PHP 4, 5

Return value

Returns TRUE.