API Reference
| Classic JavaDoc |
Interface ExchangeFolder
com.moyosoft.exchange.folder.ExchangeFolder
public interface ExchangeFolder
Represents an Exchange folder. Sub-folders of this folder can be accessed with
the method getFolders(). Items stored in this folder can be accessed with the
method getItems().
See Also:Methods
| addFolderListener (ExchangeFolderListener listener) | ||
Adds a listener that will be notified when this folder or subfolders are created, changed or deleted. |
| addFolderListener (ExchangeFolderListener listener, String watermark) | ||
Adds a listener that will be notified when this folder or subfolders are created, changed or deleted since the specified watermark. |
| addItemListener (ExchangeItemListener listener) | ||
Adds a listener that will be notified when items are created, changed or deleted in this folder. |
| addItemListener (ExchangeItemListener listener, String watermark) | ||
Adds a listener that will be notified when items are created, changed or deleted in this folder since the specified watermark. |
| addNewMailListener (ExchangeNewMailListener listener) | ||
Adds a listener that will be notified when a new mail is received in this mail folder. |
| addNewMailListener (ExchangeNewMailListener listener, String watermark) | ||
Adds a listener that will be notified when a new mail is received in this mail folder. |
| copyTo (ExchangeFolder folder) | ||
Creates a copy of this folder in the specified folder. The copied folder is returned. |
| createCalendarItem () | ||
Creates a new calendar item in this folder. This method is equivalent to: (ExchangeCalendarItem) createItem(ItemType.CalendarItem); |
| createContact () | ||
Creates a new contact in this folder. This method is equivalent to: (ExchangeContact) createItem(ItemType.Contact); |
| createFolder (FolderContentType folderType, String displayName) | ||
Creates a new sub-folder of this folder with the specified type and display name. The created folder is returned. |
| createItem (ItemType itemType) | ||
Creates a new item in this folder. The specified type defines what kind of item will be created. |
| createItem (String itemClass) | ||
Creates a new item in this folder with the specified item class. The following classes are used for standard items: "IPM.Appointment" for appointments. "IPM.Contact" for contacts. "IPM.Activity" for Journal entries. "IPM.Note" for e-mail messages. "IPM.StickyNote" for Outlook ... more > |
| createItemFrom (java.io.File file) | ||
Creates a new message in this folder from the content of the specified file. The file's content should be in RFC-822 format (EML format). |
| createMail () | ||
Creates a new email in this folder. This method is equivalent to: (ExchangeMail) createItem(ItemType.Mail); |
| createTask () | ||
Creates a new calendar item in this folder. This method is equivalent to: (ExchangeTask) createItem(ItemType.Task); |
void | delete (boolean moveToDeletedItems) | |
Deletes this folder. |
| getContentType () | ||
Returns the type of items this folder contains. |
String | getDisplayName () | |
Returns the name if the folder used for display. |
String | getFolderClass () | |
Returns a string that describes the folder class. Folder classes typically start with "IPF.". The following folder classes are usually returned: "IPF.Appointment" for calendar folders containing appointments. "IPF.Contact" for folders containing contacts. "IPF.Journal" for folders ... more > |
String | getFolderId () | |
Returns the folder's identifier (ID) that identifies a folder in the Exchange store. |
String | getFolderIdChangeKey () | |
Returns the folder's change key. The change key changes each time the folder is altered and identifies a version of this folder. |
| getFolders () | ||
Returns a collection of the sub-folders of this folder. This method never returns null, even if the folder doesn't have any sub-folders: an empty collection is returned in this case. |
int | getFoldersCount () | |
Returns the count of sub-folders of this folder. If a folder doesn't have any sub-folders this method returns zero (0). |
| getItems () | ||
Returns a collection of the items stored in this folder. This method never returns null, even if the folder is empty and doesn't contain any items: an empty collection is returned in this case. |
int | getItemsCount () | |
Returns the count of items stored in this folder. |
| getParentFolder () | ||
Returns the parent folder of this folder or null for the root folder. |
int | getUnreadItemsCount () | |
Returns the count of unread items stored in this folder. |
boolean | isUnreadItemsCountSupported () | |
Indicates whether this folder can contain unread items. If false is returned by this method, the method getUnreadItemsCount() always returns zero (0). |
void | moveTo (ExchangeFolder folder) | |
Moves this folder to the specified folder. |
void | removeFolderListener (ExchangeFolderListener listener) | |
Removes a listener. |
void | removeItemListener (ExchangeItemListener listener) | |
Removes a listener. |
void | removeNewMailListener (ExchangeNewMailListener listener) | |
Removes a listener. |
void | save () | |
Saves all the changes made to this folder in the Exchange store. |
void | setDisplayName (String displayName) | |
Modifies the display name of this folder. Changes are not made until the method save() is called. |
Community comments
Powered by JavaDocPlus