gnu.mail.providers.pop3
Class POP3Folder

java.lang.Object
  javax.mail.Folder
      gnu.mail.providers.pop3.POP3Folder

public final class POP3Folder
extends Folder

The folder class implementing the POP3 mail protocol.

Version:

1.3

Author:

Chris Burdess, Nic Ferrier

Field Summary

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store

Constructor Summary

protected

POP3Folder(Store store, int type) Constructor.

Method Summary

void	appendMessages(Message[] messages) You can't append messages to a POP3 folder.
void	close(boolean expunge) Closes this folder.
boolean	create(int i) POP3 folders can't be created, deleted, or renamed.
boolean	delete(boolean flag) POP3 folders can't be created, deleted, or renamed.
boolean	exists() Indicates whether this folder exists.
Message[]	expunge() Expunges this folder.
void	fetch(Message[] messages, FetchProfile fp) Fetches headers and/or content for the specified messages.
Folder	getFolder(String s) POP3 folders can't contain subfolders.
String	getFullName() Returns the full name of this folder.
Message	getMessage(int msgnum) Returns the specified message from this folder.
int	getMessageCount() Returns the number of messages in this folder.
String	getName() Returns the name of this folder.
Folder	getParent() POP3 folders can't have parents.
Flags	getPermanentFlags() Returns the permanent flags for this folder.
char	getSeparator() Returns the path separator charcter.
int	getType() Returns the type of this folder.
String	getUID(Message message) Returns the unique ID for the given message, or null if not available.
boolean	hasNewMessages() Indicates whether this folder contains new messages.
boolean	isOpen() Indicates whether this folder is open.
Folder[]	list() Returns the subfolders for this folder.
Folder[]	list(String pattern) Returns the subfolders for this folder.
void	open(int mode) Opens this folder.
boolean	renameTo(Folder folder) POP3 folders can't be created, deleted, or renamed.

Methods inherited from class javax.mail.Folder

addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, copyMessages, getDeletedMessageCount, getMessages, getMessages, getMessages, getMode, getNewMessageCount, getStore, getUnreadMessageCount, getURLName, 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

POP3Folder

protected POP3Folder(Store store,
                     int type)

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.

Specified by:

getFullName in class Folder

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.

Specified by:

open in class Folder

Parameters:

mode - open the Folder READ_ONLY or READ_WRITE

Throws:

MessagingException - if a messaging error occurred

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

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. This results in a STAT call to the POP3 server, so the latest count is always delivered.

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 from this folder.

Specified by:

getMessage in class Folder

Parameters:

msgnum - the message number

Throws:

MessagingException - if a messaging error occurred

appendMessages

public void appendMessages(Message[] messages)
                    throws MessagingException

You can't append messages to a POP3 folder.

Specified by:

appendMessages in class Folder

Parameters:

messages - array of messages to be appended

Throws:

FolderNotFoundException - if this folder does not exist

MessagingException - if the append operation failed

fetch

public void fetch(Message[] messages,
                  FetchProfile fp)
           throws MessagingException

Fetches headers and/or content for the specified messages.

Overrides:

fetch in class Folder

Parameters:

messages - the messages to fetch the items for

fp - the fetch profile

Throws:

MessagingException - ignore

list

public Folder[] list()
              throws MessagingException

Returns the subfolders for this folder.

Overrides:

list in class Folder

Throws:

MessagingException

list

public Folder[] list(String pattern)
              throws MessagingException

Returns the subfolders for this folder.

Specified by:

list in class Folder

Parameters:

pattern - the match pattern

Throws:

MessagingException

getParent

public Folder getParent()
                 throws MessagingException

POP3 folders can't have parents.

Specified by:

getParent in class Folder

Throws:

MessagingException

getFolder

public Folder getFolder(String s)
                 throws MessagingException

POP3 folders can't contain subfolders.

Specified by:

getFolder in class Folder

Parameters:

s - the name of the folder

Throws:

MessagingException

getSeparator

public char getSeparator()
                  throws MessagingException

Returns the path separator charcter.

Specified by:

getSeparator in class Folder

Throws:

MessagingException

create

public boolean create(int i)
               throws MessagingException

POP3 folders can't be created, deleted, or renamed.

Specified by:

create in class Folder

Parameters:

i - the desired type of the folder

Throws:

MessagingException

delete

public boolean delete(boolean flag)
               throws MessagingException

POP3 folders can't be created, deleted, or renamed.

Specified by:

delete in class Folder

Parameters:

flag - 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

POP3 folders can't be created, deleted, or renamed.

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

getUID

public String getUID(Message message)
              throws MessagingException

Returns the unique ID for the given message, or null if not available.

Parameters:

message - the message

Throws:

MessagingException