Mail_IMAP::errors()

bool errors([bool $handler = TRUE[, str $separator = "
"]])

Wrapper method for imap_errors. Gets the internal c-client error stack.

If the $handler argument is TRUE, the c-client error stack is mergered into the Mail_IMAP PEAR_ErrorStack object, if $handler is FALSE, the c-client error stack array is returned impoded, each error separated by the characters specified in the $separator argument, which is an XHTML line break and newline character by default.

If no errors are present in the c-client error stack, Mail_IMAP::errors returns FALSE. If $handler is TRUE and errors are present, Mail_IMAP::errors returns TRUE.

Method summary:

param bool $handler (optional) See above.
param str $separator (optional) See above.
return bool
access public
see imap_errors
Execution time: 0.05 seconds