|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ImapService
Method Summary | |
---|---|
AlfrescoImapFolder |
createMailbox(AlfrescoImapUser user,
java.lang.String mailboxName)
Returns a reference to a newly created mailbox. |
void |
deleteMailbox(AlfrescoImapUser user,
java.lang.String mailboxName)
Deletes an existing MailBox. |
java.lang.String |
getDefaultFromAddress()
|
javax.mail.Flags |
getFlags(FileInfo messageFileInfo)
Return flags that belong to the specified imap folder. |
AlfrescoImapFolder |
getFolder(AlfrescoImapUser user,
java.lang.String mailboxName)
Returns a reference to an existing Mailbox. |
NodeRef |
getMailboxRootRef(java.lang.String mailboxName,
java.lang.String userName)
Get root reference for the specified mailbox |
java.lang.String |
getRepositoryTemplatePath()
|
java.lang.String |
getWebApplicationContextUrl()
|
java.util.List |
listMailboxes(AlfrescoImapUser user,
java.lang.String mailboxPattern)
Returns an collection of mailboxes. |
java.util.List |
listSubscribedMailboxes(AlfrescoImapUser user,
java.lang.String mailboxPattern)
Returns an collection of subscribed mailboxes. |
void |
renameMailbox(AlfrescoImapUser user,
java.lang.String oldMailboxName,
java.lang.String newMailboxName)
Renames an existing mailbox. |
java.util.List |
searchFiles(NodeRef contextNodeRef,
java.lang.String namePattern,
boolean includeSubFolders)
Search for files in specified context |
java.util.List |
searchFolders(NodeRef contextNodeRef,
java.lang.String namePattern,
boolean includeSubFolders,
AlfrescoImapConst.ImapViewMode viewMode)
Search for mailboxes in specified context |
java.util.List |
searchMails(NodeRef contextNodeRef,
java.lang.String namePattern,
AlfrescoImapConst.ImapViewMode viewMode,
boolean includeSubFolders)
Search for emails in specified folder depend on view mode. |
void |
setFlag(FileInfo messageFileInfo,
javax.mail.Flags.Flag flag,
boolean value)
Set flag to the specified imapFolder. |
void |
setFlags(FileInfo messageFileInfo,
javax.mail.Flags flags,
boolean value)
Set flags to the specified imapFolder. |
void |
subscribe(AlfrescoImapUser user,
java.lang.String mailbox)
Subscribes a user to a mailbox. |
void |
unsubscribe(AlfrescoImapUser user,
java.lang.String mailbox)
Unsubscribes from a given mailbox. |
Method Detail |
---|
java.util.List listMailboxes(AlfrescoImapUser user, java.lang.String mailboxPattern)
user
- User making the requestmailboxPattern
- String name of a mailbox possible including a wildcard.
java.util.List listSubscribedMailboxes(AlfrescoImapUser user, java.lang.String mailboxPattern)
user
- User making the requestmailboxPattern
- String name of a mailbox possible including a wildcard.
AlfrescoImapFolder createMailbox(AlfrescoImapUser user, java.lang.String mailboxName)
user
- User making the request.mailboxName
- String name of the target
void deleteMailbox(AlfrescoImapUser user, java.lang.String mailboxName)
user
- User making the request.mailboxName
- String name of the target
com.icegreen.greenmail.store.FolderException
- if mailbox has a non-selectable store with childrenvoid renameMailbox(AlfrescoImapUser user, java.lang.String oldMailboxName, java.lang.String newMailboxName)
user
- User making the request.oldMailboxName
- String name of the existing foldernewMailboxName
- String target new nameAlfrescoImapFolder getFolder(AlfrescoImapUser user, java.lang.String mailboxName)
user
- User making the request.mailboxName
- String name of the target.
NodeRef getMailboxRootRef(java.lang.String mailboxName, java.lang.String userName)
mailboxName
- mailbox name in IMAP client.userName
-
void subscribe(AlfrescoImapUser user, java.lang.String mailbox)
user
- User making the requestmailbox
- String representation of a mailbox name.void unsubscribe(AlfrescoImapUser user, java.lang.String mailbox)
user
- User making the requestmailbox
- String representation of a mailbox name.java.util.List searchFiles(NodeRef contextNodeRef, java.lang.String namePattern, boolean includeSubFolders)
contextNodeRef
- context folder for searchnamePattern
- name pattern for searchincludeSubFolders
- include SubFolders
java.util.List searchFolders(NodeRef contextNodeRef, java.lang.String namePattern, boolean includeSubFolders, AlfrescoImapConst.ImapViewMode viewMode)
contextNodeRef
- context folder for searchnamePattern
- name pattern for searchincludeSubFolders
- include SubFoldersviewMode
- (ARCHIVE, MIXED or VIRTUAL)
java.util.List searchMails(NodeRef contextNodeRef, java.lang.String namePattern, AlfrescoImapConst.ImapViewMode viewMode, boolean includeSubFolders)
contextNodeRef
- context folder for searchnamePattern
- name pattern for searchviewMode
- (ARCHIVE, MIXED or VIRTUAL)includeSubFolders
- includeSubFolders
javax.mail.Flags getFlags(FileInfo messageFileInfo)
messageInfo
- imap folder info.
void setFlags(FileInfo messageFileInfo, javax.mail.Flags flags, boolean value)
messageInfo
- FileInfo of imap Folder.flags
- flags to set.value
- value to set.void setFlag(FileInfo messageFileInfo, javax.mail.Flags.Flag flag, boolean value)
messageInfo
- FileInfo of imap Folderflag
- flag to set.value
- value value to set.java.lang.String getDefaultFromAddress()
java.lang.String getRepositoryTemplatePath()
java.lang.String getWebApplicationContextUrl()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |