org.jasig.portlet.emailpreview.dao.javamail

Class JavamailAccountDaoImpl

java.lang.Object

org.jasig.portlet.emailpreview.dao.javamail.JavamailAccountDaoImpl

All Implemented Interfaces:

IMailAccountDao

@Component
public final class JavamailAccountDaoImpl
extends Object
implements IMailAccountDao

This class accesses the Javamail host for mailbox operations. NOTE: With Javamail, uuids are not globally-unique within the user's mail store as they are with Exchange for instance. With Javamail the messageIds are index numbers within the mailbox store (which is really per-folder). Thus, many mail folders for a user may have a messageId=1. This does not present many problems as long as we insure we are only dealing with one folder at a time.

Author:

awills, James Wennmacher, jwennmacher@unicon.net

Constructor Summary

Constructors

Constructor and Description
JavamailAccountDaoImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
boolean	deleteMessages(MailStoreConfiguration config, String[] uuids) Delete the list of messages from Exchange.
AccountSummary	fetchAccountSummaryFromStore(MailStoreConfiguration config, String username, String mailAccount, String folder, int start, int max) Obtains a summary of the email messages from the configured store (to/from/subject/date) and general mailbox summary.
List<javax.mail.Folder>	getAllUserInboxFolders(MailStoreConfiguration config) Gets all the user's inbox folders.
EmailMessage	getMessage(MailStoreConfiguration config, String messageId) Gets a message from the mail server.
void	setCredentialsProvider(ICredentialsProvider credentialsProvider)
boolean	setMessageReadStatus(MailStoreConfiguration config, String[] uuids, boolean read) Sets the isRead status of the indicated messages to the indicated value.
void	setSecurityFile(String path) Set the file path to the Anti-samy policy file to be used for cleaning strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavamailAccountDaoImpl

public JavamailAccountDaoImpl()

Method Detail

setCredentialsProvider

public void setCredentialsProvider(ICredentialsProvider credentialsProvider)

setSecurityFile

public void setSecurityFile(String path)

Set the file path to the Anti-samy policy file to be used for cleaning strings.

Parameters:

path -

afterPropertiesSet

@PostConstruct
public void afterPropertiesSet()
                                       throws Exception

Throws:

Exception

fetchAccountSummaryFromStore

public AccountSummary fetchAccountSummaryFromStore(MailStoreConfiguration config,
                                                   String username,
                                                   String mailAccount,
                                                   String folder,
                                                   int start,
                                                   int max)

Description copied from interface: IMailAccountDao

Obtains a summary of the email messages from the configured store (to/from/subject/date) and general mailbox summary.

Specified by:

fetchAccountSummaryFromStore in interface IMailAccountDao

Parameters:

config - mailstore configuration

username - Portal username

mailAccount - Email account

folder - mailbox folder to use

start - Index of the first expected message

max - Maximum number of messages to return

Returns:

A representation of mail account details suitable for displaying in the view

getMessage

public EmailMessage getMessage(MailStoreConfiguration config,
                               String messageId)

Description copied from interface: IMailAccountDao

Gets a message from the mail server.

Specified by:

getMessage in interface IMailAccountDao

Parameters:

config - mail configuration

messageId - Message

Returns:

message

deleteMessages

public boolean deleteMessages(MailStoreConfiguration config,
                              String[] uuids)

Description copied from interface: IMailAccountDao

Delete the list of messages from Exchange.

Specified by:

deleteMessages in interface IMailAccountDao

uuids - uuids if the messages to delete

Returns:

True if messages were deleted

setMessageReadStatus

public boolean setMessageReadStatus(MailStoreConfiguration config,
                                    String[] uuids,
                                    boolean read)

Description copied from interface: IMailAccountDao

Sets the isRead status of the indicated messages to the indicated value.

Specified by:

setMessageReadStatus in interface IMailAccountDao

uuids - uuids of the messages to change the read status of

read - true to indicate message has been read

Returns:

true if read status was successfully set

getAllUserInboxFolders

public List<javax.mail.Folder> getAllUserInboxFolders(MailStoreConfiguration config)

Description copied from interface: IMailAccountDao

Gets all the user's inbox folders.

Specified by:

getAllUserInboxFolders in interface IMailAccountDao

Returns:

List of user's folders.