public class POP3Folder extends Folder
HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE
Modifier and Type | Method and Description |
---|---|
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(String name)
Always throws
MessagingException because no POP3 folders
can contain subfolders. |
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.
|
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 |
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.
|
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(String pattern)
Always throws
MessagingException because no POP3 folders
can contain subfolders. |
InputStream |
listCommand()
Return the raw results of the POP3 LIST command with no arguments.
|
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. |
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
public String getName()
Folder
This method can be invoked on a closed Folder.
public String getFullName()
Folder
This method can be invoked on a closed Folder.
getFullName
in class Folder
public Folder getParent()
Folder
Note that since Folder objects are not cached, invoking this method returns a new distinct Folder object.
public boolean exists()
exists
in class Folder
Folder.create(int)
public Folder[] list(String pattern) throws MessagingException
MessagingException
because no POP3 folders
can contain subfolders.list
in class Folder
pattern
- the match patternMessagingException
- alwaysFolder.listSubscribed(java.lang.String)
public char getSeparator()
getSeparator
in class Folder
public int getType()
getType
in class Folder
Folder.HOLDS_FOLDERS
,
Folder.HOLDS_MESSAGES
public boolean create(int type) throws MessagingException
false
; the POP3 protocol doesn't
support creating folders.create
in class Folder
type
- The type of this folder.MessagingException
Folder.HOLDS_FOLDERS
,
Folder.HOLDS_MESSAGES
,
FolderEvent
public boolean hasNewMessages() throws MessagingException
false
; the POP3 protocol provides
no way to determine when a new message arrives.hasNewMessages
in class Folder
FolderNotFoundException
- if this folder does
not exist.MessagingException
public Folder getFolder(String name) throws MessagingException
MessagingException
because no POP3 folders
can contain subfolders.getFolder
in class Folder
name
- name of the FolderMessagingException
- alwayspublic boolean delete(boolean recurse) throws MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't allow the INBOX to
be deleted.delete
in class Folder
MethodNotSupportedException
- alwaysFolderNotFoundException
- if this folder does
not existMessagingException
FolderEvent
public boolean renameTo(Folder f) throws MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't support multiple folders.renameTo
in class Folder
f
- a folder representing the new name for this FolderMethodNotSupportedException
- alwaysFolderNotFoundException
- if this folder does
not existMessagingException
FolderEvent
public void open(int mode) throws MessagingException
FolderNotFoundException
unless this
folder is named "INBOX".open
in class Folder
mode
- open the Folder READ_ONLY or READ_WRITEFolderNotFoundException
- if not INBOXAuthenticationException
- authentication failuresMessagingException
- other open failuresFolder.READ_ONLY
,
Folder.READ_WRITE
,
Folder.getType()
,
ConnectionEvent
public void close(boolean expunge) throws MessagingException
Folder
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.
close
in class Folder
expunge
- expunges all deleted messages if this flag is trueMessagingException
ConnectionEvent
public boolean isOpen()
Folder
public Flags getPermanentFlags()
Flags
object because
the POP3 protocol doesn't support any permanent flags.getPermanentFlags
in class Folder
public int getMessageCount() throws MessagingException
getMessageCount
in class Folder
FolderNotFoundException
- if this folder does
not exist.MessagingException
public Message getMessage(int msgno) throws MessagingException
Folder
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.
getMessage
in class Folder
msgno
- the message numberFolderNotFoundException
- if this folder does
not exist.MessagingException
Folder.getMessageCount()
,
Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)
protected POP3Message createMessage(Folder f, int msgno) throws MessagingException
MessagingException
public void appendMessages(Message[] msgs) throws MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't support appending messages.appendMessages
in class Folder
msgs
- array of Messages to be appendedMethodNotSupportedException
- alwaysFolderNotFoundException
- if this folder does
not exist.MessagingException
- if the append failed.public Message[] expunge() throws MessagingException
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.expunge
in class Folder
MethodNotSupportedException
- alwaysFolderNotFoundException
- if this folder does not
existMessagingException
Message.isExpunged()
,
MessageCountEvent
public void fetch(Message[] msgs, FetchProfile fp) throws MessagingException
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.fetch
in class Folder
msgs
- fetch items for these messagesfp
- the FetchProfileMessagingException
public String getUID(Message msg) throws MessagingException
MessagingException
public int getSize() throws MessagingException
IllegalStateException
- if the folder isn't openMessagingException
public int[] getSizes() throws MessagingException
IllegalStateException
- if the folder isn't openMessagingException
public InputStream listCommand() throws MessagingException, IOException
IllegalStateException
- if the folder isn't openMessagingException
IOException
protected void finalize() throws Throwable
protected void notifyMessageChangedListeners(int type, Message m)
Folder
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.
notifyMessageChangedListeners
in class Folder
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.