Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.mail
Class IMAPMailStrategy

java.lang.Object
  extended by com.jivesoftware.forum.mail.IMAPMailStrategy
All Implemented Interfaces:
CheckMailStrategy

public class IMAPMailStrategy
extends java.lang.Object
implements CheckMailStrategy

Mail checking strategy which uses the IMAP protocol to check an account and relies on the presence of IMAP specific features, like message flags indicating which messages have been seen. Lazily accesses message data from the server, and the connection will not be closed until EmailBatch.close() is called on the EmailBatch returned from checkForMessages(java.lang.String, int, java.lang.String, java.lang.String, boolean).


Constructor Summary
IMAPMailStrategy(EmailIntegrationProvider provider)
           
 
Method Summary
 EmailBatch checkForMessages(java.lang.String host, int port, java.lang.String user, java.lang.String password, boolean useSSL)
          Returns a list of InboundMessage objects representing new messages.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IMAPMailStrategy

public IMAPMailStrategy(EmailIntegrationProvider provider)
Method Detail

checkForMessages

public 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 a list of InboundMessage objects representing new messages.

Specified by:
checkForMessages in interface CheckMailStrategy
Parameters:
host - the address of the IMAP server.
user - the username of the account.
password - the password of the account.
useSSL - set to true to enable ssl.
Returns:
a list of InboundMessage objects representing new messages.
Throws:
javax.mail.MessagingException
java.io.IOException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.