gnu.mail.providers.mbox

Class MboxFolder

public class MboxFolder extends Folder

The folder class implementing a UNIX mbox-format mailbox.

Constructor Summary
protected	MboxFolder(Store store, File file, boolean inbox) Constructor.

Method Summary
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.

Constructor Detail

MboxFolder

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

Constructor.

Method Detail

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.

appendMessages

public void appendMessages(Message[] m)

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.

Parameters: m an array of messages to be appended

close

public void close(boolean expunge)

Closes this folder.

Parameters: expunge if the folder is to be expunged before it is closed

Throws: MessagingException if a messaging error occurred

create

public boolean create(int type)

Creates this folder in the store.

decodeFrom

public static String decodeFrom(String line)

Returns the specified line with any From_ line encoding removed.

delete

public boolean delete(boolean recurse)

Deletes this folder.

exists

public boolean exists()

Indicates whether this folder exists.

Throws: MessagingException if a messaging error occurred

expunge

public Message[] expunge()

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

Throws: MessagingException if a messaging error occurred

fromLine

protected String fromLine(MboxMessage message)

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.

getFolder

public Folder getFolder(String name)

Returns the subfolder of this folder with the specified name.

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.