Module com.sun.mail.pop3

Package com.sun.mail.pop3

Class POP3Folder

java.lang.Object

javax.mail.Folder

com.sun.mail.pop3.POP3Folder

All Implemented Interfaces:

java.lang.AutoCloseable

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.

Author:

Bill Shannon, John Mani (ported to the javax.mail APIs)

Field Summary

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	POP3Folder(POP3Store store, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	appendMessages(Message[] msgs)	Always throws MethodNotSupportedException because the POP3 protocol doesn't support appending messages.
void	close(boolean expunge)
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()
Message	getMessage(int msgno)
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()
Folder	getParent()
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	getSize()	Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened.
int[]	getSizes()	Return the sizes of all messages in this folder, as returned by the POP3 LIST command.
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()
Folder[]	list(java.lang.String pattern)	Always throws MessagingException because no POP3 folders can contain subfolders.
java.io.InputStream	listCommand()	Return the raw results of the POP3 LIST command with no arguments.
protected void	notifyMessageChangedListeners(int type, Message m)
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, close, 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

Constructor Detail

POP3Folder

protected POP3Folder(POP3Store store,
                     java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class Folder

getFullName

public java.lang.String getFullName()

Specified by:

getFullName in class Folder

getParent

public Folder getParent()

Specified by:

getParent in class Folder

exists

public boolean exists()

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

Specified by:

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.

Specified by:

list in class Folder

Throws:

MessagingException - always

getSeparator

public char getSeparator()

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

Specified by:

getSeparator in class Folder

Returns:

NUL

getType

public int getType()

Always returns Folder.HOLDS_MESSAGES.

Specified by:

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.

Specified by:

create in class Folder

Returns:

false

Throws:

MessagingException

hasNewMessages

public boolean hasNewMessages()
                       throws MessagingException

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

Specified by:

hasNewMessages in class Folder

Returns:

false

Throws:

MessagingException

getFolder

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

Always throws MessagingException because no POP3 folders can contain subfolders.

Specified by:

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.

Specified by:

delete in class Folder

Throws:

MethodNotSupportedException - always

MessagingException

renameTo

public boolean renameTo(Folder f)
                 throws MessagingException

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

Specified by:

renameTo in class Folder

Throws:

MethodNotSupportedException - always

MessagingException

open

public void open(int mode)
          throws MessagingException

Throws FolderNotFoundException unless this folder is named "INBOX".

Specified by:

open in class Folder

Throws:

FolderNotFoundException - if not INBOX

AuthenticationFailedException - authentication failures

MessagingException - other open failures

close

public void close(boolean expunge)
           throws MessagingException

Specified by:

close in class Folder

Throws:

MessagingException

isOpen

public boolean isOpen()

Specified by:

isOpen in class Folder

getPermanentFlags

public Flags getPermanentFlags()

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

Specified by:

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.

Specified by:

getMessageCount in class Folder

Throws:

MessagingException

getMessage

public Message getMessage(int msgno)
                   throws MessagingException

Specified by:

getMessage in class Folder

Throws:

MessagingException

createMessage

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

Throws:

MessagingException

appendMessages

public void appendMessages(Message[] msgs)
                    throws MessagingException

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

Specified by:

appendMessages in class Folder

Throws:

MethodNotSupportedException - always

MessagingException

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.

Specified by:

expunge in class Folder

Throws:

MethodNotSupportedException - always

MessagingException

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

Throws:

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.

Parameters:

msg - the message

Returns:

unique ID string

Throws:

MessagingException - for failures

getSize

public int getSize()
            throws MessagingException

Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened.

Returns:

folder size

Throws:

java.lang.IllegalStateException - if the folder isn't open

MessagingException - for other failures

getSizes

public int[] getSizes()
               throws MessagingException

Return the sizes of all messages in this folder, as returned by the POP3 LIST command. Each entry in the array corresponds to a message; entry i corresponds to message number i+1.

Returns:

array of message sizes

Throws:

java.lang.IllegalStateException - if the folder isn't open

MessagingException - for other failures

Since:

JavaMail 1.3.3

listCommand

public java.io.InputStream listCommand()
                                throws MessagingException,
                                       java.io.IOException

Return the raw results of the POP3 LIST command with no arguments.

Returns:

InputStream containing results

Throws:

java.lang.IllegalStateException - if the folder isn't open

java.io.IOException - for I/O errors talking to the server

MessagingException - for other errors

Since:

JavaMail 1.3.3

finalize

protected void finalize()
                 throws java.lang.Throwable

Close the folder when we're finalized.

Overrides:

finalize in class Folder

Throws:

java.lang.Throwable

notifyMessageChangedListeners

protected void notifyMessageChangedListeners(int type,
                                             Message m)

Overrides:

notifyMessageChangedListeners in class Folder