jodd.mail

Class ReceiveMailSession

java.lang.Object

jodd.mail.ReceiveMailSession

public class ReceiveMailSession
extends java.lang.Object

Encapsulates email receiving session. Prepares and receives message(s). Some methods do not work on POP3 servers.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_FOLDER
protected javax.mail.Folder	folder
protected javax.mail.Session	session
protected javax.mail.Store	store

Constructor Summary

Constructors

Constructor and Description
ReceiveMailSession(javax.mail.Session session, javax.mail.Store store) Creates new mail session.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes session.
protected void	closeFolderIfOpened() Closes folder if opened and expunge deleted messages.
java.lang.String[]	getAllFolders() Returns list of all folders.
int	getDeletedMessageCount() Returns the number of deleted messages.
int	getMessageCount() Returns number of messages.
int	getNewMessageCount() Returns the number of new messages.
int	getUnreadMessageCount() Returns the number of unread messages.
void	open() Opens session.
ReceivedEmail[]	receive(EmailFilter filter, javax.mail.Flags flagsToSet) Receives all emails that matches given filter and set given flags.
ReceivedEmail[]	receiveEmail() Receives all emails.
ReceivedEmail[]	receiveEmail(EmailFilter emailFilter) Receives all emails that matches given filter.
ReceivedEmail[]	receiveEmailAndDelete() Receives all emails and mark all messages as 'seen' and 'deleted'.
ReceivedEmail[]	receiveEmailAndDelete(EmailFilter emailFilter) Receives all emails that matches given filter and mark all messages as 'seen' and 'deleted'.
ReceivedEmail[]	receiveEmailAndMarkSeen() Receives all emails and mark all messages as 'seen' (ie 'read').
ReceivedEmail[]	receiveEmailAndMarkSeen(EmailFilter emailFilter) Receives all emails that matches given filter and mark them as 'seen' (ie 'read').
void	useDefaultFolder() Opens default folder: INBOX.
void	useFolder(java.lang.String folderName) Opens new folder and closes previously opened folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FOLDER

protected static final java.lang.String DEFAULT_FOLDER

See Also:

Constant Field Values

session

protected final javax.mail.Session session

store

protected final javax.mail.Store store

folder

protected javax.mail.Folder folder

Constructor Detail

ReceiveMailSession

public ReceiveMailSession(javax.mail.Session session,
                  javax.mail.Store store)

Creates new mail session.

Method Detail

open

public void open()

Opens session.

getAllFolders

public java.lang.String[] getAllFolders()

Returns list of all folders. You can use these names in useFolder(String) method.

useFolder

public void useFolder(java.lang.String folderName)

Opens new folder and closes previously opened folder.

useDefaultFolder

public void useDefaultFolder()

Opens default folder: INBOX.

getMessageCount

public int getMessageCount()

Returns number of messages.

getNewMessageCount

public int getNewMessageCount()

Returns the number of new messages.

getUnreadMessageCount

public int getUnreadMessageCount()

Returns the number of unread messages.

getDeletedMessageCount

public int getDeletedMessageCount()

Returns the number of deleted messages.

receiveEmail

public ReceivedEmail[] receiveEmail()

Receives all emails. Messages are not modified. However, servers do may set SEEN flag anyway, so we force messages to remain unseen.

receiveEmail

public ReceivedEmail[] receiveEmail(EmailFilter emailFilter)

Receives all emails that matches given filter. Messages are not modified. However, servers do may set SEEN flag anyway, so we force messages to remain unseen.

receiveEmailAndMarkSeen

public ReceivedEmail[] receiveEmailAndMarkSeen()

Receives all emails and mark all messages as 'seen' (ie 'read').

receiveEmailAndMarkSeen

public ReceivedEmail[] receiveEmailAndMarkSeen(EmailFilter emailFilter)

Receives all emails that matches given filter and mark them as 'seen' (ie 'read').

receiveEmailAndDelete

public ReceivedEmail[] receiveEmailAndDelete()

Receives all emails and mark all messages as 'seen' and 'deleted'.

receiveEmailAndDelete

public ReceivedEmail[] receiveEmailAndDelete(EmailFilter emailFilter)

Receives all emails that matches given filter and mark all messages as 'seen' and 'deleted'.

receive

public ReceivedEmail[] receive(EmailFilter filter,
                      javax.mail.Flags flagsToSet)

Receives all emails that matches given filter and set given flags. Both filter and flags to set are optional. If flags to set is not provided, it forces 'seen' flag to be unset.

closeFolderIfOpened

protected void closeFolderIfOpened()

Closes folder if opened and expunge deleted messages.

close

public void close()

Closes session.