Package com.compoze.exchange.webdav

The Exchange WebDAV package provides the WebDAV (Web-based Distributed Authoring and Versioning) classes.

See:
Description

Interface Summary

IDataType
IItem	This interface represents an item within Exchange Store.
IOutlookType	This interface an Outlook type, such as a folder or message type.
IScope	Deprecated. This interface has been deprecated and will be removed by version 3.1.

Class Summary

AbstractItem	This class provides a skeletal implementation of the IItem interface, to minimize the effort required to implement the IItem interface.
AbstractMessage	This class provides an extended skeletal implementation that deals specifically with messages, for example contacts, appointments, and mail messages.
AbstractOutlookType	This class provides an extended skeletal implementation that deals specifically with Outlook types, such as folder and message types.
AbstractProperty	This class defines the values representing properties under the urn:schemas:httpmail: namespace.
Address	This class represents an address.
Appointment	This class extends AbstractMessage to represent an item that is an appointment in the Exchange store.
Appointments	This class represents a list of appointments.
AppointmentStatus	This class indicates the current status of an appointment or meeting.
Attachment	This class wraps around a mail message attachment.
AttachmentDwnldServlet	This servlet is used to dowload an attachment for a message.
BusyStatus	Deprecated. This class has been deprecated and will be removed by version 3.1.
CalendarFolder	This class extends Folder to represent a folder that primarily contains appointment items.
CalendarProperty	This class defines the values representing properties under the urn:schemas:calendar: namespace.
Color	This class stores the values for a Note's color.
Contact	This class extends AbstractItem to represent an item that is a contact in the Exchange Store.
ContactFolder	This class extends Folder to represent a folder that primarily contains contact items.
Contacts	This class represents a list of contacts.
ContactsProperty	This class defines the values representing properties under the urn:schemas:contacts: namespace.
ContentClass	This class provides an extended skeletal implementation that deals specifically with Outlook types, such as folder and message types.
DateRange	This class represents a duration in time, consisting of a start and an end date.
DateRecurrence	This class describes the way that an exact instant in time recurs, and provides a method to enumerate the recurring dates.
DavProperty	This class defines the values representing properties under the DAV: namespace.
DeliveryStatusNotification	This class extends Report and identifies a message as a Delivery Status Notification (DSN).
DisplayNamePrefix	Deprecated. This class has been deprecated and will be removed by version 3.1.
DistributionList	Deprecated. This class has been deprecated as of version 3.1.19.
Document	This class extends AbstractMessage to represent an message that is a Document in the Exchange store.
EntryType	Deprecated. This class has been deprecated and will be removed by version 3.1.
ExceptionAnalyzer	This class takes an exception thrown by WebDAV when opening a session and gives more information that a user can use to diagnose what went wrong.
ExchangeProperty	This class defines the values representing properties under the http://schemas.microsoft.com/exchange/ namespace.
ExchangeStoreMailboxFolders	This class indicates the mailbox folder for a user in the Exchange Store.
FileAsId	This class indicates how the contact information is displayed.
Folder	This class extends AbstractItem to represent an item that is a folder in the Exchange Store.
Folders	This class represents a list of Folders.
FreeBusy	This class implements a wrapper for the free/busy response that is returned from Exchange.
Gender	Deprecated. This class has been deprecated and will be removed by version 3.1.
HttpMailProperty	This class defines the values representing properties under the urn:schemas:httpmail: namespace.
Importance	Deprecated. This class has been deprecated and will be removed by version 3.1.
InstanceType	This class indicates the instance type of an appointment.
Items	This class implements a collection of Exchange Store items (folders, mail messages, contacts, etc.).
JournalEntries	This class represents a list of journal entries.
JournalEntry	This class extends AbstractMessage to represent a message that is a journal entry in the Exchange store.
JournalFolder	This class extends Folder to represent a folder that primarily contains journal items.
Mailbox	This class represents a user's mailbox folder.
MailDispositionNotification	This class extends Report and identifies a message as a Mail Disposition Notification (MDN).
MailFolder	This class extends Folder to represent a folder that primarily contains mail message items.
MailHeaderProperty	This class defines the values representing properties under the urn:schemas:mailheader: namespace.
MailingAddressId	This class indicates what address (home, business, other) is used to generate the contact's mailing address.
MapiProperty	This class defines the values used to access MAPI properties in the Microsoft Exchange store.
Meeting	This class extends Message to represent a message that contains an appointment (meeting request).
MeetingStatus	This class indicates the current status of an appointment or meeting.
MemberInfo	Provides information about the members of a personal distribution list.
Message	This class extends AbstractItem to represent an item that is a message in the Exchange store.
MessageFlag	This class implements a MessageFlag.
Messages	This class represents a list of messages.
Name	This class represents a contact's full name.
Note	This class extends AbstractMessage to represent a message that is a note in the Exchange store.
NoteFolder	This class extends Folder to represent a folder that primarily contains note items.
Notes	This class represents a list of notes.
OfficeProperty	This class defines the values representing properties under the urn:schemas-microsoft-com:office:office namespace.
OutlookFolderType	This class defines the types of Outlook folders.
OutlookMessageType	This class defines the types of Outlook messages.
Priority	This class indicates the priority level.
RecurrenceType	This class stores the values for a 'recurrence type'.
Report	This class extends AbstractMessage to represent a message that is a report.
ResponseStatus	Deprecated. This class has been deprecated and will be removed by version 3.1.
ResultSet	This class represents the results returned from performing a SEARCH request against the Exchange store.
RowRange	This class is used to specify which rows are to be returned from SEARCH request to Exchange.
Sensitivity	Deprecated. This class has been deprecated and will be removed by version 3.1.
Session	This class provides a wrapper around a session to Microsoft Exchange, and is the entry point into the WebDAV API.
SortOrder	This class stores the values for a 'sort order'.
Suffix	Deprecated. This class has been deprecated and will be removed by version 3.1.
Task	This class extends AbstractMessage to represent a message that is a journal entry in the Exchange store.
TaskFolder	This class extends Folder to represent a folder that primarily contains task items.
Tasks	This class represents a list of tasks.
TaskStatus	Deprecated. This class has been deprecated and will be removed by version 3.1.
TimeSlot	This class stores information about a single time slot in a free/busy response.
TimeZoneId	This class indicates the client's time zone identifiers used to display appointment times.
UniqueID	This class is the unique id used to represent items in the Exchange store.
WebdavExerciser	This class is an exerciser for the Harmony for Exchange with WebDAV API.
WebdavFileAttachmentServlet	The servlet is used to retrieve file attachments from a webmail message.
WebdavUtility	This class provides helper methods for the WebDAV implementation.

Exception Summary

AttachmentException	This class wraps the failure to add attachment(s) to a message as excpetion.
ExchangeResponseException	This class wraps the unsuccessful responses (with status codes >= 300) from WebDAV operations as excpetions.
ItemExistsException	This class is an exception that is thrown where an item is created, moved, copied to a resource that already has an existing item with the same name.
ItemLoadException	This class is an exception that wraps any exceptions involved in the process of loading data pulled from Exchange via WebDAV in corresponding Java fields.

Package com.compoze.exchange.webdav Description

The Exchange WebDAV package provides the WebDAV (Web-based Distributed Authoring and Versioning) classes. By using these classes, the developer has access to the Exchange Store for manipulating folders, appointments and contacts.

One good way to start understanding the API is to try running the exerciser program. This will also test the connection to your Exchange server. You can do this by running java com.compoze.exchange.webdav.WebdavExerciser from the command prompt. Usage will be printed to tell you how to run the program. The source code for the exerciser (WebdavExerciser.java in $HARMONY_HOME/examples/source) also serves as an example of how to do different things.

To begin using the API in this package you must first obtain a session to the server. See Session.getSession(String, String, String) for information on how to do this.

Although it should not strictly be needed, sometimes you may wish to refer to the CDO, MAPI, Exchange Store,or Microsoft Exchange developer documentation. This is available from Microsoft at http://msdn.microsoft.com/exchange/.