You are here

function mailhandler_mailbox_stream_close in Mailhandler 6

Close stream connection.

Parameters

$stream: stream openned using mailhandler_mailbox_stream_open().

Return value

boolean result of closing 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.

1 call to mailhandler_mailbox_stream_close()

mailhandler_mailbox_test in ./mailhandler.module: Test the connection to a mailbox.

File

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

Code

function mailhandler_mailbox_stream_close($stream) {
  $result = imap_close($stream);

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