Mail_IMAP::alerts()
- Home
- ->Mail_IMAP - A Webmail API for PHP
- ->Mail_IMAP Source Code
- ->Mail_IMAP::alerts()
bool alerts([bool $handler = TRUE[, str $separator = "<br />n"]])
Wrapper method for imap_alerts. Gets the internal c-client alert stack.
If the $handler argument is TRUE, the c-client alert stack is mergered into the Mail_IMAP PEAR_ErrorStack object, if $handler is FALSE, the c-client alert stack array is returned impoded, each alert separated by the characters specified in the $separator argument, which is an XHTML line break and newline character by default.
If no alerts are present in the c-client alert stack, Mail_IMAP::alerts returns FALSE. If $handler is TRUE and alerts are present, Mail_IMAP::alerts returns TRUE.
Method summary:
| param | bool | $handler (optional) See above. |
| param | str | $separator (optional) See above. |
| return | bool | |
| access | public | |
| see | imap_alerts | |
Posted: 05/21/06 03:05 pm by Richard York
