Mailbox EventHandler
Overview
This EventHandler listens for changes in a mailbox. Depending on the
protocol the handler will either poll the mailbox periodically by reconnecting
to the mailbox (pop3) or periodically issue idle messages on the connection
(imap4).
Example
Demo package containing ready to run configurations for the Mailbox
EventHandler here.
Configuration
Parameter |
Description |
class |
com.architech.switchboard.MailboxSwitchboard |
mailServer |
The mail server hosting the mailbox |
mailUser |
The user name |
mailPassword |
The password for mailUser |
mailFolder |
The mail folder to monitor. For POP3 this can
only be INBOX. For IMAP4 servers this can be any folder available on the
server. |
pollInterval |
Number of seconds between each poll. Be aware
that for POP3 this will incur a new connection each time. |
mailProtocol |
Specify pop3 or imap. |
Objects/Properties/Attributes
The EventHandler sets the following event properties:
Property |
Description |
event.originator |
The EventHandler object. |
mailbox.session |
The Java session object ( javax.mail.Session ) |
mailbox.store |
The message store object ( javax.mail.Store ) |
mailbox.folder |
The folder object ( javax.mail.Folder ) |
mailbox.message |
The message object ( javax.mail.Message ) |
mailbox.operation |
The operation related to mailbox.message. For pop3
connections only existing entries are reported. For imap
connections this property will contain the value new or deleted. |
mail.subject |
The subject header from the mail.message |
mail.from |
The from header from the mail.message |
mail.to |
The first recipient in the mail.message |
Downloads
Included in base product since 4.0.3
See Also
EventHandler
Overview
|