org.jasig.portlet.emailpreview.dao

Interface IMailAccountDao<T extends javax.mail.Folder>

All Known Implementing Classes:

ExchangeAccountDaoImpl, JavamailAccountDaoImpl

public interface IMailAccountDao<T extends javax.mail.Folder>

This interface exists to shield the service layer from various DAO implementations.

Author:

James Wennmacher, jwennmacher@unicon.net

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteMessages(MailStoreConfiguration storeConfig, String[] uuids) Delete the list of messages from Exchange.
AccountSummary	fetchAccountSummaryFromStore(MailStoreConfiguration storeConfig, 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<T>	getAllUserInboxFolders(MailStoreConfiguration storeConfig) Gets all the user's inbox folders.
EmailMessage	getMessage(MailStoreConfiguration storeConfig, String uuid) Gets a message from the mail server.
boolean	setMessageReadStatus(MailStoreConfiguration storeConfig, String[] uuids, boolean read) Sets the isRead status of the indicated messages to the indicated value.

Method Detail

fetchAccountSummaryFromStore

AccountSummary fetchAccountSummaryFromStore(MailStoreConfiguration storeConfig,
                                          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.

Parameters:

storeConfig - mailstore configuration

username - Portal username

mailAccount - Email account

start - Index of the first expected message

max - Maximum number of messages to return

folder - mailbox folder to use

Returns:

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

getMessage

EmailMessage getMessage(MailStoreConfiguration storeConfig,
                      String uuid)

Gets a message from the mail server.

Parameters:

uuid - Message

storeConfig - mail configuration

Returns:

message

deleteMessages

boolean deleteMessages(MailStoreConfiguration storeConfig,
                     String[] uuids)

Delete the list of messages from Exchange.

Parameters:

uuids - uuids if the messages to delete

Returns:

True if messages were deleted

setMessageReadStatus

boolean setMessageReadStatus(MailStoreConfiguration storeConfig,
                           String[] uuids,
                           boolean read)

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

Parameters:

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

List<T> getAllUserInboxFolders(MailStoreConfiguration storeConfig)

Gets all the user's inbox folders.

Returns:

List of user's folders.