org.apache.james.protocols.pop3.mailbox

Interface Mailbox

All Known Implementing Classes:

AbstractMailbox

public interface Mailbox

A Mailbox which is used in POP3 to retrieve messages

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the mailbox, Any futher attempt to access or change the Mailbox's content will fail
String	getIdentifier() Return the identifier for the mailbox.
InputStream	getMessage(long uid) Return the full message (headers + body) as InputStream or null if no message can be found for the given uid
InputStream	getMessageBody(long uid) Returns the message body as InputStream or null if no message can be found for the given uid
InputStream	getMessageHeaders(long uid) Returns the message headers as InputStream or null if no message can be found for the given uid
List<MessageMetaData>	getMessages() Return a immutable List which holds the MessageMetaData for all messages in the Mailbox
void	remove(long... uids) Remove the messages with the given uids

Method Detail

getMessageBody

InputStream getMessageBody(long uid)
                           throws IOException

Returns the message body as InputStream or null if no message can be found for the given uid

Parameters:

uid -

Returns:

body

Throws:

IOException

getMessageHeaders

InputStream getMessageHeaders(long uid)
                              throws IOException

Returns the message headers as InputStream or null if no message can be found for the given uid

Parameters:

uid -

Returns:

headers

Throws:

IOException

getMessage

InputStream getMessage(long uid)
                       throws IOException

Return the full message (headers + body) as InputStream or null if no message can be found for the given uid

Parameters:

uid -

Returns:

message

Throws:

IOException

getMessages

List<MessageMetaData> getMessages()
                                  throws IOException

Return a immutable List which holds the MessageMetaData for all messages in the Mailbox

Returns:

messages

Throws:

IOException

remove

void remove(long... uids)
            throws IOException

Remove the messages with the given uids

Parameters:

uids -

Throws:

IOException

getIdentifier

String getIdentifier()
                     throws IOException

Return the identifier for the mailbox. This MUST not change

Returns:

identifer

Throws:

IOException

close

void close()
           throws IOException

Close the mailbox, Any futher attempt to access or change the Mailbox's content will fail

Throws:

IOException