Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.mail
Interface CheckMailStrategy

All Known Implementing Classes:
IMAPMailStrategy, POP3MailStrategy

public interface CheckMailStrategy

Strategy interface use by EmailMonitor to check an email account. Different implementations exist for the two major email client protocols - POP3MailStrategy checks a POP3 account, and IMAPMailStrategy checks an IMAP account.

See Also:
EmailMonitor

Method Summary
 EmailBatch checkForMessages(java.lang.String host, int port, java.lang.String user, java.lang.String password, boolean useSSL)
          Returns an EmailBatch representing new messages.
 

Method Detail

checkForMessages

EmailBatch checkForMessages(java.lang.String host,
                            int port,
                            java.lang.String user,
                            java.lang.String password,
                            boolean useSSL)
                            throws javax.mail.MessagingException,
                                   java.io.IOException
Returns an EmailBatch representing new messages. Once the messages it contains have been processed, it is necessary to call EmailBatch.close() on the return value of this method.

Parameters:
host - the address of the server.
user - the username of the account.
password - the password of the account.
useSSL - set to true to enable ssl.
Returns:
an EmailBatch representing new messages.
Throws:
javax.mail.MessagingException
java.io.IOException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.