com.libmailcore

Class IMAPNamespace

java.lang.Object

com.libmailcore.NativeObject

com.libmailcore.IMAPNamespace

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IMAPNamespace
extends NativeObject

IMAP Namespace

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IMAPNamespace()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	componentsFromPath(java.lang.String path) Returns the components given a folder path.
boolean	containsFolderPath(java.lang.String path) Returns true if the namespace contains the given folder path.
char	mainDelimiter() Returns the delimiter of the main namespace item.
java.lang.String	mainPrefix() Returns the prefix of the main namespace item.
static IMAPNamespace	namespaceWithPrefix(java.lang.String prefix, char delimiter) Returns a namespace (with a single namespace item) with a prefix and a delimiter.
java.lang.String	pathForComponents(java.util.List<java.lang.String> components) Returns the folder path for the given list of path components in the context of the main item of the namespace.
java.lang.String	pathForComponentsAndPrefix(java.util.List<java.lang.String> components, java.lang.String prefix) Returns the folder path for the given list of path components and a prefix.
java.util.List<java.lang.String>	prefixes() Returns the list of prefixes.

Methods inherited from class com.libmailcore.NativeObject

clone, finalize, initWithNative, readObject, toString, writeObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IMAPNamespace

public IMAPNamespace()

Method Detail

mainPrefix

public java.lang.String mainPrefix()

Returns the prefix of the main namespace item.

mainDelimiter

public char mainDelimiter()

Returns the delimiter of the main namespace item.

prefixes

public java.util.List<java.lang.String> prefixes()

Returns the list of prefixes.

pathForComponents

public java.lang.String pathForComponents(java.util.List<java.lang.String> components)

Returns the folder path for the given list of path components in the context of the main item of the namespace.

pathForComponentsAndPrefix

public java.lang.String pathForComponentsAndPrefix(java.util.List<java.lang.String> components,
                                                   java.lang.String prefix)

Returns the folder path for the given list of path components and a prefix. It will use the best item matching the prefix to compute the path.

componentsFromPath

public java.util.List<java.lang.String> componentsFromPath(java.lang.String path)

Returns the components given a folder path.

containsFolderPath

public boolean containsFolderPath(java.lang.String path)

Returns true if the namespace contains the given folder path.

namespaceWithPrefix

public static IMAPNamespace namespaceWithPrefix(java.lang.String prefix,
                                                char delimiter)

Returns a namespace (with a single namespace item) with a prefix and a delimiter.