com.sun.mail.pop3
Class POP3Folder

java.lang.Object
  |
  +--javax.mail.Folder
        |
        +--com.sun.mail.pop3.POP3Folder

public class POP3Folder

extends Folder

A POP3 Folder (can only be "INBOX"). See the com.sun.mail.pop3 package documentation for further information on the POP3 protocol provider.

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store

Method Summary

void	appendMessages(Message[] msgs) Always throws MethodNotSupportedException because the POP3 protocol doesn't support appending messages.
void	close(boolean expunge) Close this Folder.
boolean	create(int type) Always returns false; the POP3 protocol doesn't support creating folders.
protected POP3Message	createMessage(Folder f, int msgno)
boolean	delete(boolean recurse) Always throws MethodNotSupportedException because the POP3 protocol doesn't allow the INBOX to be deleted.
boolean	exists() Always true for the folder "INBOX", always false for any other name.
Message[]	expunge() Always throws MethodNotSupportedException because the POP3 protocol doesn't support expunging messages without closing the folder; call the close method with the expunge argument set to true instead.
void	fetch(Message[] msgs, FetchProfile fp) Prefetch information about POP3 messages.
protected void	finalize() Close the folder when we're finalized.
Folder	getFolder(java.lang.String name) Always throws MessagingException because no POP3 folders can contain subfolders.
java.lang.String	getFullName() Returns the full name of this Folder.
Message	getMessage(int msgno) Get the Message object corresponding to the given message number.
int	getMessageCount() Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders.
java.lang.String	getName() Returns the name of this Folder.
Folder	getParent() Returns the parent folder of this folder.
Flags	getPermanentFlags() Always returns an empty Flags object because the POP3 protocol doesn't support any permanent flags.
char	getSeparator() Always returns a NUL character because POP3 doesn't support a hierarchy.
int	getType() Always returns Folder.HOLDS_MESSAGES.
java.lang.String	getUID(Message msg) Return the unique ID string for this message, or null if not available.
boolean	hasNewMessages() Always returns false; the POP3 protocol provides no way to determine when a new message arrives.
boolean	isOpen() Indicates whether this Folder is in the 'open' state.
Folder[]	list(java.lang.String pattern) Always throws MessagingException because no POP3 folders can contain subfolders.
protected void	notifyMessageChangedListeners(int type, Message m) Notify all MessageChangedListeners.
void	open(int mode) Throws FolderNotFoundException unless this folder is named "INBOX".
boolean	renameTo(Folder f) Always throws MethodNotSupportedException because the POP3 protocol doesn't support multiple folders.

Methods inherited from class javax.mail.Folder

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

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Description copied from class: Folder

Returns the name of this Folder.

This method can be invoked on a closed Folder.

Overrides:

getName in class Folder

Following copied from class: javax.mail.Folder

Returns:

name of the Folder

getFullName

public java.lang.String getFullName()

Description copied from class: Folder

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.

This method can be invoked on a closed Folder.

Overrides:

getFullName in class Folder

Following copied from class: javax.mail.Folder

Returns:

full name of the Folder

getParent

public Folder getParent()

Description copied from class: Folder

Returns the parent folder of this folder. This method can be invoked on a closed Folder. If this folder is the top of a folder hierarchy, this method returns null.

Note that since Folder objects are not cached, invoking this method returns a new distinct Folder object.

Overrides:

getParent in class Folder

Following copied from class: javax.mail.Folder

Returns:

Parent folder

exists

public boolean exists()

Always true for the folder "INBOX", always false for any other name.

Overrides:

exists in class Folder

Returns:

true for INBOX, false otherwise

list

public Folder[] list(java.lang.String pattern)
              throws MessagingException

Always throws MessagingException because no POP3 folders can contain subfolders.

Overrides:

list in class Folder

Throws:

MessagingException - always

getSeparator

public char getSeparator()

Always returns a NUL character because POP3 doesn't support a hierarchy.

Overrides:

getSeparator in class Folder

Returns:

NUL

getType

public int getType()

Always returns Folder.HOLDS_MESSAGES.

Overrides:

getType in class Folder

Returns:

Folder.HOLDS_MESSAGES

create

public boolean create(int type)
               throws MessagingException

Always returns false; the POP3 protocol doesn't support creating folders.

Overrides:

create in class Folder

Returns:

false

hasNewMessages

public boolean hasNewMessages()
                       throws MessagingException

Always returns false; the POP3 protocol provides no way to determine when a new message arrives.

Overrides:

hasNewMessages in class Folder

Returns:

false

getFolder

public Folder getFolder(java.lang.String name)
                 throws MessagingException

Always throws MessagingException because no POP3 folders can contain subfolders.

Overrides:

getFolder in class Folder

Throws:

MessagingException - always

delete

public boolean delete(boolean recurse)
               throws MessagingException

Always throws MethodNotSupportedException because the POP3 protocol doesn't allow the INBOX to be deleted.

Overrides:

delete in class Folder

Throws:

MethodNotSupportedException - always

renameTo

public boolean renameTo(Folder f)
                 throws MessagingException

Always throws MethodNotSupportedException because the POP3 protocol doesn't support multiple folders.

Overrides:

renameTo in class Folder

Throws:

MethodNotSupportedException - always

open

public void open(int mode)
          throws MessagingException

Throws FolderNotFoundException unless this folder is named "INBOX".

Overrides:

open in class Folder

Throws:

FolderNotFoundException - if not INBOX

AuthenticationException - authentication failures

MessagingException - other open failures

close

public void close(boolean expunge)
           throws MessagingException

Description copied from class: Folder

Close this Folder. This method is valid only on open Folders.

A CLOSED ConnectionEvent is delivered to any ConnectionListeners registered on this Folder. Note that the folder is closed even if this method terminates abnormally by throwing a MessagingException.

Overrides:

close in class Folder

Following copied from class: javax.mail.Folder

Parameters:

expunge - expunges all deleted messages if this flag is true

Throws:

IllegalStateException - if this folder is not opened

MessagingException -

See Also:

ConnectionEvent

isOpen

public boolean isOpen()

Description copied from class: Folder

Indicates whether this Folder is in the 'open' state.

Overrides:

isOpen in class Folder

Following copied from class: javax.mail.Folder

Returns:

true if this Folder is in the 'open' state.

getPermanentFlags

public Flags getPermanentFlags()

Always returns an empty Flags object because the POP3 protocol doesn't support any permanent flags.

Overrides:

getPermanentFlags in class Folder

Returns:

empty Flags object

getMessageCount

public int getMessageCount()
                    throws MessagingException

Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders.

Overrides:

getMessageCount in class Folder

Following copied from class: javax.mail.Folder

Returns:

total number of messages. -1 may be returned by certain implementations if this method is invoked on a closed folder.

Throws:

FolderNotFoundException - if this folder does not exist.

MessagingException -

getMessage

public Message getMessage(int msgno)
                   throws MessagingException

Description copied from class: Folder

Get the Message object corresponding to the given message number. A Message object's message number is the relative position of this Message in its Folder. Messages are numbered starting at 1 through the total number of message in the folder. Note that the message number for a particular Message can change during a session if other messages in the Folder are deleted and the Folder is expunged.

Message objects are light-weight references to the actual message that get filled up on demand. Hence Folder implementations are expected to provide light-weight Message objects.

Unlike Folder objects, repeated calls to getMessage with the same message number will return the same Message object, as long as no messages in this folder have been expunged.

Since message numbers can change within a session if the folder is expunged , clients are advised not to use message numbers as references to messages. Use Message objects instead.

Overrides:

getMessage in class Folder

Following copied from class: javax.mail.Folder

Parameters:

msgnum - the message number

Returns:

the Message object

Throws:

FolderNotFoundException - if this folder does not exist.

IllegalStateException - if this folder is not opened

IndexOutOfBoundsException - if the message number is out of range.

MessagingException -

See Also:

Folder.getMessageCount(), Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)

createMessage

protected POP3Message createMessage(Folder f,
                                    int msgno)
                             throws MessagingException

appendMessages

public void appendMessages(Message[] msgs)
                    throws MessagingException

Always throws MethodNotSupportedException because the POP3 protocol doesn't support appending messages.

Overrides:

appendMessages in class Folder

Throws:

MethodNotSupportedException - always

expunge

public Message[] expunge()
                  throws MessagingException

Always throws MethodNotSupportedException because the POP3 protocol doesn't support expunging messages without closing the folder; call the close method with the expunge argument set to true instead.

Overrides:

expunge in class Folder

Throws:

MethodNotSupportedException - always

fetch

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

Prefetch information about POP3 messages. If the FetchProfile contains UIDFolder.FetchProfileItem.UID, POP3 UIDs for all messages in the folder are fetched using the POP3 UIDL command. If the FetchProfile contains FetchProfile.Item.ENVELOPE, the headers and size of all messages are fetched using the POP3 TOP and LIST commands.

Overrides:

fetch in class Folder

Following copied from class: javax.mail.Folder

Parameters:

msgs - fetch items for these messages

fp - the FetchProfile

Throws:

IllegalStateException - if this folder is not opened

MessagingException. -

getUID

public java.lang.String getUID(Message msg)
                        throws MessagingException

Return the unique ID string for this message, or null if not available. Uses the POP3 UIDL command.

Returns:

unique ID string

Throws:

MessagingException -

finalize

protected void finalize()
                 throws java.lang.Throwable

Close the folder when we're finalized.

Overrides:

finalize in class Folder

notifyMessageChangedListeners

protected void notifyMessageChangedListeners(int type,
                                             Message m)

Description copied from class: Folder

Notify all MessageChangedListeners. Folder implementations are expected to use this method to broadcast MessageChanged events.

The provided implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to registered MessageChangedListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.

Overrides:

notifyMessageChangedListeners in class Folder