JavaMail API 1.6.2 · com.sun.mail.imap.IMAPFolder

Modifier and Type	Class and Description
public static class	IMAPFolder.FetchProfileItem A fetch profile item for fetching headers.
public static interface	IMAPFolder.ProtocolCommand A simple interface for user-defined IMAP protocol commands.

Modifier and Type	Field and Description
private static final int	ABORTING
protected volatile String[]	attributes
protected Flags	availableFlags
private Status	cachedStatus
private long	cachedStatusTime
private MailLogger	connectionPoolLogger
private boolean	doExpungeNotification
protected volatile boolean	exists
protected volatile String	fullName
private boolean	hasMessageCountListener
private volatile long	highestmodseq
private static final int	IDLE
private IdleManager	idleManager
private int	idleState
protected boolean	isNamespace
protected MailLogger	logger
protected MessageCache	messageCache
protected final Object	messageCacheLock
protected String	name
private volatile boolean	opened
protected Flags	permanentFlags
protected volatile IMAPProtocol	protocol
private boolean	reallyClosed
private int	realTotal
private volatile int	recent
private static final int	RUNNING
protected char	separator
private volatile int	total
protected int	type
private long	uidnext
private boolean	uidNotSticky
protected Hashtable<Long, IMAPMessage>	uidTable
private long	uidvalidity
protected static final char	UNKNOWN_SEPARATOR

Access	Constructor and Description
protected	IMAPFolder(String fullname of this folder fullName, char the default separator character for this folder's namespace separator, IMAPStore the Store store, Boolean if this folder represents a namespace isNamespace) Constructor used to create a possibly non-existent folder.
protected	IMAPFolder(ListInfo the ListInfo for this folder li, IMAPStore the store containing this folder store) Constructor used to create an existing folder.

Method Summary

Modifier and Type	Method and Description
public void	addACL(ACL the access control list entry to add acl) Add an access control list entry to the access control list for this folder.
public synchronized void	addMessageCountListener(MessageCountListener the Listener for MessageCount events l) Overrides javax.mail.Folder.addMessageCountListener. Add a listener for MessageCount events on this Folder.
public synchronized Message[]	Returns: the messages in this folder addMessages(Message[] the messages to add msgs) Append the given messages into this folder.
public void	addRights(ACL the identifer and rights to add acl) Add the rights specified in the ACL to the entry for the identifier specified in the ACL.
private void	addSuppressed(Throwable ife, Throwable thr)
public synchronized void	appendMessages(Message[] array of Messages to be appended msgs) Implements abstract javax.mail.Folder.appendMessages. Append the given messages into this folder.
public synchronized AppendUID[]	Returns: array of AppendUID objects appendUIDMessages(Message[] the messages to append msgs) Append the given messages into this folder.
protected void	checkClosed()
protected void	checkExists()
private void	checkFlags(Flags flags)
protected void	checkOpened()
protected void	checkRange(int msgno)
private void	cleanup(boolean returnToPool)
private MessagingException	cleanupAndThrow(MessagingException ife)
public synchronized void	close(boolean expunges all deleted messages if this flag is true expunge) Implements abstract javax.mail.Folder.close. Close this folder.
private void	close(boolean expunge, boolean force)
public synchronized void	copyMessages(Message[] the array of message objects msgs, Folder the folder to copy the messages to folder) Overrides javax.mail.Folder.copyMessages. Copy the specified messages from this folder, to the specified destination.
private synchronized void	copymoveMessages(Message[] msgs, Folder folder, boolean move) Copy or move the specified messages from this folder, to the specified destination.
private synchronized AppendUID[]	Returns: array of AppendUID objects copymoveUIDMessages(Message[] the messages to copy msgs, Folder the folder to copy the messages to folder, boolean move instead of copy? move) Copy or move the specified messages from this folder, to the specified destination.
public synchronized AppendUID[]	Returns: array of AppendUID objects copyUIDMessages(Message[] the messages to copy msgs, Folder the folder to copy the messages to folder) Copy the specified messages from this folder, to the specified destination.
public synchronized boolean	create(final int The type of this folder. type) Implements abstract javax.mail.Folder.create. Create this folder, with the specified type.
private String	createHeaderCommand(String[] hdrs, boolean isRev1) Create the appropriate IMAP FETCH command items to fetch the requested headers.
private Message[]	createMessagesForUIDs(long[] uids) Get or create Message objects for the UIDs.
public synchronized boolean	delete(boolean also delete subfolders? recurse) Implements abstract javax.mail.Folder.delete. Delete this folder.
public Object	Returns: the result of the command doCommand(IMAPFolder.ProtocolCommand the protocol command cmd) Execute a user-supplied IMAP command.
public Object	doCommandIgnoreFailure(IMAPFolder.ProtocolCommand cmd)
private synchronized Folder[]	doList(final String pattern, final boolean subscribed)
public Object	doOptionalCommand(String err, IMAPFolder.ProtocolCommand cmd)
protected synchronized Object	doProtocolCommand(IMAPFolder.ProtocolCommand cmd)
public synchronized boolean	exists() Implements abstract javax.mail.Folder.exists. Check whether this folder really exists on the server.
public synchronized Message[]	expunge() Implements abstract javax.mail.Folder.expunge. Expunge all messages marked as DELETED.
public synchronized Message[]	Returns: the expunged messages expunge(Message[] the messages to expunge msgs) Expunge the indicated messages, which must have been marked as DELETED.
public synchronized void	fetch(Message[] fetch items for these messages msgs, FetchProfile the FetchProfile fp) Overrides javax.mail.Folder.fetch. Prefetch attributes, based on the given FetchProfile.
private int	findName(ListInfo[] li, String lname) Which entry in `li` matches `lname`?
public synchronized void	forceClose() Close this folder without waiting for the server.
public ACL[]	Returns: array of access control list entries getACL() Get the access control list entries for this folder.
public synchronized String[]	Returns: array of attributes for this folder getAttributes() Get the attributes that the IMAP server returns with the LIST response.
pack-priv SocketChannel	getChannel() Return the SocketChannel for this connection, if any, for use in IdleManager.
public synchronized int	getDeletedMessageCount() Overrides javax.mail.Folder.getDeletedMessageCount. Get the deleted message count.
protected String	Returns: the IMAP FETCH items to request getEnvelopeCommand() Return the IMAP FETCH items to request in order to load all the "envelope" data.
public synchronized Folder	getFolder(String name of the Folder name) Implements abstract javax.mail.Folder.getFolder. Get the named subfolder.
public String	getFullName() Implements abstract javax.mail.Folder.getFullName. Get the fullname of this folder.
public synchronized long	Returns: the HIGHESTMODSEQ value getHighestModSeq() Returns the HIGHESTMODSEQ for this folder.
public synchronized Message	getMessage(int the message number msgnum) Implements abstract javax.mail.Folder.getMessage. Get the specified message.
protected IMAPMessage	Returns: the IMAPMessage object getMessageBySeqNumber(int the message sequence number seqnum) Get the message object for the given sequence number.
public synchronized Message	getMessageByUID(long UID for the desired message uid) Implements javax.mail.UIDFolder.getMessageByUID. Get the Message corresponding to the given UID.
public synchronized int	getMessageCount() Implements abstract javax.mail.Folder.getMessageCount. Get the total message count.
public synchronized Message[]	getMessages() Overrides javax.mail.Folder.getMessages. Get all Message objects from this Folder.
protected IMAPMessage[]	Returns: the IMAPMessage objects getMessagesBySeqNumbers(int[] the array of message sequence numbers seqnums) Get the message objects for the given sequence numbers.
public synchronized Message[]	getMessagesByUID(long start UID start, long end UID end) Implements javax.mail.UIDFolder.getMessagesByUID. Get the Messages specified by the given range.
public synchronized Message[]	getMessagesByUID(long[] array of UIDs uids) Implements javax.mail.UIDFolder.getMessagesByUID. Get the Messages specified by the given array.
public synchronized Message[]	Returns: the changed messages getMessagesByUIDChangedSince(long the first message number start, long the last message number end, long the MODSEQ value modseq) Get the messages that have been changed since the given MODSEQ value.
public synchronized String	getName() Implements abstract javax.mail.Folder.getName. Get the name of this folder.
public synchronized int	getNewMessageCount() Overrides javax.mail.Folder.getNewMessageCount. Get the new message count.
public synchronized Folder	getParent() Implements abstract javax.mail.Folder.getParent. Get this folder's parent.
public synchronized Flags	getPermanentFlags() Implements abstract javax.mail.Folder.getPermanentFlags. Return the permanent flags supported by the server.
protected IMAPProtocol	Returns: the IMAPProtocol object used when the folder is open getProtocol() Return the IMAPProtocol object for this folder.
public Quota[]	Returns: array of Quota objects for the quotaroots associated with this folder getQuota() Get the quotas for the quotaroot associated with this folder.
public synchronized char	getSeparator() Implements abstract javax.mail.Folder.getSeparator. Get the separator character.
public synchronized Message[]	Returns: the messages in sorted order getSortedMessages(SortTerm[] the SortTerms term) Sort the messages in the folder according to the sort criteria.
public synchronized Message[]	Returns: the messages in sorted order getSortedMessages(SortTerm[] the SortTerms term, SearchTerm the SearchTerm sterm) Sort the messages in the folder according to the sort criteria.
private Status	getStatus()
public synchronized long	Returns: the value of the STATUS item, or -1 getStatusItem(String the STATUS item to fetch item) Use the IMAP STATUS command to get the indicated item.
protected synchronized IMAPProtocol	Returns: the IMAPProtocol for the Store's connection getStoreProtocol() Get this folder's Store's protocol connection.
public synchronized int	getType() Implements abstract javax.mail.Folder.getType. Get the type of this folder.
public synchronized long	getUID(Message Message from this folder message) Implements javax.mail.UIDFolder.getUID. Get the UID for the specified message.
public synchronized long	Returns: the UIDNEXT value, or -1 if unknown getUIDNext() Implements javax.mail.UIDFolder.getUIDNext. Returns the predicted UID that will be assigned to the next message that is appended to this folder.
public synchronized boolean	Returns: true if UIDs are not sticky getUIDNotSticky() Servers that support the UIDPLUS extension (RFC 4315) may indicate that this folder does not support persistent UIDs; that is, UIDVALIDITY will be different each time the folder is opened.
public synchronized long	getUIDValidity() Implements javax.mail.UIDFolder.getUIDValidity. Returns the UIDValidity for this folder.
public synchronized int	getUnreadMessageCount() Overrides javax.mail.Folder.getUnreadMessageCount. Get the unread message count.
pack-priv boolean	Returns: true if we should look for more IDLE responses, false if IDLE is done handleIdle(boolean only do one notification? once) Read a response from the server while we're in the IDLE state.
public void	handleResponse(Response r) Implements com.sun.mail.iap.ResponseHandler.handleResponse. The response handler.
pack-priv void	handleResponses(Response[] r) Handle the given array of Responses.
public synchronized boolean	hasNewMessages() Implements abstract javax.mail.Folder.hasNewMessages. Check whether this folder has new messages.
public Map<String, String>	Returns: a Map of keys and values identifying the server id(final Map<String, String> a Map of keys and values identifying the client clientParams) Send the IMAP ID command (if supported by the server) and return the result from the server.
public void	idle() Use the IMAP IDLE command (see RFC 2177), if supported by the server, to enter idle mode so that the server can send unsolicited notifications of new messages arriving, etc. without the need for the client to constantly poll the server.
public void	idle(boolean only do one notification? once) Like `idle`, but if `once` is true, abort the IDLE command after the first notification, to allow the caller to process any notification synchronously.
pack-priv void	idleAbort()
pack-priv void	idleAbortWait()
private boolean	isDirectory()
public synchronized boolean	isOpen() Implements abstract javax.mail.Folder.isOpen. Check whether this connection is really open.
private boolean	isRecoverable(Throwable t)
public synchronized boolean	isSubscribed() Overrides javax.mail.Folder.isSubscribed. Check whether this folder is subscribed.
protected void	keepConnectionAlive(boolean keep the Store alive too? keepStoreAlive) Issue a noop command for the connection if the connection has not been used in more than a second.
public Folder[]	list(String the match pattern pattern) Implements abstract javax.mail.Folder.list. List all subfolders matching the specified pattern.
public Rights[]	Returns: array of Rights objects representing possible rights for the identifier listRights(final String the identifier to list rights for name) Get all the rights that may be allowed to the given identifier.
public Folder[]	listSubscribed(String the match pattern pattern) Overrides javax.mail.Folder.listSubscribed. List all subscribed subfolders matching the specified pattern.
private MessagingException	logoutAndThrow(String why, ProtocolException t)
public synchronized void	moveMessages(Message[] the messages to move msgs, Folder the folder to move the messages to folder) Move the specified messages from this folder, to the specified destination.
public synchronized AppendUID[]	Returns: array of AppendUID objects moveUIDMessages(Message[] the messages to move msgs, Folder the folder to move the messages to folder) Move the specified messages from this folder, to the specified destination.
public Rights	Returns: the rights granted to the current user myRights() Get the rights allowed to the currently authenticated user.
protected IMAPMessage	Returns: the new IMAPMessage object newIMAPMessage(int the message sequence number msgnum) Create a new IMAPMessage object to represent the given message number.
public synchronized void	open(int open the Folder READ_ONLY or READ_WRITE mode) Implements abstract javax.mail.Folder.open. Open this folder in the given mode.
public synchronized List<MailEvent>	Returns: a List of MailEvent instances, or null if none open(int the open mode (Folder.READ_WRITE or Folder.READ_ONLY) mode, ResyncData the ResyncData instance rd) Open this folder in the given mode, with the given resynchronization data.
private Message	processFetchResponse(FetchResponse fr) Process a FETCH response.
protected void	releaseProtocol(boolean return the protocol object to the pool? returnToPool) Release the protocol object.
protected synchronized void	releaseStoreProtocol(IMAPProtocol the IMAPProtocol object p) Release the store protocol object.
public void	removeACL(final String the identifier for which to remove all ACL entries name) Remove any access control list entry for the given identifier from the access control list for this folder.
public void	removeRights(ACL the identifer and rights to remove acl) Remove the rights specified in the ACL from the entry for the identifier specified in the ACL.
public synchronized boolean	renameTo(final Folder a folder representing the new name for this Folder f) Implements abstract javax.mail.Folder.renameTo. Rename this folder.
public synchronized Message[]	Returns: the messages that match search(SearchTerm the search term term) Overrides javax.mail.Folder.search. Search whole folder for messages matching the given term.
public synchronized Message[]	search(SearchTerm the search criterion term, Message[] the messages to be searched msgs) Overrides javax.mail.Folder.search. Search the folder for messages matching the given term.
private void	setACL(final ACL acl, final char mod)
public synchronized void	setFlags(Message[] the array of message objects msgs, Flags Flags object containing the flags to be set flag, boolean set the flags to this boolean value value) Overrides javax.mail.Folder.setFlags. Set the specified flags for the given array of messages.
public synchronized void	setFlags(int the number of the first message start, int the number of the last message end, Flags Flags object containing the flags to be set flag, boolean set the flags to this boolean value value) Overrides javax.mail.Folder.setFlags. Set the specified flags for the given range of message numbers.
public synchronized void	setFlags(int[] the array of message numbers msgnums, Flags Flags object containing the flags to be set flag, boolean set the flags to this boolean value value) Overrides javax.mail.Folder.setFlags. Set the specified flags for the given array of message numbers.
public void	setQuota(final Quota the quota to set quota) Set the quotas for the quotaroot specified in the quota argument.
public synchronized void	setSubscribed(final boolean true to subscribe, false to unsubscribe subscribe) Overrides javax.mail.Folder.setSubscribed. Subscribe/Unsubscribe this folder.
pack-priv boolean	Returns: true if IDLE started, false otherwise startIdle(final IdleManager im) Start the IDLE command and put this folder into the IDLE state.
protected synchronized void	throwClosedException(ConnectionException the ConnectionException cex) Throw the appropriate 'closed' exception.
pack-priv void	waitIfIdle()

public Class IMAPFolder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary