com.liferay.mail.reader.mailbox

Interface Mailbox

public interface Mailbox

Method Summary

Modifier and Type	Method and Description
Account	addAccount(java.lang.String address, java.lang.String personalName, java.lang.String protocol, java.lang.String incomingHostName, int incomingPort, boolean incomingSecure, java.lang.String outgoingHostName, int outgoingPort, boolean outgoingSecure, java.lang.String login, java.lang.String password, boolean savePassword, java.lang.String signature, boolean useSignature, java.lang.String folderPrefix, boolean defaultSender)
Folder	addFolder(java.lang.String displayName)
void	deleteAccount()
void	deleteAttachment(long attachmentId)
void	deleteFolder(long folderId)
void	deleteMessages(long folderId, long[] messageIds)
Account	getAccount()
AttachmentHandler	getAttachment(long attachmentId)
Message	getMessage(long folderId, java.lang.String keywords, int messageNumber, java.lang.String orderByField, java.lang.String orderByType)
MessagesDisplay	getMessagesDisplay(long folderId, java.lang.String keywords, int pageNumber, int messagesPerPage, java.lang.String orderByField, java.lang.String orderByType)
User	getUser()
boolean	hasNewMessages(long folderId)
void	moveMessages(long folderId, long[] messageIds)
javax.mail.internet.InternetAddress[]	parseAddresses(java.lang.String addresses)
void	renameFolder(long folderId, java.lang.String displayName)
Message	saveDraft(long accountId, long messageId, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, java.util.List<MailFile> mailFiles)
void	sendMessage(long accountId, long messageId)
void	setAccount(Account account)
void	setUser(User user)
void	synchronize()
void	synchronizeFolder(long folderId)
void	synchronizeMessage(long messageId)
void	synchronizePage(long folderId, int pageNumber, int messagesPerPage)
Account	updateAccount(long accountId, java.lang.String personalName, java.lang.String password, boolean savePassword, java.lang.String signature, boolean useSignature, java.lang.String folderPrefix, boolean defaultSender)
void	updateFlags(long folderId, long[] messageIds, int flag, boolean value)
void	updateFolders()
void	updateFolders(long inboxFolderId, long draftFolderId, long sentFolderId, long trashFolderId)
void	validateAccount(java.lang.String incomingHostName, int incomingPort, boolean incomingSecure, java.lang.String outgoingHostName, int outgoingPort, boolean outgoingSecure, java.lang.String login, java.lang.String password)

Method Detail

addAccount

Account addAccount(java.lang.String address,
                   java.lang.String personalName,
                   java.lang.String protocol,
                   java.lang.String incomingHostName,
                   int incomingPort,
                   boolean incomingSecure,
                   java.lang.String outgoingHostName,
                   int outgoingPort,
                   boolean outgoingSecure,
                   java.lang.String login,
                   java.lang.String password,
                   boolean savePassword,
                   java.lang.String signature,
                   boolean useSignature,
                   java.lang.String folderPrefix,
                   boolean defaultSender)
            throws PortalException

Throws:

PortalException

addFolder

Folder addFolder(java.lang.String displayName)
          throws PortalException

Throws:

PortalException

deleteAccount

void deleteAccount()
            throws PortalException

Throws:

PortalException

deleteAttachment

void deleteAttachment(long attachmentId)
               throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(long folderId)
           throws PortalException

Throws:

PortalException

deleteMessages

void deleteMessages(long folderId,
                    long[] messageIds)
             throws PortalException

Throws:

PortalException

getAccount

Account getAccount()

getAttachment

AttachmentHandler getAttachment(long attachmentId)
                         throws java.io.IOException,
                                PortalException

Throws:

java.io.IOException

PortalException

getMessage

Message getMessage(long folderId,
                   java.lang.String keywords,
                   int messageNumber,
                   java.lang.String orderByField,
                   java.lang.String orderByType)
            throws PortalException

Throws:

PortalException

getMessagesDisplay

MessagesDisplay getMessagesDisplay(long folderId,
                                   java.lang.String keywords,
                                   int pageNumber,
                                   int messagesPerPage,
                                   java.lang.String orderByField,
                                   java.lang.String orderByType)
                            throws PortalException

Throws:

PortalException

getUser

User getUser()

hasNewMessages

boolean hasNewMessages(long folderId)
                throws PortalException

Throws:

PortalException

moveMessages

void moveMessages(long folderId,
                  long[] messageIds)
           throws PortalException

Throws:

PortalException

parseAddresses

javax.mail.internet.InternetAddress[] parseAddresses(java.lang.String addresses)
                                              throws PortalException

Throws:

PortalException

renameFolder

void renameFolder(long folderId,
                  java.lang.String displayName)
           throws PortalException

Throws:

PortalException

saveDraft

Message saveDraft(long accountId,
                  long messageId,
                  java.lang.String to,
                  java.lang.String cc,
                  java.lang.String bcc,
                  java.lang.String subject,
                  java.lang.String body,
                  java.util.List<MailFile> mailFiles)
           throws PortalException

Throws:

PortalException

sendMessage

void sendMessage(long accountId,
                 long messageId)
          throws PortalException

Throws:

PortalException

setAccount

void setAccount(Account account)

setUser

void setUser(User user)

synchronize

void synchronize()
          throws PortalException

Throws:

PortalException

synchronizeFolder

void synchronizeFolder(long folderId)
                throws PortalException

Throws:

PortalException

synchronizeMessage

void synchronizeMessage(long messageId)
                 throws PortalException

Throws:

PortalException

synchronizePage

void synchronizePage(long folderId,
                     int pageNumber,
                     int messagesPerPage)
              throws PortalException

Throws:

PortalException

updateAccount

Account updateAccount(long accountId,
                      java.lang.String personalName,
                      java.lang.String password,
                      boolean savePassword,
                      java.lang.String signature,
                      boolean useSignature,
                      java.lang.String folderPrefix,
                      boolean defaultSender)
               throws PortalException

Throws:

PortalException

updateFlags

void updateFlags(long folderId,
                 long[] messageIds,
                 int flag,
                 boolean value)
          throws PortalException

Throws:

PortalException

updateFolders

void updateFolders()
            throws PortalException

Throws:

PortalException

updateFolders

void updateFolders(long inboxFolderId,
                   long draftFolderId,
                   long sentFolderId,
                   long trashFolderId)
            throws PortalException

Throws:

PortalException

validateAccount

void validateAccount(java.lang.String incomingHostName,
                     int incomingPort,
                     boolean incomingSecure,
                     java.lang.String outgoingHostName,
                     int outgoingPort,
                     boolean outgoingSecure,
                     java.lang.String login,
                     java.lang.String password)
              throws PortalException

Throws:

PortalException