org.apache.james.mailbox.maildir

Class MaildirFolder

java.lang.Object

org.apache.james.mailbox.maildir.MaildirFolder

public class MaildirFolder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACL_FILE
static String	CUR
static String	NEW
static String	TMP
static String	UIDLIST_FILE
static String	VALIDITY_FILE

Constructor Summary

Constructors

Constructor and Description
MaildirFolder(String absPath, org.apache.james.mailbox.model.MailboxPath path, org.apache.james.mailbox.MailboxPathLocker locker) Representation of a maildir folder containing the message folders and some special files

Method Summary

Methods

Modifier and Type	Method and Description
long	appendMessage(org.apache.james.mailbox.MailboxSession session, String name) Appends a message to the uidlist and returns its uid.
MaildirMessageName	delete(org.apache.james.mailbox.MailboxSession session, long uid) Retrieves the file belonging to the given uid, deletes it and updates the uid list.
boolean	exists() Tests whether the directory belonging to this MaildirFolder exists
org.apache.james.mailbox.model.MailboxACL	getACL(org.apache.james.mailbox.MailboxSession session)
File	getCurFolder() Returns the .
long	getHighestModSeq()
long	getLastUid(org.apache.james.mailbox.MailboxSession session) Returns the last uid used in this mailbox
MaildirMessageName	getMessageNameByUid(org.apache.james.mailbox.MailboxSession session, Long uid) Searches the uid list for a certain uid and returns the according MaildirMessageName
File	getNewFolder() Returns the .
SortedMap<Long,MaildirMessageName>	getRecentMessages(org.apache.james.mailbox.MailboxSession session) Creates a map of recent messages.
File	getRootFile() Returns the File of this Maildir folder.
File	getTmpFolder() Returns the .
SortedMap<Long,MaildirMessageName>	getUidMap(org.apache.james.mailbox.MailboxSession session, FilenameFilter filter, int limit) Reads all uids from the uid list file which match the given filter and returns as many of them as a sorted map as the limit specifies.
SortedMap<Long,MaildirMessageName>	getUidMap(org.apache.james.mailbox.MailboxSession session, FilenameFilter filter, long from, long to)
SortedMap<Long,MaildirMessageName>	getUidMap(org.apache.james.mailbox.MailboxSession session, long from, long to) Reads all uids between the two boundaries from the folder and returns them as a sorted map together with their corresponding MaildirMessageNames.
long	getUidValidity() Returns the uidValidity of this mailbox
boolean	isMessageNameStrictParse() Returns whether the names of message files in this folder are parsed in a strict manner (true), which means a size field and flags are expected.
void	setACL(org.apache.james.mailbox.MailboxSession session, org.apache.james.mailbox.model.MailboxACL acl)
void	setMessageNameStrictParse(boolean messageNameStrictParse) Specifies whether the names of message files in this folder are parsed in a strict manner (true), which means a size field and flags are expected.
void	setUidValidity(long uidValidity) Sets the uidValidity for this mailbox and writes it to the file system
static String	stripMetaFromName(String fileName) Takes the name of a message file and returns only the base name.
String	toString() The absolute path of this folder.
void	update(org.apache.james.mailbox.MailboxSession session, long uid, String messageName) Updates an entry in the uid list.

Methods inherited from class java.lang.Object

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

Field Detail

VALIDITY_FILE

public static final String VALIDITY_FILE

See Also:

Constant Field Values

UIDLIST_FILE

public static final String UIDLIST_FILE

See Also:

Constant Field Values

ACL_FILE

public static final String ACL_FILE

See Also:

Constant Field Values

CUR

public static final String CUR

See Also:

Constant Field Values

NEW

public static final String NEW

See Also:

Constant Field Values

TMP

public static final String TMP

See Also:

Constant Field Values

Constructor Detail

MaildirFolder

public MaildirFolder(String absPath,
             org.apache.james.mailbox.model.MailboxPath path,
             org.apache.james.mailbox.MailboxPathLocker locker)

Representation of a maildir folder containing the message folders and some special files

Parameters:

absPath - The absolute path of the mailbox folder

Method Detail

isMessageNameStrictParse

public boolean isMessageNameStrictParse()

Returns whether the names of message files in this folder are parsed in a strict manner (true), which means a size field and flags are expected.

Returns:

setMessageNameStrictParse

public void setMessageNameStrictParse(boolean messageNameStrictParse)

Specifies whether the names of message files in this folder are parsed in a strict manner (true), which means a size field and flags are expected.

Parameters:

messageNameStrictParse -

getRootFile

public File getRootFile()

Returns the File of this Maildir folder.

Returns:

the root folder

exists

public boolean exists()

Tests whether the directory belonging to this MaildirFolder exists

Returns:

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

getCurFolder

public File getCurFolder()

Returns the ./cur folder of this Maildir folder.

Returns:

the ./cur folder

getNewFolder

public File getNewFolder()

Returns the ./new folder of this Maildir folder.

Returns:

the ./new folder

getTmpFolder

public File getTmpFolder()

Returns the ./tmp folder of this Maildir folder.

Returns:

the ./tmp folder

getLastUid

public long getLastUid(org.apache.james.mailbox.MailboxSession session)
                throws org.apache.james.mailbox.exception.MailboxException

Returns the last uid used in this mailbox

Parameters:

session -

Returns:

lastUid

Throws:

org.apache.james.mailbox.exception.MailboxException

getHighestModSeq

public long getHighestModSeq()
                      throws IOException

Throws:

IOException

getUidValidity

public long getUidValidity()
                    throws IOException

Returns the uidValidity of this mailbox

Returns:

The uidValidity

Throws:

IOException

setUidValidity

public void setUidValidity(long uidValidity)
                    throws IOException

Sets the uidValidity for this mailbox and writes it to the file system

Parameters:

uidValidity -

Throws:

IOException

getMessageNameByUid

public MaildirMessageName getMessageNameByUid(org.apache.james.mailbox.MailboxSession session,
                                     Long uid)
                                       throws org.apache.james.mailbox.exception.MailboxException

Searches the uid list for a certain uid and returns the according MaildirMessageName

Parameters:

session -

uid - The uid to search for

Returns:

The MaildirMessageName that belongs to the uid

Throws:

IOException - If the uidlist file cannot be found or read

org.apache.james.mailbox.exception.MailboxException

getUidMap

public SortedMap<Long,MaildirMessageName> getUidMap(org.apache.james.mailbox.MailboxSession session,
                                           long from,
                                           long to)
                                             throws org.apache.james.mailbox.exception.MailboxException

Reads all uids between the two boundaries from the folder and returns them as a sorted map together with their corresponding MaildirMessageNames.

Parameters:

session -

from - The lower uid limit

to - The upper uid limit. -1 disables the upper limit

Returns:

a Map whith all uids in the given range and associated MaildirMessageNames

Throws:

org.apache.james.mailbox.exception.MailboxException - if there is a problem with the uid list file

getUidMap

public SortedMap<Long,MaildirMessageName> getUidMap(org.apache.james.mailbox.MailboxSession session,
                                           FilenameFilter filter,
                                           long from,
                                           long to)
                                             throws org.apache.james.mailbox.exception.MailboxException

Throws:

org.apache.james.mailbox.exception.MailboxException

getUidMap

public SortedMap<Long,MaildirMessageName> getUidMap(org.apache.james.mailbox.MailboxSession session,
                                           FilenameFilter filter,
                                           int limit)
                                             throws org.apache.james.mailbox.exception.MailboxException

Reads all uids from the uid list file which match the given filter and returns as many of them as a sorted map as the limit specifies.

Parameters:

session -

filter - The file names of all returned items match the filter. The dir argument to FilenameFilter.accept(dir, name) will always be null.

limit - The number of items; a limit smaller then 1 disables the limit

Returns:

A Map with all uids and associated MaildirMessageNames

Throws:

org.apache.james.mailbox.exception.MailboxException - if there is a problem with the uid list file

getRecentMessages

public SortedMap<Long,MaildirMessageName> getRecentMessages(org.apache.james.mailbox.MailboxSession session)
                                                     throws org.apache.james.mailbox.exception.MailboxException

Creates a map of recent messages.

Parameters:

session -

Returns:

A Map with all uids and associated MaildirMessageNames of recent messages

Throws:

org.apache.james.mailbox.exception.MailboxException - If there is a problem with the uid list file

stripMetaFromName

public static String stripMetaFromName(String fileName)

Takes the name of a message file and returns only the base name.

Parameters:

fileName - The name of the message file

Returns:

the file name without meta data, the unmodified name if it doesn't have meta data

appendMessage

public long appendMessage(org.apache.james.mailbox.MailboxSession session,
                 String name)
                   throws org.apache.james.mailbox.exception.MailboxException

Appends a message to the uidlist and returns its uid.

Parameters:

session -

name - The name of the message's file

Returns:

The uid of the message

Throws:

IOException

org.apache.james.mailbox.exception.MailboxException

update

public void update(org.apache.james.mailbox.MailboxSession session,
          long uid,
          String messageName)
            throws org.apache.james.mailbox.exception.MailboxException

Updates an entry in the uid list.

Parameters:

session -

uid -

messageName -

Throws:

org.apache.james.mailbox.exception.MailboxException

delete

public MaildirMessageName delete(org.apache.james.mailbox.MailboxSession session,
                        long uid)
                          throws org.apache.james.mailbox.exception.MailboxException

Retrieves the file belonging to the given uid, deletes it and updates the uid list.

Parameters:

uid - The uid of the message to delete

Returns:

The MaildirMessageName of the deleted message

Throws:

org.apache.james.mailbox.exception.MailboxException - If the file cannot be deleted of there is a problem with the uid list

toString

public String toString()

The absolute path of this folder.

Overrides:

toString in class Object

getACL

public org.apache.james.mailbox.model.MailboxACL getACL(org.apache.james.mailbox.MailboxSession session)
                                                 throws org.apache.james.mailbox.exception.MailboxException

Throws:

org.apache.james.mailbox.exception.MailboxException

setACL

public void setACL(org.apache.james.mailbox.MailboxSession session,
          org.apache.james.mailbox.model.MailboxACL acl)
            throws org.apache.james.mailbox.exception.MailboxException

Throws:

org.apache.james.mailbox.exception.MailboxException