Package 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
Constructors Modifier Constructor Description protected
POP3Folder(Store store, int type)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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(java.lang.String s)
POP3 folders can't contain subfolders.java.lang.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.java.lang.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.java.lang.String
getUID(Message message)
Returns the unique ID for the given message, ornull
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(java.lang.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
-
-
-
-
Constructor Detail
-
POP3Folder
protected POP3Folder(Store store, int type)
Constructor.
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name of this folder.
-
getFullName
public java.lang.String getFullName()
Returns the full name of this folder.- Specified by:
getFullName
in classFolder
-
getType
public int getType() throws MessagingException
Returns the type of this folder.- Specified by:
getType
in classFolder
- Throws:
MessagingException
- if a messaging error occurred
-
exists
public boolean exists() throws MessagingException
Indicates whether this folder exists.- Specified by:
exists
in classFolder
- Throws:
MessagingException
- if a messaging error occurred
-
hasNewMessages
public boolean hasNewMessages() throws MessagingException
Indicates whether this folder contains new messages.- Specified by:
hasNewMessages
in classFolder
- Throws:
MessagingException
- if a messaging error occurred
-
open
public void open(int mode) throws MessagingException
Opens this folder.- Specified by:
open
in classFolder
- 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 classFolder
- 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 classFolder
- Throws:
MessagingException
- if a messaging error occurred
-
isOpen
public boolean isOpen()
Indicates whether this folder is open.
-
getPermanentFlags
public Flags getPermanentFlags()
Returns the permanent flags for this folder.- Specified by:
getPermanentFlags
in classFolder
-
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 classFolder
- 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 classFolder
- 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 classFolder
- Parameters:
messages
- array of messages to be appended- Throws:
FolderNotFoundException
- if this folder does not existMessagingException
- 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 classFolder
- Parameters:
messages
- the messages to fetch the items forfp
- the fetch profile- Throws:
MessagingException
- ignore
-
list
public Folder[] list() throws MessagingException
Returns the subfolders for this folder.- Overrides:
list
in classFolder
- Throws:
MessagingException
-
list
public Folder[] list(java.lang.String pattern) throws MessagingException
Returns the subfolders for this folder.- Specified by:
list
in classFolder
- Parameters:
pattern
- the match pattern- Throws:
MessagingException
-
getParent
public Folder getParent() throws MessagingException
POP3 folders can't have parents.- Specified by:
getParent
in classFolder
- Throws:
MessagingException
-
getFolder
public Folder getFolder(java.lang.String s) throws MessagingException
POP3 folders can't contain subfolders.- Specified by:
getFolder
in classFolder
- Parameters:
s
- the name of the folder- Throws:
MessagingException
-
getSeparator
public char getSeparator() throws MessagingException
Returns the path separator charcter.- Specified by:
getSeparator
in classFolder
- Throws:
MessagingException
-
create
public boolean create(int i) throws MessagingException
POP3 folders can't be created, deleted, or renamed.- Specified by:
create
in classFolder
- 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 classFolder
- Parameters:
flag
- delete any subfolders- Returns:
- true if the folder is deleted successfully, false otherwise
- Throws:
FolderNotFoundException
- if this folder does not existMessagingException
-
renameTo
public boolean renameTo(Folder folder) throws MessagingException
POP3 folders can't be created, deleted, or renamed.- Specified by:
renameTo
in classFolder
- 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 existMessagingException
-
getUID
public java.lang.String getUID(Message message) throws MessagingException
Returns the unique ID for the given message, ornull
if not available.- Parameters:
message
- the message- Throws:
MessagingException
-
-