public final class MailPath
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
MailPath
- Represents a message's unique path inside a mailbox, that is the account ID followed by the folder full name followed
by the value of SEPERATOR
followed by mail's unique ID:Modifier and Type | Field and Description |
---|---|
static java.util.Comparator<MailPath> |
COMPARATOR
Gets an appropriate instance of
Comparator to sort instances of MailPath |
static MailPath |
NULL
A
null MailPath |
static char |
SEPERATOR
The
'/' character which separates folder's full name from mail's ID in a mail path |
Constructor and Description |
---|
MailPath()
Default constructor
|
MailPath(int accountId,
java.lang.String folder,
java.lang.String uid)
Initializes a new
MailPath |
MailPath(java.lang.String mailPathStr)
Initializes a new
MailPath |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
boolean |
equals(java.lang.Object obj) |
int |
getAccountId()
Gets the account ID.
|
java.lang.String |
getFolder()
Gets the folder full name
|
java.lang.String |
getFolderArgument()
Gets the folder argument; default3/INBOX.
|
java.lang.String |
getMailID()
Gets the mail ID.
|
static java.lang.String |
getMailPath(int accountId,
java.lang.String folder,
java.lang.String mailId)
Gets the mail path corresponding to given folder full name and message UID
|
static MailPath[] |
getMailPaths(java.lang.String mailPaths)
Returns the mail paths for given comma-separated mail IDs each conform to pattern <folder-path><value-of-
SEPERATOR
><mail-ID> |
static MailPath[] |
getMailPaths(java.lang.String[] mailPaths)
Returns the mail paths for given mail IDs each conform to pattern <folder-path><value-of-
SEPERATOR
><mail-ID> |
java.lang.String |
getStr()
Gets this mail path's string representation.
|
static java.lang.String[] |
getUIDs(MailPath[] mailPaths)
Extracts the IDs from given mail paths
|
int |
hashCode() |
void |
set(int accountId,
java.lang.String folder,
java.lang.String uid)
Sets specified arguments.
|
MailPath |
setMailIdentifierString(java.lang.String mailPathStr)
Sets this mail path's folder full name and mail's unique ID (for re-usage).
|
java.lang.String |
toString()
Gets this mail path's string representation following pattern:
"default" + <account-id> + <default-separator> + <folder-full-name> + "/" + <mail-id> default2/INBOX/Subfolder/453" |
public static final java.util.Comparator<MailPath> COMPARATOR
Comparator
to sort instances of MailPath
public static final char SEPERATOR
'/'
character which separates folder's full name from mail's ID in a mail pathpublic MailPath()
public MailPath(java.lang.String mailPathStr) throws com.openexchange.exception.OXException
MailPath
mailPathStr
- The mail path's string representationcom.openexchange.exception.OXException
- If mail path's string representation does not match expected patternpublic MailPath(int accountId, java.lang.String folder, java.lang.String uid)
MailPath
accountId
- The account IDfolder
- Folder full nameuid
- The mail's unique IDpublic static java.lang.String getMailPath(int accountId, java.lang.String folder, java.lang.String mailId)
accountId
- The account IDfolder
- The folder full namemailId
- The mail IDString
public static MailPath[] getMailPaths(java.lang.String mailPaths) throws com.openexchange.exception.OXException
SEPERATOR
><mail-ID>mailPaths
- The comma-separated mail IDscom.openexchange.exception.OXException
- If mail paths cannot be generatedpublic static MailPath[] getMailPaths(java.lang.String[] mailPaths) throws com.openexchange.exception.OXException
SEPERATOR
><mail-ID>mailPaths
- The mail IDscom.openexchange.exception.OXException
- If mail paths cannot be generatedpublic static java.lang.String[] getUIDs(MailPath[] mailPaths)
mailPaths
- The mail IDspublic void set(int accountId, java.lang.String folder, java.lang.String uid)
accountId
- The account IDfolder
- Folder full nameuid
- The mail's unique IDpublic int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.Object clone()
clone
in class java.lang.Object
public int getAccountId()
public java.lang.String getFolder()
public java.lang.String getFolderArgument()
public java.lang.String getStr()
toString()
public java.lang.String getMailID()
public MailPath setMailIdentifierString(java.lang.String mailPathStr) throws com.openexchange.exception.OXException
mailPathStr
- The mail paths string representationcom.openexchange.exception.OXException
- If mail path's string representation does not match expected patternpublic java.lang.String toString()
default2/INBOX/Subfolder/453"
toString
in class java.lang.Object