Overview  Package   Class  Tree  Deprecated  Index  Help 
Compoze Software, Inc.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.compoze.exchange.webdav
Class Mailbox


java.lang.Object

  |

  +--com.compoze.exchange.webdav.AbstractItem

        |

        +--com.compoze.exchange.webdav.Folder

              |

              +--com.compoze.exchange.webdav.Mailbox
All Implemented Interfaces:
java.lang.Cloneable, IItem, java.io.Serializable
public class Mailbox
extends Folder
implements java.io.Serializable

This class represents a user's mailbox folder.

The following methods are used to get a user's special mailbox folders:

See Also:
Serialized Form

Fields inherited from class com.compoze.exchange.webdav.Folder
m_folders, m_iRelDepth, m_messages
 
Method Summary
 java.lang.Object clone()
          Creates and returns a copy of this object.
 CalendarFolder getCalendarFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetCalendarFolder()
 java.lang.String getCalendarFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetCalendarFolderURI()
 ContactFolder getContactsFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetContactsFolder()
 java.lang.String getContactsFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetContactsFolderURI()
 Folder getDeletedItems()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDeletedItemsFolder()
 java.lang.String getDeletedItemsFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDeletedItemsFolderURI()
 MailFolder getDraftsFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDraftsFolder()
 java.lang.String getDraftsFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDraftsFolderURI()
 MailFolder getInbox()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetInboxFolder()
 java.lang.String getInboxFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetInboxFolderURI()
 JournalFolder getJournalFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetJournalFolder()
 java.lang.String getJournalFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetJournalFolderURI()
 java.lang.String getMailSubmissionURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetMailSubmissionURI()
 NoteFolder getNotesFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotesFolder()
 java.lang.String getNotesFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotesFolderURI()
 Folder getOutboxFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetOutboxFolder()
 java.lang.String getOutboxFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetOutboxFolderURI()
 Folder getRootFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetRootFolder()
 java.lang.String getRootMailboxFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetRootMailboxFolderURI()
 Folder getSentItems()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetSentItemsFolder()
 java.lang.String getSentItemsFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetSentItemsFolderURI()
 TaskFolder getTasksFolder()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetTasksFolder()
 java.lang.String getTasksFolderURI()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetTasksFolderURI()
 void serverCopyTo(Folder targetFolder)
          Request the server to copy the item to the specified folder.
 void serverDelete()
          Requests the server to delete the folder (the folder is removed permanently).
 CalendarFolder serverGetCalendarFolder()
          Queries the server for the user's "Calendar" folder.
 CalendarFolder serverGetCalendarFolder(java.util.List properties)
          Queries the server for the user's "Calendar" folder.
 java.lang.String serverGetCalendarFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Calendar" folder.
 ContactFolder serverGetContactsFolder()
          Queries the server for the user's "Contacts" folder.
 ContactFolder serverGetContactsFolder(java.util.List properties)
          Queries the server for the user's "Contacts" folder.
 java.lang.String serverGetContactsFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Contacts" folder.
 Folder serverGetDeletedItemsFolder()
          Queries the server for the user's "Deleted Items" folder.
 Folder serverGetDeletedItemsFolder(java.util.List properties)
          Queries the server for the user's "Deleted Items" folder.
 java.lang.String serverGetDeletedItemsFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Delete Items" folder.
 MailFolder serverGetDraftsFolder()
          Queries the server for the user's "Drafts" folder.
 MailFolder serverGetDraftsFolder(java.util.List properties)
          Queries the server for the user's "Drafts" folder.
 java.lang.String serverGetDraftsFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Drafts" folder.
 MailFolder serverGetInboxFolder()
          Queries the server for the user's "Inbox" folder.
 MailFolder serverGetInboxFolder(java.util.List properties)
          Queries the server for the user's "Inbox" folder.
 java.lang.String serverGetInboxFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Inbox" folder.
 JournalFolder serverGetJournalFolder()
          Queries the server for the user's "Journal" folder.
 JournalFolder serverGetJournalFolder(java.util.List properties)
          Queries the server for the user's "Journal" folder.
 java.lang.String serverGetJournalFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Journal" folder.
 java.lang.String serverGetMailSubmissionURI()
          Queries the server for the mail submission Uniform Resource Identifier (URI) to which outgoing mail should be submitted.
 NoteFolder serverGetNotesFolder()
          Queries the server for the user's "Notes" folder.
 NoteFolder serverGetNotesFolder(java.util.List properties)
          Queries the server for the user's "Notes" folder.
 java.lang.String serverGetNotesFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Notes" folder.
 Folder serverGetOutboxFolder()
          Queries the server for the user's "Outbox" folder.
 Folder serverGetOutboxFolder(java.util.List properties)
          Queries the server for the user's "Outbox" folder.
 java.lang.String serverGetOutboxFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Outbox" folder.
 Folder serverGetRootFolder()
          Queries the server for the user's root folder.
 java.lang.String serverGetRootMailboxFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the root mailbox folder.
 Folder serverGetSentItemsFolder()
          Queries the server for the user's "Sent Items" folder.
 Folder serverGetSentItemsFolder(java.util.List properties)
          Queries the server for the user's "Sent Items" folder.
 java.lang.String serverGetSentItemsFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Sent Items" folder.
 TaskFolder serverGetTasksFolder()
          Queries the server for the user's "Tasks" folder.
 TaskFolder serverGetTasksFolder(java.util.List properties)
          Queries the server for the user's "Tasks" folder.
 java.lang.String serverGetTasksFolderURI()
          Queries the server for the Uniform Resource Identifier (URI) for the "Tasks" folder.
 void serverMoveTo(Folder targetFolder)
          Request the server to move the item to the specified folder.
 
Methods inherited from class com.compoze.exchange.webdav.Folder
addItem, addItem, createFilename, deleteItem, deleteItem, equals, getDefaultProperties, getFolder, getFolder, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getLocalFolders, getLocalItems, getLocalMessages, getMessageCount, getProperties, getRelativeDepth, getSize, getType, getUnreadCount, getUnreadCount, getUnreadMessageCount, getVisibleCount, getVisibleCount, getVisibleCount, getVisibleCount, hasSubFolders, isDeletedItemsFolder, isDraftsFolder, isInboxFolder, isOutboxFolder, isSentItemsFolder, rename, serverAddItem, serverAddItem, serverDeleteItem, serverDeleteItem, serverGetFolders, serverGetFolders, serverGetFolders, serverGetFolders, serverGetMessageCount, serverGetMessageCount, serverGetMessages, serverGetMessages, serverGetMessages, serverGetUnreadMessageCount, serverRename, serverUpdate, setRelativeDepth, setType, toString
 
Methods inherited from class com.compoze.exchange.webdav.AbstractItem
copy, copy, copy, createFilename, delete, equals, getComment, getContentClass, getCreationDate, getDateLastModified, getDisplayName, getFile, getHRef, getID, getParentFolder, getPermanentURL, getUID, isFolder, isHidden, isReadOnly, isRoot, move, move, move, serverCopyTo, serverCopyTo, serverCopyTo, serverGetParentFolder, serverMoveTo, serverMoveTo, serverMoveTo, serverUpdate, setComment, setContentClass, setContentClass, setHidden, setReadOnly, setReleased, setType, setUID, update, update, validate
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getContactsFolder


public ContactFolder getContactsFolder()
                                throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetContactsFolder()

Gets the user's "Contacts" folder.

This method queries the server only if this nor serverGetContactsFolder(List) were previously called, requesting the following properties:

Returns:
the "Contacts" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetContactsFolder


public ContactFolder serverGetContactsFolder()
                                      throws ExchangeException
Queries the server for the user's "Contacts" folder.

This method queries the server only if this nor serverGetContactsFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Contacts" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetContactsFolder


public ContactFolder serverGetContactsFolder(java.util.List properties)
                                      throws ExchangeException
Queries the server for the user's "Contacts" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Contacts" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Contacts" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getCalendarFolder


public CalendarFolder getCalendarFolder()
                                 throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetCalendarFolder()

Gets the user's "Calendar" folder.

This method queries the server only if this nor serverGetCalendarFolder(List) were previously called, requesting the following properties:

Returns:
the "Calendar" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetCalendarFolder


public CalendarFolder serverGetCalendarFolder()
                                       throws ExchangeException
Queries the server for the user's "Calendar" folder.

This method queries the server only if this nor serverGetCalendarFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Calendar" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetCalendarFolder


public CalendarFolder serverGetCalendarFolder(java.util.List properties)
                                       throws ExchangeException
Queries the server for the user's "Calendar" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Calendar" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Calendar" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getDraftsFolder


public MailFolder getDraftsFolder()
                           throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDraftsFolder()

Gets the user's "Drafts" folder.

This method queries the server only if this nor serverGetDraftsFolder(List) were previously called, requesting the following properties:

Returns:
the "Drafts" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetDraftsFolder


public MailFolder serverGetDraftsFolder()
                                 throws ExchangeException
Queries the server for the user's "Drafts" folder.

This method queries the server only if this nor serverGetDraftsFolder(List) were previously called, requesting the following properties:

Returns:
the "Drafts" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetDraftsFolder


public MailFolder serverGetDraftsFolder(java.util.List properties)
                                 throws ExchangeException
Queries the server for the user's "Drafts" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Drafts" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Drafts" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

getDeletedItems


public Folder getDeletedItems()
                       throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDeletedItemsFolder()

Gets the user's "Deleted Items" folder.

This method queries the server only if this nor serverGetDeletedItemsFolder(List) were previously called, requesting the following properties:

Returns:
the "Deleted Items" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetDeletedItemsFolder


public Folder serverGetDeletedItemsFolder()
                                   throws ExchangeException
Queries the server for the user's "Deleted Items" folder.

This method queries the server only if this nor serverGetDeletedItemsFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Deleted Items" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetDeletedItemsFolder


public Folder serverGetDeletedItemsFolder(java.util.List properties)
                                   throws ExchangeException
Queries the server for the user's "Deleted Items" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Deleted Items" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Deleted Items" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

getInbox


public MailFolder getInbox()
                    throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetInboxFolder()

Gets the user's "Inbox" folder.

This method queries the server only if this nor serverGetInboxFolder(List) were previously called, requesting the following properties:

Returns:
the "Inbox" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetInboxFolder


public MailFolder serverGetInboxFolder()
                                throws ExchangeException
Queries the server for the user's "Inbox" folder.

This method queries the server only if this nor serverGetInboxFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Inbox" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetInboxFolder


public MailFolder serverGetInboxFolder(java.util.List properties)
                                throws ExchangeException
Queries the server for the user's "Inbox" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Inbox" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Inbox" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

getNotesFolder


public NoteFolder getNotesFolder()
                          throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotesFolder()

Gets the user's "Notes" folder.

This method queries the server only if this nor serverGetNotesFolder(List) were previously called, requesting the following properties:

Returns:
the "Notes" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetNotesFolder


public NoteFolder serverGetNotesFolder()
                                throws ExchangeException
Queries the server for the user's "Notes" folder.

This method queries the server only if this nor serverGetNotesFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Notes" folder or null if folder does not exist.
Throws:
ExchangeException - if a problem occurred while interacting with Exchange Server
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetNotesFolder


public NoteFolder serverGetNotesFolder(java.util.List properties)
                                throws ExchangeException
Queries the server for the user's "Notes" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Notes" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Notes" folder or null if folder does not exist.
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getOutboxFolder


public Folder getOutboxFolder()
                       throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetOutboxFolder()

Gets the user's "Outbox" folder.

This method queries the server only if this nor serverGetOutboxFolder(List) were previously called, requesting the following properties:

Returns:
the "Outbox" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetOutboxFolder


public Folder serverGetOutboxFolder()
                             throws ExchangeException
Queries the server for the user's "Outbox" folder.

This method queries the server only if this nor serverGetOutboxFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Outbox" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetOutboxFolder


public Folder serverGetOutboxFolder(java.util.List properties)
                             throws ExchangeException
Queries the server for the user's "Outbox" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Outbox" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Outbox" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getTasksFolder


public TaskFolder getTasksFolder()
                          throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetTasksFolder()

Gets the user's "Tasks" folder.

This method queries the server only if this nor serverGetTasksFolder(List) were previously called, requesting the following properties:

Returns:
the "Tasks" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetTasksFolder


public TaskFolder serverGetTasksFolder()
                                throws ExchangeException
Queries the server for the user's "Tasks" folder.

This method queries the server only if this nor serverGetTasksFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Tasks" folder or null if folder does not exist.
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetTasksFolder


public TaskFolder serverGetTasksFolder(java.util.List properties)
                                throws ExchangeException
Queries the server for the user's "Tasks" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Tasks" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Tasks" folder or null if folder does not exist.
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getJournalFolder


public JournalFolder getJournalFolder()
                               throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetJournalFolder()

Gets the user's "Journal" folder.

This method queries the server only if this nor serverGetJournalFolder(List) were previously called, requesting the following properties:

Returns:
the "Journal" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetJournalFolder


public JournalFolder serverGetJournalFolder()
                                     throws ExchangeException
Queries the server for the user's "Journal" folder.

This method queries the server only if this nor serverGetJournalFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Journal" folder or null if folder does not exist.
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetJournalFolder


public JournalFolder serverGetJournalFolder(java.util.List properties)
                                     throws ExchangeException
Queries the server for the user's "Journal" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Journal" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Journal" folder or null if folder does not exist.
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getSentItems


public Folder getSentItems()
                    throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetSentItemsFolder()

Gets the user's "Sent Items" folder.

This method queries the server only if this nor serverGetSentItemsFolder(List) were previously called, requesting the following properties:

Returns:
the "Sent Items" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetSentItemsFolder


public Folder serverGetSentItemsFolder()
                                throws ExchangeException
Queries the server for the user's "Sent Items" folder.

This method queries the server only if this nor serverGetSentItemsFolder(List) were previously called, requesting the following properties:

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Sent Items" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetSentItemsFolder


public Folder serverGetSentItemsFolder(java.util.List properties)
                                throws ExchangeException
Queries the server for the user's "Sent Items" folder.

Use this method to request specific properties or refresh the properties pertaining to the "Sent Items" folder

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
Returns:
the "Sent Items" folder or null if folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getRootFolder


public Folder getRootFolder()
                     throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetRootFolder()

Gets the root folder from a user's Exchange session.
Returns:
the user's root folder or null if root folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetRootFolder


public Folder serverGetRootFolder()
                           throws ExchangeException
Queries the server for the user's root folder.
Returns:
the user's root folder or null if root folder does not exist
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getMailSubmissionURI


public java.lang.String getMailSubmissionURI()
                                      throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetMailSubmissionURI()

Gets the mail submission Uniform Resource Identifier (URI) to which outgoing mail should be submitted.
Returns:
the mail submission URI
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetMailSubmissionURI


public java.lang.String serverGetMailSubmissionURI()
                                            throws ExchangeException
Queries the server for the mail submission Uniform Resource Identifier (URI) to which outgoing mail should be submitted.
Returns:
the mail submission URI
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getCalendarFolderURI


public java.lang.String getCalendarFolderURI()
                                      throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetCalendarFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Calendar" folder.
Returns:
the URI for the "Calendar" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetCalendarFolderURI


public java.lang.String serverGetCalendarFolderURI()
                                            throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Calendar" folder.
Returns:
the URI for the "Calendar" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getContactsFolderURI


public java.lang.String getContactsFolderURI()
                                      throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetContactsFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Contacts" folder.
Returns:
the URI for the "Contacts" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetContactsFolderURI


public java.lang.String serverGetContactsFolderURI()
                                            throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Contacts" folder.
Returns:
the URI for the "Contacts" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getDeletedItemsFolderURI


public java.lang.String getDeletedItemsFolderURI()
                                          throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDeletedItemsFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Deleted Items" folder.
Returns:
the URI for the "Deleted Items" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetDeletedItemsFolderURI


public java.lang.String serverGetDeletedItemsFolderURI()
                                                throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Delete Items" folder.
Returns:
the URI for the "Deleted Items" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getDraftsFolderURI


public java.lang.String getDraftsFolderURI()
                                    throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetDraftsFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Drafts" folder.
Returns:
the URI for the "Drafts" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetDraftsFolderURI


public java.lang.String serverGetDraftsFolderURI()
                                          throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Drafts" folder.
Returns:
the URI for the "Drafts" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getInboxFolderURI


public java.lang.String getInboxFolderURI()
                                   throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetInboxFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Inbox" folder.
Returns:
the URI for the "Inbox" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetInboxFolderURI


public java.lang.String serverGetInboxFolderURI()
                                         throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Inbox" folder.
Returns:
the URI for the "Inbox" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getJournalFolderURI


public java.lang.String getJournalFolderURI()
                                     throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetJournalFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Journal" folder.
Returns:
the URI for the "Journal" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetJournalFolderURI


public java.lang.String serverGetJournalFolderURI()
                                           throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Journal" folder.
Returns:
the URI for the "Journal" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getNotesFolderURI


public java.lang.String getNotesFolderURI()
                                   throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotesFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Notes" folder.
Returns:
the URI for the "Notes" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetNotesFolderURI


public java.lang.String serverGetNotesFolderURI()
                                         throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Notes" folder.
Returns:
the URI for the "Notes" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getOutboxFolderURI


public java.lang.String getOutboxFolderURI()
                                    throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetOutboxFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Outbox" folder.
Returns:
the URI for the "Outbox" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetOutboxFolderURI


public java.lang.String serverGetOutboxFolderURI()
                                          throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Outbox" folder.
Returns:
the URI for the "Outbox" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getRootMailboxFolderURI


public java.lang.String getRootMailboxFolderURI()
                                         throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetRootMailboxFolderURI()

Gets the Uniform Resource Identifier (URI) for the root mailbox folder.
Returns:
the URI for the root mailbox folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetRootMailboxFolderURI


public java.lang.String serverGetRootMailboxFolderURI()
                                               throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the root mailbox folder.
Returns:
the URI for the root mailbox folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getSentItemsFolderURI


public java.lang.String getSentItemsFolderURI()
                                       throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetSentItemsFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Sent Items" folder.
Returns:
the URI for the "Sent Items" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetSentItemsFolderURI


public java.lang.String serverGetSentItemsFolderURI()
                                             throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Sent Items" folder.
Returns:
the URI for the "Sent Items" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getTasksFolderURI


public java.lang.String getTasksFolderURI()
                                   throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetTasksFolderURI()

Gets the Uniform Resource Identifier (URI) for the "Tasks" folder.
Returns:
the URI for the "Tasks" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverGetTasksFolderURI


public java.lang.String serverGetTasksFolderURI()
                                         throws ExchangeException
Queries the server for the Uniform Resource Identifier (URI) for the "Tasks" folder.
Returns:
the URI for the "Tasks" folder
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

serverDelete


public void serverDelete()
                  throws ExchangeException
Description copied from class: Folder
Requests the server to delete the folder (the folder is removed permanently).
Overrides:
serverDelete in class Folder
Throws:
UnsupportedOperationException - if the delete operation is not supported by this mailbox.

serverMoveTo


public void serverMoveTo(Folder targetFolder)
                  throws ExchangeException
Description copied from class: AbstractItem
Request the server to move the item to the specified folder.
Overrides:
serverMoveTo in class AbstractItem
Throws:
UnsupportedOperationException - if the move operation is not supported by this mailbox.

serverCopyTo


public void serverCopyTo(Folder targetFolder)
                  throws ExchangeException
Description copied from class: AbstractItem
Request the server to copy the item to the specified folder.
Overrides:
serverCopyTo in class AbstractItem
Throws:
UnsupportedOperationException - if the copy operation is not supported by this mailbox.

clone


public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.
Overrides:
clone in class Folder
Returns:
a clone of this instance.
Throws:
java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface.
Overview  Package   Class  Tree  Deprecated  Index  Help 
Compoze Software, Inc.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright ©1999-2003 Compoze Software, Inc. All rights reserved.