gnu.mail.providers.mbox

Class MboxFolder

java.lang.Object

javax.mail.Folder

gnu.mail.providers.mbox.MboxFolder

public class MboxFolder
extends Folder

The folder class implementing a UNIX mbox-format mailbox.

Author:

Chris Burdess

Field Summary

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MboxFolder(Store store, File file, boolean inbox) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acquireLock() Locks this mailbox.
void	appendMessages(Message[] m) Appends messages to this folder.
void	close(boolean expunge) Closes this folder.
boolean	create(int type) Creates this folder in the store.
static String	decodeFrom(String line) Returns the specified line with any From_ line encoding removed.
boolean	delete(boolean recurse) Deletes this folder.
boolean	exists() Indicates whether this folder exists.
Message[]	expunge() Expunges this folder.
protected String	fromLine(MboxMessage message) Returns the From_ line for the specified mbox message.
Folder	getFolder(String name) Returns the subfolder of this folder with the specified name.
String	getFullName() Returns the full name of this folder.
Message	getMessage(int msgnum) Returns the specified message number from this folder.
int	getMessageCount() Returns the number of messages in this folder.
Message[]	getMessages() Returns the messages in this folder.
String	getName() Returns the name of this folder.
Folder	getParent() Returns the parent folder.
Flags	getPermanentFlags() Returns the permanent flags for this folder.
char	getSeparator() Returns the separator character.
int	getType() Returns the type of this folder.
URLName	getURLName() Return a URLName representing this folder.
boolean	hasNewMessages() Indicates whether this folder contains new messages.
boolean	isOpen() Indicates whether this folder is open.
Folder[]	list() Returns the subfolders of this folder.
Folder[]	list(String pattern) Returns the subfolders of this folder matching the specified pattern.
void	open(int mode) Opens this folder.
boolean	releaseLock() Unlocks this mailbox.
boolean	renameTo(Folder folder) Renames this folder.

Methods inherited from class javax.mail.Folder

addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, copyMessages, fetch, getDeletedMessageCount, getMessages, getMessages, getMode, getNewMessageCount, getStore, getUnreadMessageCount, isSubscribed, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MboxFolder

protected MboxFolder(Store store,
                     File file,
                     boolean inbox)

Constructor.

Method Detail

getName

public String getName()

Returns the name of this folder.

Specified by:

getName in class Folder

getFullName

public String getFullName()

Returns the full name of this folder. If the folder resides under the root hierarchy of this Store, the returned name is relative to the root. Otherwise an absolute name, starting with the hierarchy delimiter, is returned.

Specified by:

getFullName in class Folder

getURLName

public URLName getURLName()
                   throws MessagingException

Return a URLName representing this folder.

Overrides:

getURLName in class Folder

Throws:

MessagingException

getType

public int getType()
            throws MessagingException

Returns the type of this folder.

Specified by:

getType in class Folder

Throws:

MessagingException - if a messaging error occurred

exists

public boolean exists()
               throws MessagingException

Indicates whether this folder exists.

Specified by:

exists in class Folder

Throws:

MessagingException - if a messaging error occurred

hasNewMessages

public boolean hasNewMessages()
                       throws MessagingException

Indicates whether this folder contains new messages.

Specified by:

hasNewMessages in class Folder

Throws:

MessagingException - if a messaging error occurred

open

public void open(int mode)
          throws MessagingException

Opens this folder. If the folder is opened for writing, a lock must be acquired on the mbox. If this fails a MessagingException is thrown.

Specified by:

open in class Folder

Parameters:

mode - open the Folder READ_ONLY or READ_WRITE

Throws:

MessagingException - if a messaging error occurred

decodeFrom

public static String decodeFrom(String line)

Returns the specified line with any From_ line encoding removed.

close

public void close(boolean expunge)
           throws MessagingException

Closes this folder.

Specified by:

close in class Folder

Parameters:

expunge - if the folder is to be expunged before it is closed

Throws:

MessagingException - if a messaging error occurred

fromLine

protected String fromLine(MboxMessage message)
                   throws MessagingException

Returns the From_ line for the specified mbox message. If this does not already exist(the message was appended to the folder since it was last opened), we will attempt to generate a suitable From_ line for it.

Throws:

MessagingException

expunge

public Message[] expunge()
                  throws MessagingException

Expunges this folder. This deletes all the messages marked as deleted.

Specified by:

expunge in class Folder

Throws:

MessagingException - if a messaging error occurred

isOpen

public boolean isOpen()

Indicates whether this folder is open.

Specified by:

isOpen in class Folder

getPermanentFlags

public Flags getPermanentFlags()

Returns the permanent flags for this folder.

Specified by:

getPermanentFlags in class Folder

getMessageCount

public int getMessageCount()
                    throws MessagingException

Returns the number of messages in this folder.

Specified by:

getMessageCount in class Folder

Throws:

MessagingException - if a messaging error occurred

getMessage

public Message getMessage(int msgnum)
                   throws MessagingException

Returns the specified message number from this folder.

Specified by:

getMessage in class Folder

Parameters:

msgnum - the message number

Throws:

MessagingException - if a messaging error occurred

getMessages

public Message[] getMessages()
                      throws MessagingException

Returns the messages in this folder.

Overrides:

getMessages in class Folder

Throws:

MessagingException - if a messaging error occurred

appendMessages

public void appendMessages(Message[] m)
                    throws MessagingException

Appends messages to this folder. Only MimeMessages within the array will be appended, as we don't know how to retrieve internet content for other kinds.

Specified by:

appendMessages in class Folder

Parameters:

m - an array of messages to be appended

Throws:

FolderNotFoundException - if this folder does not exist

MessagingException - if the append operation failed

getParent

public Folder getParent()
                 throws MessagingException

Returns the parent folder.

Specified by:

getParent in class Folder

Throws:

MessagingException

list

public Folder[] list()
              throws MessagingException

Returns the subfolders of this folder.

Overrides:

list in class Folder

Throws:

MessagingException

list

public Folder[] list(String pattern)
              throws MessagingException

Returns the subfolders of this folder matching the specified pattern.

Specified by:

list in class Folder

Parameters:

pattern - the match pattern

Throws:

MessagingException

getSeparator

public char getSeparator()
                  throws MessagingException

Returns the separator character.

Specified by:

getSeparator in class Folder

Throws:

MessagingException

create

public boolean create(int type)
               throws MessagingException

Creates this folder in the store.

Specified by:

create in class Folder

Parameters:

type - the desired type of the folder

Throws:

MessagingException

delete

public boolean delete(boolean recurse)
               throws MessagingException

Deletes this folder.

Specified by:

delete in class Folder

Parameters:

recurse - delete any subfolders

Returns:

true if the folder is deleted successfully, false otherwise

Throws:

FolderNotFoundException - if this folder does not exist

MessagingException

renameTo

public boolean renameTo(Folder folder)
                 throws MessagingException

Renames this folder.

Specified by:

renameTo in class Folder

Parameters:

folder - a folder representing the new name for this folder

Returns:

true if the folder is renamed successfully, false otherwise

Throws:

FolderNotFoundException - if this folder does not exist

MessagingException

getFolder

public Folder getFolder(String name)
                 throws MessagingException

Returns the subfolder of this folder with the specified name.

Specified by:

getFolder in class Folder

Parameters:

name - the name of the folder

Throws:

MessagingException

acquireLock

public boolean acquireLock()

Locks this mailbox. This uses a dotlock-like mechanism - see createNewFile(). If the directory containing the mbox folder is not writable, we will not be able to open the mbox for writing either.

releaseLock

public boolean releaseLock()

Unlocks this mailbox. This deletes any associated lockfile if it exists. It returns false if an existing lockfile could not be deleted.