org.apache.james.mailbox.maildir

Class MaildirStore

java.lang.Object

org.apache.james.mailbox.maildir.MaildirStore

All Implemented Interfaces:

org.apache.james.mailbox.store.mail.ModSeqProvider<Integer>, org.apache.james.mailbox.store.mail.UidProvider<Integer>

public class MaildirStore
extends Object
implements org.apache.james.mailbox.store.mail.UidProvider<Integer>, org.apache.james.mailbox.store.mail.ModSeqProvider<Integer>

Field Summary

Fields

Modifier and Type	Field and Description
static String	maildirDelimiter
static String	PATH_DOMAIN
static String	PATH_FULLUSER
static String	PATH_USER
static String	WILDCARD

Constructor Summary

Constructors

Constructor and Description
MaildirStore(String maildirLocation)
MaildirStore(String maildirLocation, org.apache.james.mailbox.MailboxPathLocker locker) Construct a MaildirStore with a location.

Method Summary

Methods

Modifier and Type	Method and Description
MaildirFolder	createMaildirFolder(org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox) Create a MaildirFolder for a mailbox
String	getFolderName(org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox) Get the absolute name of the folder for a specific mailbox
String	getFolderName(org.apache.james.mailbox.model.MailboxPath mailboxPath) Get the absolute name of the folder for a specific mailbox
String	getFolderName(String namespace, String user, String name) Get the absolute name of the folder for a specific mailbox
String	getMailboxNameFromFolderName(String folderName) Transforms a folder name into a mailbox name
File	getMailboxRootForUser(String user) The main maildir folder containing all mailboxes for one user
String	getMaildirLocation()
File	getMaildirRoot() Return a File which is the root of all Maidirs.
long	highestModSeq(org.apache.james.mailbox.MailboxSession session, org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
boolean	isMessageNameStrictParse() Returns whether the names of message files in this store are parsed in a strict manner (true), which means a size field and flags are expected.
long	lastUid(org.apache.james.mailbox.MailboxSession session, org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
org.apache.james.mailbox.store.mail.model.Mailbox<Integer>	loadMailbox(org.apache.james.mailbox.MailboxSession session, File root, String namespace, String user, String folderName) Creates a Mailbox object with data loaded from the file system
org.apache.james.mailbox.store.mail.model.Mailbox<Integer>	loadMailbox(org.apache.james.mailbox.MailboxSession session, org.apache.james.mailbox.model.MailboxPath mailboxPath) Creates a Mailbox object with data loaded from the file system
long	nextModSeq(org.apache.james.mailbox.MailboxSession session, org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
long	nextUid(org.apache.james.mailbox.MailboxSession session, org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
void	setMessageNameStrictParse(boolean messageNameStrictParse) Specifies whether the names of message files in this store are parsed in a strict manner (true), which means a size field and flags are expected.
String	userRoot(String user) Inserts the user name parts in the general maildir location String

Methods inherited from class java.lang.Object

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

Field Detail

PATH_USER

public static final String PATH_USER

See Also:

Constant Field Values

PATH_DOMAIN

public static final String PATH_DOMAIN

See Also:

Constant Field Values

PATH_FULLUSER

public static final String PATH_FULLUSER

See Also:

Constant Field Values

WILDCARD

public static final String WILDCARD

See Also:

Constant Field Values

maildirDelimiter

public static final String maildirDelimiter

See Also:

Constant Field Values

Constructor Detail

MaildirStore

public MaildirStore(String maildirLocation,
            org.apache.james.mailbox.MailboxPathLocker locker)

Construct a MaildirStore with a location. The location String currently may contain the %user, %domain, %fulluser variables.

Parameters:

maildirLocation - A String with variables

locker -

MaildirStore

public MaildirStore(String maildirLocation)

Method Detail

getMaildirLocation

public String getMaildirLocation()

createMaildirFolder

public MaildirFolder createMaildirFolder(org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)

Create a MaildirFolder for a mailbox

Parameters:

mailbox -

Returns:

The MaildirFolder

loadMailbox

public org.apache.james.mailbox.store.mail.model.Mailbox<Integer> loadMailbox(org.apache.james.mailbox.MailboxSession session,
                                                                     File root,
                                                                     String namespace,
                                                                     String user,
                                                                     String folderName)
                                                                       throws org.apache.james.mailbox.exception.MailboxException

Creates a Mailbox object with data loaded from the file system

Parameters:

root - The main maildir folder containing the mailbox to load

namespace - The namespace to use

user - The owner of this mailbox

folderName - The name of the mailbox folder

Returns:

The Mailbox object populated with data from the file system

Throws:

org.apache.james.mailbox.exception.MailboxException - If the mailbox folder doesn't exist or can't be read

loadMailbox

public org.apache.james.mailbox.store.mail.model.Mailbox<Integer> loadMailbox(org.apache.james.mailbox.MailboxSession session,
                                                                     org.apache.james.mailbox.model.MailboxPath mailboxPath)
                                                                       throws org.apache.james.mailbox.exception.MailboxNotFoundException,
                                                                              org.apache.james.mailbox.exception.MailboxException

Creates a Mailbox object with data loaded from the file system

Parameters:

mailboxPath - The path of the mailbox

Returns:

The Mailbox object populated with data from the file system

Throws:

org.apache.james.mailbox.exception.MailboxNotFoundException - If the mailbox folder doesn't exist

org.apache.james.mailbox.exception.MailboxException - If the mailbox folder can't be read

userRoot

public String userRoot(String user)

Inserts the user name parts in the general maildir location String

Parameters:

user - The user to get the root for.

Returns:

The name of the folder which contains the specified user's mailbox

getMailboxRootForUser

public File getMailboxRootForUser(String user)
                           throws org.apache.james.mailbox.exception.MailboxException

The main maildir folder containing all mailboxes for one user

Parameters:

user - The user name of a mailbox

Returns:

A File object referencing the main maildir folder

Throws:

org.apache.james.mailbox.exception.MailboxException - If the folder does not exist or is no directory

getMaildirRoot

public File getMaildirRoot()

Return a File which is the root of all Maidirs. The returned maidirRootFile is lazilly constructured.

Returns:

maidirRootFile

getMailboxNameFromFolderName

public String getMailboxNameFromFolderName(String folderName)

Transforms a folder name into a mailbox name

Parameters:

folderName - The name of the mailbox folder

Returns:

The complete (namespace) name of a mailbox

getFolderName

public String getFolderName(String namespace,
                   String user,
                   String name)

Get the absolute name of the folder for a specific mailbox

Parameters:

namespace - The namespace of the mailbox

user - The user of the mailbox

name - The name of the mailbox

Returns:

absolute name

getFolderName

public String getFolderName(org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)

Get the absolute name of the folder for a specific mailbox

Parameters:

mailbox - The mailbox

Returns:

The absolute path to the folder containing the mailbox

getFolderName

public String getFolderName(org.apache.james.mailbox.model.MailboxPath mailboxPath)

Get the absolute name of the folder for a specific mailbox

Parameters:

mailboxPath - The MailboxPath

Returns:

The absolute path to the folder containing the mailbox

nextUid

public long nextUid(org.apache.james.mailbox.MailboxSession session,
           org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
             throws org.apache.james.mailbox.exception.MailboxException

Specified by:

nextUid in interface org.apache.james.mailbox.store.mail.UidProvider<Integer>

Throws:

org.apache.james.mailbox.exception.MailboxException

See Also:

UidProvider.nextUid(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox)

nextModSeq

public long nextModSeq(org.apache.james.mailbox.MailboxSession session,
              org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
                throws org.apache.james.mailbox.exception.MailboxException

Specified by:

nextModSeq in interface org.apache.james.mailbox.store.mail.ModSeqProvider<Integer>

Throws:

org.apache.james.mailbox.exception.MailboxException

highestModSeq

public long highestModSeq(org.apache.james.mailbox.MailboxSession session,
                 org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
                   throws org.apache.james.mailbox.exception.MailboxException

Specified by:

highestModSeq in interface org.apache.james.mailbox.store.mail.ModSeqProvider<Integer>

Throws:

org.apache.james.mailbox.exception.MailboxException

lastUid

public long lastUid(org.apache.james.mailbox.MailboxSession session,
           org.apache.james.mailbox.store.mail.model.Mailbox<Integer> mailbox)
             throws org.apache.james.mailbox.exception.MailboxException

Specified by:

lastUid in interface org.apache.james.mailbox.store.mail.UidProvider<Integer>

Throws:

org.apache.james.mailbox.exception.MailboxException

isMessageNameStrictParse

public boolean isMessageNameStrictParse()

Returns whether the names of message files in this store 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 store are parsed in a strict manner (true), which means a size field and flags are expected. Default is false.

Parameters:

messageNameStrictParse -