|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.mail.Folder
com.sun.mail.pop3.POP3Folder
public class POP3Folder
A POP3 Folder (can only be "INBOX"). See the com.sun.mail.pop3 package documentation for further information on the POP3 protocol provider.
Field Summary |
---|
Fields inherited from class javax.mail.Folder |
---|
HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store |
Method Summary | |
---|---|
void |
appendMessages(javax.mail.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(javax.mail.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. |
javax.mail.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(javax.mail.Message[] msgs,
javax.mail.FetchProfile fp)
Prefetch information about POP3 messages. |
protected void |
finalize()
Close the folder when we're finalized. |
javax.mail.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. |
javax.mail.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. |
javax.mail.Folder |
getParent()
Returns the parent folder of this folder. |
javax.mail.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(javax.mail.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. |
javax.mail.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,
javax.mail.Message m)
Notify all MessageChangedListeners. |
void |
open(int mode)
Throws FolderNotFoundException unless this
folder is named "INBOX". |
boolean |
renameTo(javax.mail.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 |
---|
public java.lang.String getName()
javax.mail.Folder
This method can be invoked on a closed Folder.
getName
in class javax.mail.Folder
public java.lang.String getFullName()
javax.mail.Folder
This method can be invoked on a closed Folder.
getFullName
in class javax.mail.Folder
public javax.mail.Folder getParent()
javax.mail.Folder
Note that since Folder objects are not cached, invoking this method returns a new distinct Folder object.
getParent
in class javax.mail.Folder
public boolean exists()
exists
in class javax.mail.Folder
Folder.create(int)
public javax.mail.Folder[] list(java.lang.String pattern) throws javax.mail.MessagingException
MessagingException
because no POP3 folders
can contain subfolders.
list
in class javax.mail.Folder
pattern
- the match pattern
javax.mail.MessagingException
- alwaysFolder.listSubscribed(java.lang.String)
public char getSeparator()
getSeparator
in class javax.mail.Folder
public int getType()
getType
in class javax.mail.Folder
Folder.HOLDS_FOLDERS
,
Folder.HOLDS_MESSAGES
public boolean create(int type) throws javax.mail.MessagingException
false
; the POP3 protocol doesn't
support creating folders.
create
in class javax.mail.Folder
type
- The type of this folder.
javax.mail.MessagingException
Folder.HOLDS_FOLDERS
,
Folder.HOLDS_MESSAGES
,
FolderEvent
public boolean hasNewMessages() throws javax.mail.MessagingException
false
; the POP3 protocol provides
no way to determine when a new message arrives.
hasNewMessages
in class javax.mail.Folder
javax.mail.MessagingException
public javax.mail.Folder getFolder(java.lang.String name) throws javax.mail.MessagingException
MessagingException
because no POP3 folders
can contain subfolders.
getFolder
in class javax.mail.Folder
name
- name of the Folder
javax.mail.MessagingException
- alwayspublic boolean delete(boolean recurse) throws javax.mail.MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't allow the INBOX to
be deleted.
delete
in class javax.mail.Folder
javax.mail.MethodNotSupportedException
- always
javax.mail.MessagingException
FolderEvent
public boolean renameTo(javax.mail.Folder f) throws javax.mail.MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't support multiple folders.
renameTo
in class javax.mail.Folder
f
- a folder representing the new name for this Folder
javax.mail.MethodNotSupportedException
- always
javax.mail.MessagingException
FolderEvent
public void open(int mode) throws javax.mail.MessagingException
FolderNotFoundException
unless this
folder is named "INBOX".
open
in class javax.mail.Folder
mode
- open the Folder READ_ONLY or READ_WRITE
javax.mail.FolderNotFoundException
- if not INBOX
AuthenticationException
- authentication failures
javax.mail.MessagingException
- other open failuresFolder.READ_ONLY
,
Folder.READ_WRITE
,
Folder.getType()
,
ConnectionEvent
public void close(boolean expunge) throws javax.mail.MessagingException
javax.mail.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 javax.mail.Folder
expunge
- expunges all deleted messages if this flag is true
javax.mail.MessagingException
ConnectionEvent
public boolean isOpen()
javax.mail.Folder
isOpen
in class javax.mail.Folder
public javax.mail.Flags getPermanentFlags()
Flags
object because
the POP3 protocol doesn't support any permanent flags.
getPermanentFlags
in class javax.mail.Folder
public int getMessageCount() throws javax.mail.MessagingException
getMessageCount
in class javax.mail.Folder
javax.mail.MessagingException
public javax.mail.Message getMessage(int msgno) throws javax.mail.MessagingException
javax.mail.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 javax.mail.Folder
msgno
- the message number
javax.mail.MessagingException
Folder.getMessageCount()
,
Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)
protected POP3Message createMessage(javax.mail.Folder f, int msgno) throws javax.mail.MessagingException
javax.mail.MessagingException
public void appendMessages(javax.mail.Message[] msgs) throws javax.mail.MessagingException
MethodNotSupportedException
because the POP3 protocol doesn't support appending messages.
appendMessages
in class javax.mail.Folder
msgs
- array of Messages to be appended
javax.mail.MethodNotSupportedException
- always
javax.mail.MessagingException
- if the append failed.public javax.mail.Message[] expunge() throws javax.mail.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 javax.mail.Folder
javax.mail.MethodNotSupportedException
- always
javax.mail.MessagingException
Message.isExpunged()
,
MessageCountEvent
public void fetch(javax.mail.Message[] msgs, javax.mail.FetchProfile fp) throws javax.mail.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 javax.mail.Folder
msgs
- fetch items for these messagesfp
- the FetchProfile
javax.mail.MessagingException
public java.lang.String getUID(javax.mail.Message msg) throws javax.mail.MessagingException
javax.mail.MessagingException
public int getSize() throws javax.mail.MessagingException
java.lang.IllegalStateException
- if the folder isn't open
javax.mail.MessagingException
public int[] getSizes() throws javax.mail.MessagingException
java.lang.IllegalStateException
- if the folder isn't open
javax.mail.MessagingException
public java.io.InputStream listCommand() throws javax.mail.MessagingException, java.io.IOException
java.lang.IllegalStateException
- if the folder isn't open
javax.mail.MessagingException
java.io.IOException
protected void finalize() throws java.lang.Throwable
finalize
in class javax.mail.Folder
java.lang.Throwable
protected void notifyMessageChangedListeners(int type, javax.mail.Message m)
javax.mail.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 javax.mail.Folder
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |