You are here

function mailhandler_mailbox_stream_delete in Mailhandler 6

Delete a message in the stream connection.

Parameters

$stream stream openned using mailhandler_mailbox_stream_open().:

$msgno number of message to delete.:

Return value

boolean result of deleting operation

Related topics

Mailbox stream functions.: Functions used to handle mailbox streams. These functions are responsible of connecting or opening mailboxes, reading status and messages and remove the processed entries.

File

./mailhandler.module, line 618: Mailhandler module code.

Code

function mailhandler_mailbox_stream_delete($stream, $msgno = 0) {
  $result = imap_delete($stream, $msgno);

  // Record debug information about stream closing operation.
  mailhandler_watchdog_record('Delete message %msgno : %result.', array(
    '%result' => !imap_last_error(),
    '%msgno' => $msgno,
  ), WATCHDOG_DEBUG);
  return $result;
}