Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.mail
Class EmailBatch

java.lang.Object
  extended by com.jivesoftware.forum.mail.EmailBatch

public class EmailBatch
extends java.lang.Object

Represents a batch of incoming mail, and associated external resources. Much like a ResultSet, instances of this class must be closed once the messages it contains have been processed, so it is best to use with a try/finally pair.


Method Summary
 void close()
          Closes the underlying folder and store, causing changes to message flags to be applied on the server.
 java.util.Iterator getMessages()
          Returns an iterator of (@link Message} instances.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getMessages

public java.util.Iterator getMessages()
Returns an iterator of (@link Message} instances.

Returns:
an iterator of (@link Message} instances.

close

public void close()
Closes the underlying folder and store, causing changes to message flags to be applied on the server.


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.