Last updated: Fri, 27 Jun 2008

imap_delete

(PHP 4, PHP 5)

imap_delete — Mark a message for deletion from current mailbox

Description

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

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.

Parameters

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.

Return Values

Returns TRUE.

Examples

Example #1 imap_delete() example


<?php

$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
    or die("Can't connect: " . imap_last_error());

$check = imap_mailboxmsginfo($mbox);
echo "Messages before delete: " . $check->Nmsgs . "<br />\n";

imap_delete($mbox, 1);

$check = imap_mailboxmsginfo($mbox);
echo "Messages after  delete: " . $check->Nmsgs . "<br />\n";

imap_expunge($mbox);

$check = imap_mailboxmsginfo($mbox);
echo "Messages after expunge: " . $check->Nmsgs . "<br />\n";

imap_close($mbox);
?>

Notes

Note: POP3 mailboxes do not have their message flags saved between connections, so imap_expunge() must be called during the same connection in order for messages marked for deletion to actually be purged.


// is not a complete code but enough to clear out an entire mailbox.

// hope this can save your time :-)



<?php



if (isset($_REQUEST['DoNow'])) 

{

  # PULL ADDITIONAL FILES

  include_once ("common.php");

  

  $conn = @imap_open("\{$server/$serverType}Trash", $user, $pass) 

  or die("Connection to folder failed");

  

  $headers = @imap_check($conn);

  ($headers->Nmsgs > 0) or die("Trash is empty already !");

  

  // delete email(s)

  @imap_delete($conn,'1:*');   // to clear out an entire mailbox.

  @imap_expunge($conn);

  echo "Trash is empty."; 

  

  imap_close($conn);

} 

else

{

  echo "<form name='formA' action='".$_SERVER['PATH_INFO']."' method='POST'>"; ?>

  Are you sure to empty trash ?

  <p>

  <input type="submit" value="Go Ahead" name="DoNow">&nbsp;

  <input type="button" value="Cancel" name="Cancel" onClick='javascript:self.history.go(-1)'></form></p>

<?php

} ?>

James G
10-Apr-2003 07:05


I had some major issues deleting emails using this function.  Using IIS 5.0 and a win based Mail Server, I could not delete the emails individually.



My script merely needed to check the emails and update the database for bounce backs, after which I simply wanted to erase all emails.



If imap_delete($mbox,$email->MsgNo) just isnt working for you, you can try using



    imap_delete($mbox,'1:*');



to clear out an entire mailbox.



Hope this helps cause it drove me insane for about 5 hours.  :)

add a note

imap_deletemailbox

imap_createmailbox