org.apache.james.mailbox.maildir

Class MaildirMessageName

java.lang.Object

org.apache.james.mailbox.maildir.MaildirMessageName

public class MaildirMessageName
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static FilenameFilter	FILTER_DELETED_MESSAGES
static FilenameFilter	FILTER_UNSEEN_MESSAGES
static String	FLAG_ANSWERD
static String	FLAG_DELETED
static String	FLAG_DRAFT
static String	FLAG_FLAGGED
static String	FLAG_SEEN
static Pattern	PATTERN_DELETED_MESSAGES
static Pattern	PATTERN_MESSAGE
static String	PATTERN_STRING_FLAGS
static String	PATTERN_STRING_MESSAGE_NAME
static String	PATTERN_STRING_SIZE
static Pattern	PATTERN_UNSEEN_MESSAGES

Constructor Summary

Constructors

Constructor and Description
MaildirMessageName(MaildirFolder parentFolder, String fullName)

Method Summary

Methods

Modifier and Type	Method and Description
static FilenameFilter	createRegexFilter(Pattern pattern)
static MaildirMessageName	createUniqueName(MaildirFolder parentFolder, long size) Create a name for a message according to The following elements are used: "A unique name has three pieces, separated by dots.
javax.mail.Flags	decodeFlags(String flagsString) Takes a String which is "Maildir encoded" and translates it into a Flags object.
String	encodeFlags(javax.mail.Flags flags) Creates a String that represents the provided Flags
boolean	exists() Tests whether the file or directory belonging to this MaildirFolder exists.
String	getBaseName() Composes the base name consisting of timestamp, unique string and host name witout the size and flags.
File	getFile() Returns a File object of the message denoted by this MaildirMessageName.
FilenameFilter	getFilenameFilter() Creates a filter which matches the message file even if the flags have changed
javax.mail.Flags	getFlags() Decodes the flags part of the file name if necessary and returns the appropriate Flags object.
String	getFullName() Returns the full name of this message including size and flags if available.
Date	getInternalDate() Decodes the time part of the file name if necessary and returns the appropriate Date.
Long	getSize() Decodes the size part of the file name if necessary and returns the appropriate Long.
static String	optional(String pattern)
void	setFlags(javax.mail.Flags flags) Sets new flags for this message name.
void	setFullName(String fullName) Sets the fullName of this MaildirMessageName if different from the current one.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FLAG_DRAFT

public static final String FLAG_DRAFT

See Also:

Constant Field Values

FLAG_FLAGGED

public static final String FLAG_FLAGGED

See Also:

Constant Field Values

FLAG_ANSWERD

public static final String FLAG_ANSWERD

See Also:

Constant Field Values

FLAG_SEEN

public static final String FLAG_SEEN

See Also:

Constant Field Values

FLAG_DELETED

public static final String FLAG_DELETED

See Also:

Constant Field Values

PATTERN_STRING_MESSAGE_NAME

public static final String PATTERN_STRING_MESSAGE_NAME

See Also:

Constant Field Values

PATTERN_STRING_FLAGS

public static final String PATTERN_STRING_FLAGS

See Also:

Constant Field Values

PATTERN_STRING_SIZE

public static final String PATTERN_STRING_SIZE

See Also:

Constant Field Values

PATTERN_MESSAGE

public static final Pattern PATTERN_MESSAGE

PATTERN_UNSEEN_MESSAGES

public static final Pattern PATTERN_UNSEEN_MESSAGES

FILTER_UNSEEN_MESSAGES

public static final FilenameFilter FILTER_UNSEEN_MESSAGES

PATTERN_DELETED_MESSAGES

public static final Pattern PATTERN_DELETED_MESSAGES

FILTER_DELETED_MESSAGES

public static final FilenameFilter FILTER_DELETED_MESSAGES

Constructor Detail

MaildirMessageName

public MaildirMessageName(MaildirFolder parentFolder,
                  String fullName)

Method Detail

exists

public boolean exists()

Tests whether the file or directory belonging to this MaildirFolder exists. If the file exists, its absolute path is written to absPath. TODO: If the flags have changed or the file doesn't exist any more, the uidlist should be updated

Returns:

true if the file or directory belonging to this MaildirFolder exists ; false otherwise

setFullName

public void setFullName(String fullName)

Sets the fullName of this MaildirMessageName if different from the current one. As this invalidates the parsed elements, they are being reset.

Parameters:

fullName - A name of a message file in the correct Maildir format

getFullName

public String getFullName()

Returns the full name of this message including size and flags if available.

Returns:

the full name of this message

getFile

public File getFile()
             throws FileNotFoundException

Returns a File object of the message denoted by this MaildirMessageName. Also checks for different flags if it cannot be found directly.

Returns:

A File object

Throws:

FileNotFoundException - If there is no file for the given name

getFilenameFilter

public FilenameFilter getFilenameFilter()

Creates a filter which matches the message file even if the flags have changed

Returns:

filter for this message

setFlags

public void setFlags(javax.mail.Flags flags)

Sets new flags for this message name.

Parameters:

flags -

getFlags

public javax.mail.Flags getFlags()

Decodes the flags part of the file name if necessary and returns the appropriate Flags object.

Returns:

The Flags of this message

getSize

public Long getSize()

Decodes the size part of the file name if necessary and returns the appropriate Long.

Returns:

The size of this message as a Long

getInternalDate

public Date getInternalDate()

Decodes the time part of the file name if necessary and returns the appropriate Date.

Returns:

The time of this message as a Date

getBaseName

public String getBaseName()

Composes the base name consisting of timestamp, unique string and host name witout the size and flags.

Returns:

The base name

encodeFlags

public String encodeFlags(javax.mail.Flags flags)

Creates a String that represents the provided Flags

Parameters:

flags - The flags to encode

Returns:

A String valid for Maildir

decodeFlags

public javax.mail.Flags decodeFlags(String flagsString)

Takes a String which is "Maildir encoded" and translates it into a Flags object.

Parameters:

flagsString - The String with the flags

Returns:

A Flags object containing the flags read form the String

createUniqueName

public static MaildirMessageName createUniqueName(MaildirFolder parentFolder,
                                  long size)

Create a name for a message according to
The following elements are used:

"A unique name has three pieces, separated by dots. On the left is the result of time() or the second counter from gettimeofday(). On the right is the result of gethostname(). (To deal with invalid host names, replace / with \057 and : with \072.) In the middle is a delivery identifier, discussed below.

Modern delivery identifiers are created by concatenating enough of the following strings to guarantee uniqueness:

[...]
* Rn, where n is (in hexadecimal) the output of the operating system's unix_cryptorandomnumber() system call, or an equivalent source such as /dev/urandom. Unfortunately, some operating systems don't include cryptographic random number generators.
[...]
* Mn, where n is (in decimal) the microsecond counter from the same gettimeofday() used for the left part of the unique name.
* Pn, where n is (in decimal) the process ID.
* Qn, where n is (in decimal) the number of deliveries made by this process.

[...]"

Returns:

unique message name

createRegexFilter

public static FilenameFilter createRegexFilter(Pattern pattern)

optional

public static String optional(String pattern)

toString

public String toString()

Overrides:

toString in class Object