|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Store
Represents the complete mail store for an IMAP server, providing access to
and manipulation of all Mailboxes
stored on this server.
Method Summary | |
---|---|
MailFolder |
createMailbox(MailFolder parent,
String mailboxName,
boolean selectable)
Creates a mailbox under the supplied parent with the given name. |
void |
deleteMailbox(MailFolder folder)
Deletes the supplied mailbox from the store. |
Collection |
getChildren(MailFolder parent)
|
MailFolder |
getMailbox(MailFolder parent,
String mailboxName)
Looks up a child mailbox of the supplied parent with the name given. |
MailFolder |
getMailbox(String qualifiedMailboxName)
Retrieves a mailbox based on a fully qualified name. |
Collection |
listMailboxes(String searchPattern)
Lists all of the mailboxes in the store which have a name matching the supplied search pattern. |
void |
renameMailbox(MailFolder existingFolder,
String newName)
Renames the mailbox with the new name. |
MailFolder |
setSelectable(MailFolder folder,
boolean selectable)
Tells the store to make the supplied mailbox selectable or not (able to store messages). |
Method Detail |
---|
MailFolder getMailbox(String qualifiedMailboxName)
qualifiedMailboxName
-
null
if not.MailFolder getMailbox(MailFolder parent, String mailboxName)
parent
- The parent mailboxmailboxName
- The name of the child to lookup
null
if not found.Collection getChildren(MailFolder parent)
parent
- A mailbox from this store.
MailFolder
instances, which
are the children of the supplied parent.MailFolder createMailbox(MailFolder parent, String mailboxName, boolean selectable) throws FolderException
parent
- A mailbox from this store.mailboxName
- The name of the mailbox to create.selectable
- If true
, the mailbox will be created to store messages.
FolderException
- If the mailbox couldn't be created.MailFolder setSelectable(MailFolder folder, boolean selectable)
folder
- The mailbox to modify.selectable
- Whether this mailbox should be able to store messages.
void deleteMailbox(MailFolder folder) throws FolderException
folder
- A mailbox from this store.
FolderException
- If the mailbox couldn't be deleted.void renameMailbox(MailFolder existingFolder, String newName) throws FolderException
existingFolder
- A mailbox from this store.newName
- The new name for the mailbox.
FolderException
- If the mailbox couldn't be renamedCollection listMailboxes(String searchPattern) throws FolderException
Valid wildcards are: '*' - matches any number of characters, including the hierarchy delimiter '%' - matches any number of characters, but not the hierarchy delimiter
searchPattern
- The pattern to match mailboxes
FolderException
- If the list operation failed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |