== Introduction ==
This document defines
OXMAPI32 API. It provides access to a Open-Xchange 6 Server by using
the Open-Xchange HTTP API. The OXMAPI32 API can be used for Windows
applications. The OXMAPI32 API architecture bases on the Microsoft
MAPI so the convention of constants and objects are similar. 
This document describes the functionality of each object in the respective module, which are ordinated corresponding the object model. Each module provides code
examples how to use the respective object written in Delphi.

== OXMAPI Object Model ==

<IMG SRC="oxmapi32_html_m7b3028d.png" NAME="Grafik1" ALIGN=LEFT WIDTH=642 HEIGHT=238 BORDER=0>

== Constants ==
This topic provides a list of all constant in the object model. OlDefaultFolders relate to
the default folder subordinated to the private folder of the current user.

{| WIDTH=287 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=134><COL WIDTH=135> VALIGN=TOP
| WIDTH=134 | Name
| WIDTH=135 | Value
|- VALIGN=TOP
| WIDTH=134 | OlAppointmentItem

| WIDTH=135 | 1
|- VALIGN=TOP
| WIDTH=134 | olContactItem
| WIDTH=135 | 2
|- VALIGN=TOP
| WIDTH=134 | OlDistributionListItem
| WIDTH=135 | 7
|- VALIGN=TOP
| WIDTH=134 | olTaskItem

| WIDTH=135 | 3
|}Table 1.
OlItemType
 
{| WIDTH=287 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=134><COL WIDTH=135> VALIGN=TOP
| WIDTH=134 | Name
| WIDTH=135 | Value
|- VALIGN=TOP
| WIDTH=134 | olFolderCalendar
| WIDTH=135 | 9
|- VALIGN=TOP
| WIDTH=134 | olFolderContacts
| WIDTH=135 | 10
|- VALIGN=TOP
| WIDTH=134 | olFolderlTasks
| WIDTH=135 | 13
|}Table 2.
OlDefaultFolders
 
 
{| WIDTH=287 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=134><COL WIDTH=135> VALIGN=TOP
| WIDTH=134 | Name
| WIDTH=135 | ID
|- VALIGN=TOP
| WIDTH=134 | private
| WIDTH=135 | 1
|- VALIGN=TOP
| WIDTH=134 | public
| WIDTH=135 | 2
|- VALIGN=TOP
| WIDTH=134 | shared
| WIDTH=135 | 3
|}Table 3.
top level folder IDs

== App Object ==
Represents the root for any data source object. The App Object has several purposes:
<UL><LI>As the root
object, it allows access to other objects in the oxmapi hierarchy.<LI>It allows access
to a new item created by using CreateItem.<LI> It provides
methods accessing certain special default folders directly.<LI>It provides the
Entry Point for establishing the connection</UL>

 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | Application
| WIDTH=25% | IApp
| WIDTH=60% | Readonly:
Reference to the App Object itself.
|- VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Variant
| WIDTH=60% | Readonly:
Name of the Application.
|- VALIGN=TOP
| WIDTH=16% | Session
| WIDTH=25% | ISession
| WIDTH=60% | Readonly:
Reference to the current Session Object.
|- VALIGN=TOP
| WIDTH=16% | Version
| WIDTH=25% | Variant
| WIDTH=60% | Readonly:
Number of the current Version
|}Table 4.
App Properties 

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=43*><COL WIDTH=32*><COL WIDTH=57*><COL WIDTH=124*> VALIGN=TOP
| WIDTH=17% | Name
| WIDTH=12% | Result
| WIDTH=22% | Parameters
| WIDTH=48% | Description
|- VALIGN=TOP
| WIDTH=17% | CreateItem
| WIDTH=12% | IItem
| WIDTH=22% | Item:
OlDefaultItems
| WIDTH=48% | Creates
a new item and returns it. The CreateItem method can only create
items listet in Table 1
|- VALIGN=TOP
| WIDTH=17% | CreateRecipient
| WIDTH=12% | IRecipient
| WIDTH=22% | Value:
Variant
| WIDTH=48% | Creates
and returns a Recipient object. 
|- VALIGN=TOP
| WIDTH=17% | GetDefaultFolder
| WIDTH=12% | IMAPIFolder
| WIDTH=22% | Name:
OlDefaultFolders
| WIDTH=48% | Returns
a MAPIFolder object that represents the default folder of the
requested type for the current profile. Default folders are
described in Table 2
|- VALIGN=TOP
| WIDTH=17% | GetFolderFromID
| WIDTH=12% | IMAPIFolder
| WIDTH=22% | ID:
Variant
| WIDTH=48% | Returns
a MAPIFolder object identified by the specified entry ID (if
valid).
|- VALIGN=TOP
| WIDTH=17% | Quit
| WIDTH=12% | 
| WIDTH=22% | 
| WIDTH=48% | The
associated session is closed completely; the user is logged out of
the messaging system and any changes to items not already saved
are discarded. 
|}Table 5.
App Methods 

== Using the App Object ==

Use the CoClass.Create method to instantiate a new Application.

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;beginApplication
:= CoApp.Create;
|}
Examples showing how to use the functions of the App Object are described in
the corresponding module. An example for a folder request is presented in the module of the MAPIFolder object. An example how to create items is presented in the module of the Item Interface .

== Session Object ==

Represents a connection to the OX-Server. The object itself provides methods for logging in and out. The Logon Method requires a valid IP-Address to the server.

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | Parent
| WIDTH=25% | IApp
| WIDTH=60% | Readonly:
Reference to the current App Object.
|- VALIGN=TOP
| WIDTH=16% | Session
| WIDTH=25% | ISession
| WIDTH=60% | Readonly:
Reference to the Session Object itself.
|- VALIGN=TOP
| WIDTH=16% | Connected
| WIDTH=25% | WordBool
| WIDTH=60% | Readonly:
Flag which indicates whether Session is connected to the server
or not.
|}Table 6.
Session Properties 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=30*><COL WIDTH=27*><COL WIDTH=68*><COL WIDTH=132*> VALIGN=TOP
| WIDTH=12% | Name
| WIDTH=11% | Result
| WIDTH=26% | Parameters
| WIDTH=51% | Description
|- VALIGN=TOP
| WIDTH=12% | SetIP
| WIDTH=11% | HRESULT
| WIDTH=26% | Value:
Variant
| WIDTH=51% | 
|- VALIGN=TOP
| WIDTH=12% | Logon
| WIDTH=11% | HRESULT
| WIDTH=26% | Username,
Password: Variant
| WIDTH=51% | Logs
the user on to MAPI, obtaining a MAPI session.
|- VALIGN=TOP
| WIDTH=12% | Logoff
| WIDTH=11% | HRESULT
| WIDTH=26% | 
| WIDTH=51% | Logs
the user off from the current MAPI session. 
|}Table 7.
Session Methods

== Using the Session Object ==
To establish a connection to the server, use the following example:

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example: Connection
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;beginApplication.Session.SetIP('192.168.0.1');Application.Session.Logon;
|} <H2 CLASS="western" STYLE="font-style: normal"></H2>

== MAPIFolder Object ==
Represents a folder. A MAPIFolder object can contain other MAPIFolder objects, as well as items. Therefore the MAPIFolder Object contains the Folders Object and the Items Object to obtain subordinated elements.
You can navigate nested folders by using a combination of Folders.item(index), which returns
the subfolder with the position of the index.

The MAPIFolder Object is typed; for example, the Calendar folder will only contain AppointmentItem objects and the Contacts folder will only contain ContactItem and DistListItem objects.

 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | Application
| WIDTH=25% | IApp
| WIDTH=60% | Readonly:
Reference to the current App Object.
|- VALIGN=TOP
| WIDTH=16% | EntryID
| WIDTH=25% | Variant
| WIDTH=60% | Readonly:
Folder ID of corresponding folder on the server.
|- VALIGN=TOP
| WIDTH=16% | Parent
| WIDTH=25% | IMAPIFolder
| WIDTH=60% | Readonly:
Reference to the Parentfolder. If the current folder is a root
folder (private folder, public folder, shared folder or infostore)
this property returns null.
|- VALIGN=TOP
| WIDTH=16% | Session
| WIDTH=25% | ISession
| WIDTH=60% | Readonly:
Reference to the current Session Object.
|- VALIGN=TOP
| WIDTH=16% | Folders
| WIDTH=25% | IFolders
| WIDTH=60% | Readonly:
Folders Object representing all subfolders contained in this
folder.
|- VALIGN=TOP
| WIDTH=16% | Items
| WIDTH=25% | IItems
| WIDTH=60% | Readonly:
Items Object representing all items contained in this folder.
|- VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:
Name of the folder.
|- VALIGN=TOP
| WIDTH=16% | Category
| WIDTH=25% | Variant
| WIDTH=60% | Readonly:
Category of the folder.
|}Table 8.
MAPIFolder Properties 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=43*><COL WIDTH=32*><COL WIDTH=91*><COL WIDTH=89*> VALIGN=TOP
| WIDTH=17% | Name
| WIDTH=12% | Result
| WIDTH=36% | Parameters
| WIDTH=35% | Description
|- VALIGN=TOP
| WIDTH=17% | Delete
| WIDTH=12% | HRESULT
| WIDTH=36% | 
| WIDTH=35% | Deletes
the folder
|- VALIGN=TOP
| WIDTH=17% | MoveTo
| WIDTH=12% | HRESULT
| WIDTH=36% | DestinationFolder:
MAPIFolder
| WIDTH=35% | Moves
the folder to the specified destination folder
|}Table 9.
MAPIFolder Methods

== Using the MAPIFolder Object ==
This example uses the GetDefaultFolder method to obtain the default Calendar folder for a user who is currently logged in. Use OlDefaultFolders described in Table 2 to obtain the default folder.

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0 <COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
GetDefaultFolder
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;Folder:
MAPIFolder;beginFolder
:= App.GetDefaultFolder(olFolderCalendar);end;
|} The
default folders constants provides access to the private default
folders. To obtain a top level folder, use the GetFolderFromID
method. The following example shows how to obtain the private folder.
{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
GetFolderFromID
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;Folder:
MAPIFolder;beginFolder
:= App.GetFolderFromID('1');end;
|}

To add a new folder, use the add method of the Folders property. An example how to add a folder is presented in the Folders Object module. To add a new item, use the add method of the Items property. An example
how to add a item is presented in the Items Object module.

== Folders Object ==
Represents all folders in a MAPIFolder object. The Folders Object provides a collection of methods to obtain subordinated folders. 

{| WIDTH=643 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=92><COL WIDTH=151><COL WIDTH=374> VALIGN=TOP
| WIDTH=92 | Name
| WIDTH=151 | Type
| WIDTH=374 | Description
|- VALIGN=TOP
| WIDTH=92 | Application
| WIDTH=151 | IApp
| WIDTH=374 | Readonly:
Reference to the current App Object.
|- VALIGN=TOP
| WIDTH=92 | Parent
| WIDTH=151 | IMAPIFolder
| WIDTH=374 | Readonly:
Reference to the MAPIFolder Object. 
|- VALIGN=TOP
| WIDTH=92 | Session
| WIDTH=151 | ISession
| WIDTH=374 | Readonly:
Reference to the current Session Object.
|- VALIGN=TOP
| WIDTH=92 | Count
| WIDTH=151 | Long
| WIDTH=374 | Readonly:Number
of subfolders contained in the Parent MAPIFolder
|}Table 10.
Folders Properties 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=43*><COL WIDTH=32*><COL WIDTH=93*><COL WIDTH=87*> VALIGN=TOP
| WIDTH=17% | Name
| WIDTH=12% | Result
| WIDTH=36% | Parameters
| WIDTH=34% | Description
|- VALIGN=TOP
| WIDTH=17% | Add
| WIDTH=12% | MAPIFolder
| WIDTH=36% | Name:
Variant, Type_: OlDefaultFolders
| WIDTH=34% | Creates
a new folder in the Parent MAPIFolder.
|- VALIGN=TOP
| WIDTH=17% | Find
| WIDTH=12% | MAPIFolder
| WIDTH=36% | Filter:
Variant
| WIDTH=34% | Locate
and returns a direct subfolder
|- VALIGN=TOP
| WIDTH=17% | GetFirst
| WIDTH=12% | MAPIFolder
| WIDTH=36% | 
| WIDTH=34% | Returns
the first subfolder
|- VALIGN=TOP
| WIDTH=17% | GetLast
| WIDTH=12% | MAPIFolder
| WIDTH=36% | 
| WIDTH=34% | Returns
the last subfolder
|- VALIGN=TOP
| WIDTH=17% | GetNext
| WIDTH=12% | MAPIFolder
| WIDTH=36% | 
| WIDTH=34% | Returns
the next subfolder. It returns null if no next subfolder exists,
if already positioned at the last folder.
|- VALIGN=TOP
| WIDTH=17% | GetPrevious
| WIDTH=12% | MAPIFolder
| WIDTH=36% | 
| WIDTH=34% | Returns
the previous subfolder. It returns null if no previous subfolder
exists, if already positioned at the first folder.
|- VALIGN=TOP
| WIDTH=17% | Item
| WIDTH=12% | MAPIFolder
| WIDTH=36% | Index:
long
| WIDTH=34% | Returns
a subfolder positioned at the index number.
|- VALIGN=TOP
| WIDTH=17% | Remove
| WIDTH=12% | HRESULT
| WIDTH=36% | Index:
long
| WIDTH=34% | Deletes
a subfolder positioned at the index number
|}Table 11.
Folders Methods 

== Using the Folders Object ==
This example uses the item method to visit subordinated folders and returns the folder “old contacts”.

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
visit subfolders
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | Vari:
integer;Application:
App;Contactfolder,
Folder: MAPIFolder;beginContactfolder
:= App.GetDefaultFolder(olFolderCalendar);for
i := 0 to Contactfolder.Count-1 beginFolder
:= Contactfolder.folders.item(i);if
(Folder.Name = 'old contacts') thenbeginResult
:= Folder;endelsebeginResult
:= nil;end;end;end;
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | 
|} 
To add a new folder, use the add method. The Add method has an optional argument that can be used to specify the type of items that can be stored in that folder. By default, folders created inside another folder inherit the type of the parent folder.
{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
add a new folder
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;newfolder,
Contactfolder: MAPIFolder;beginContactfolder
:= App.GetDefaultFolder(olFolderCalendar);newfolder
:= Contactfolder.Folders.add('new
contactfolder',olFolderContacts);end;
|} 

== Items Object ==
Represents all Items in a MAPIFolder object. The Items Object provides a collection of methods to obtain subordinated folders.

{| WIDTH=643 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=92><COL WIDTH=151><COL WIDTH=374> VALIGN=TOP
| WIDTH=92 | Name
| WIDTH=151 | Type
| WIDTH=374 | Description
|- VALIGN=TOP
| WIDTH=92 | Application
| WIDTH=151 | IApp
| WIDTH=374 | Readonly:
Reference to the current App Object.
|- VALIGN=TOP
| WIDTH=92 | Parent
| WIDTH=151 | IMAPIFolder
| WIDTH=374 | Readonly:
Reference to the MAPIFolder Object. 
|- VALIGN=TOP
| WIDTH=92 | Session
| WIDTH=151 | ISession
| WIDTH=374 | Readonly:
Reference to the current Session Object.
|- VALIGN=TOP
| WIDTH=92 | Count
| WIDTH=151 | Long
| WIDTH=374 | Readonly:Number
of Items contained in the Parent MAPIFolder
|}Table 12. Items Properties 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=43*><COL WIDTH=32*><COL WIDTH=93*><COL WIDTH=87*> VALIGN=TOP
| WIDTH=17% | Name
| WIDTH=12% | Result
| WIDTH=36% | Parameters
| WIDTH=34% | Description
|- VALIGN=TOP
| WIDTH=17% | Add
| WIDTH=12% | IItem
| WIDTH=36% | Name:
Variant, Type_: OlDefaultItems
| WIDTH=34% | Creates
a temporary Item in the Parent MAPIFolder. To create a persistent
item, invoke the save method of the item.
|- VALIGN=TOP
| WIDTH=17% | Find
| WIDTH=12% | IItem
| WIDTH=36% | Filter:
Variant
| WIDTH=34% | Locate
and returns a Item matching the Filter.
|- VALIGN=TOP
| WIDTH=17% | GetFirst
| WIDTH=12% | IItem
| WIDTH=36% | 
| WIDTH=34% | Returns
the first Item.
|- VALIGN=TOP
| WIDTH=17% | GetLast
| WIDTH=12% | IItem
| WIDTH=36% | 
| WIDTH=34% | Returns
the last Item.
|- VALIGN=TOP
| WIDTH=17% | GetNext
| WIDTH=12% | IItem
| WIDTH=36% | 
| WIDTH=34% | Returns
the next Item. It returns null if no next Item exists, if already
positioned at the last Item.
|- VALIGN=TOP
| WIDTH=17% | GetPrevious
| WIDTH=12% | IItem
| WIDTH=36% | 
| WIDTH=34% | Returns
the previous Item. It returns null if no previous Item exists, if
already positioned at the first Item.
|- VALIGN=TOP
| WIDTH=17% | Item
| WIDTH=12% | IItem
| WIDTH=36% | Index:
long
| WIDTH=34% | Returns
a Item positioned at the index number.
|- VALIGN=TOP
| WIDTH=17% | Remove
| WIDTH=12% | HRESULT
| WIDTH=36% | Index:
long
| WIDTH=34% | Deletes
a Item positioned at the index number.
|}Table 13.
Items Methods 

== Using the Items Object ==
This example uses the item method to obtain items contained in the parent folder.

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
obtaining folder items
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | Vari:
integer;Application:
App;Contactfolder:
MAPIFolder;Currentitem:
Item;beginContactfolder
:= App.GetDefaultFolder(olFolderCalendar);for
i := 0 to Contactfolder.Count-1 beginCurrentitem
:= Contactfolder.items.item(i);if
(Currentitem.Subject = 'John Smith') thenbeginResult
:= Current;endelsebeginResult
:= nil;end;end;end;
|}To
add a new item, use the add method. The Add method has an optional
argument that can be used to specify the type of the item. By
default, items created inside the parent folder inherit the type by
means of the parent folder. In the case a contact folder adds a new
item, the result is an Item interface referring to a ContactItem
Object.The
Add method creates a temporary and specific item. To make it
persistent, it needs to be saved by invoking the Save method.
{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
add a new item
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App; Contactfolder:
MAPIFolder;Newitem:
Item;beginContactfolder
:= Application.GetDefaultFolder(olFolderContacts);Newitem
:= Contactfolder.Items.add(olContactItem);Newitem.Subject
:= 'John Smith';Newitem.Save;end;
|} 

== Item Interface ==
The Item interface is a common Interface to handle basic functions of a specific item object and to abstract the specific items.

The Item interface is
the root for all specific item interfaces; for example, a ContactItem
interface inherits the properties and methods of the Item interface.To
identify an item, use the Message Class property. Message Class
Values are described in Table 14. <DL><DL><DL><DL><DL><DL><DL><DD>
{| WIDTH=119 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=109>
| WIDTH=109 VALIGN=TOP | MessageClass
|-
| WIDTH=109 VALIGN=TOP | IPM.Appointment
|-
| WIDTH=109 VALIGN=TOP | IPM.Contact
|-
| WIDTH=109 VALIGN=TOP | IPM.DistList
|-
| WIDTH=109 VALIGN=TOP | IPM.Task

|}</DL></DL></DL></DL></DL></DL></DL>Table 14.
MessageClasses 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | Application
| WIDTH=25% | IApp
| WIDTH=60% | Readonly:
Reference to the current App Object.
|- VALIGN=TOP
| WIDTH=16% | EntryID
| WIDTH=25% | Variant
| WIDTH=60% | Readonly:
ID of corresponding item on the server.
|- VALIGN=TOP
| WIDTH=16% | Parent
| WIDTH=25% | IMAPIFolder
| WIDTH=60% | Readonly:
Reference to the Parentfolder. If the current folder is a root
folder (private folder, public folder, shared folder or infostore)
this property returns null.
|- VALIGN=TOP
| WIDTH=16% | Session
| WIDTH=25% | ISession
| WIDTH=60% | Readonly:
Reference to the current Session Object.
|- VALIGN=TOP
| WIDTH=16% | CreationTime
| WIDTH=25% | Date
| WIDTH=60% | 
|- VALIGN=TOP
| WIDTH=16% | Body
| WIDTH=25% | Variant
| WIDTH=60% | Readonly:
Items Object representing all items contained in this folder.
|- VALIGN=TOP
| WIDTH=16% | Subject
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:
Name of the folder.
|- VALIGN=TOP
| WIDTH=16% | Saved
| WIDTH=25% | Wordbool
| WIDTH=60% | Readonly:
indicates whether the save method has been successfull.or not
|- VALIGN=TOP
| WIDTH=16% | MessasgeClass
| WIDTH=25% | Variant
| WIDTH=60% | 
|}Table 15.
Item Properties 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=43*><COL WIDTH=32*><COL WIDTH=91*><COL WIDTH=89*> VALIGN=TOP
| WIDTH=17% | Name
| WIDTH=12% | Result
| WIDTH=36% | Parameters
| WIDTH=35% | Description
|- VALIGN=TOP
| WIDTH=17% | Delete
| WIDTH=12% | HRESULT
| WIDTH=36% | 
| WIDTH=35% | Deletes
the item
|- VALIGN=TOP
| WIDTH=17% | Move
| WIDTH=12% | HRESULT
| WIDTH=36% | DestinationFolder:
MAPIFolder
| WIDTH=35% | Moves
the item to the specified destination folder
|- VALIGN=TOP
| WIDTH=17% | Save
| WIDTH=12% | HRESULT
| WIDTH=36% | 
| WIDTH=35% | Stores
a new item on the server or updates the existing one. If required
properties are not set, the Save method will fail.
|}Table 16.
Item Methods

== Using the Item Interface ==
The following example shows how to create a new Appointment in the default calendar folder. To use the new item as Appointment, the Item interface has to be casted to an AppointmentItem.
Remark:
Like the Add method in the Items Object, CreateItem also creates a
temporary item. To make it persistent, the Save method has to be
invoked.

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
CreateItem
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;Newitem:
Item;NewAppointment:
AppointmentItem;beginNewitem
:= Application.CreateIem(olAppointmentItem);NewAppointment
:= Newitem as AppointmentItem;end;
|}<H2 CLASS="western" STYLE="font-style: normal"></H2>

== AppointmentItem Object ==
Represents an appointment in the Calendar folder. An AppointmentItem posses properties described in Table 15 and Table 17, methods described in Table 16. Valid Values in Subject, StartDate and EndDate properties
are required for saving.

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | EndDate
| WIDTH=25% | Date
| WIDTH=60% | Read/Write:

|- VALIGN=TOP
| WIDTH=16% | StartDate
| WIDTH=25% | Date
| WIDTH=60% | Read/Write:

|- VALIGN=TOP
| WIDTH=16% | Location
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:

|}Table 17.
AppointmentItem Properties

=== Using the AppointmentItem Object ===
The following example shows how to create a new Appointment.
{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
Create a new Appointment
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;NewAppointment:
AppointmentItem;beginNewAppointment
:= Application.CreateIem(olAppointmentItem) as AppointmentItem;NewAppointment.Subject
:= 'Meeting';NewAppointment.StartDate
:= StrToDateTime('01.01.2007 15:00);NewAppointment.EndDate
:= StrToDateTime('01.01.2007 15:00);NewAppointment.Save;end;
|} 

== ContactItem Object ==
Represents a contact in a contacts folder. A contact can represent any person with whom you have any personal or professional contact. A ContactItem posses properties described in Table 15 and Table 18, methods described in Table 16. A valid Value in LastName property is required for saving.

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=67*><COL WIDTH=32*><COL WIDTH=157*> VALIGN=TOP
| WIDTH=26% | Name
| WIDTH=12% | Type
| WIDTH=61% | Description
|- VALIGN=TOP
| WIDTH=26% | EmailAddress1
| WIDTH=12% | Variant
| WIDTH=61% | Read/Write:.first
email
|- VALIGN=TOP
| WIDTH=26% | BusinessTelephoneNumber
| WIDTH=12% | Variant
| WIDTH=61% | Read/Write:
Telephonenumber
|- VALIGN=TOP
| WIDTH=26% | FirstName
| WIDTH=12% | Variant
| WIDTH=61% | Read/Write:
First name
|- VALIGN=TOP
| WIDTH=26% | LastName
| WIDTH=12% | Variant
| WIDTH=61% | Read/Write:.Last
name
|- VALIGN=TOP
| WIDTH=26% | Company
| WIDTH=12% | Variant
| WIDTH=61% | Read/Writ:
Company
|- VALIGN=TOP
| WIDTH=26% | HomeAddressCity
| WIDTH=12% | Variant
| WIDTH=61% | Read/Write:
City of Home Address
|}Table 18. ContactItem Properties

=== Using the ContactItem Object ===
The following example shows how to create a new Contact.
{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
Create a new Contact
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;Newcontact:
ContactItem;beginNewcontact
:= Application.CreateIem(olContactItem) as ContactItem;Newcontact.FirstName
:= 'John';Newcontact.LastName
:= 'Smith';Newcontact.EmailAddress1
:= 'john.smith@acme.com'Newcontact.Save;end;
|} <H2 CLASS="western" STYLE="font-style: normal"></H2>

== DistListItem Object ==
Represents a distribution list in a contacts folder. A distribution list can contain multiple recipients and is used to send messages to everyone in the list.
A DistListItem posses properties described in Table 15 and Table 19, methods described in Table 16
and Table 20. A valid Value in the Subject property is required.

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | MembersCount
| WIDTH=25% | long
| WIDTH=60% | ReadOnly:.Number
of Members in the Distributionlist
|- VALIGN=TOP
| WIDTH=16% | Members
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:Array
of string containing each member of the Distributionlist. The
string format is ***Name***/n/r***Mailaddress***
|}Table 19. DistListItem Properties 
{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=43*><COL WIDTH=32*><COL WIDTH=91*><COL WIDTH=89*> VALIGN=TOP
| WIDTH=17% | Name
| WIDTH=12% | Result
| WIDTH=36% | Parameters
| WIDTH=35% | Description
|- VALIGN=TOP
| WIDTH=17% | AddMember
| WIDTH=12% | HRESULT
| WIDTH=36% | Recipient:
IRecipient
| WIDTH=35% | Adds a
new Member to the Disptributionlist.
|- VALIGN=TOP
| WIDTH=17% | GetMember
| WIDTH=12% | IRecipient
| WIDTH=36% | Index:
long
| WIDTH=35% | Returns
a Recipient positioned at the index.
|- VALIGN=TOP
| WIDTH=17% | RemoveMember
| WIDTH=12% | HRESULT
| WIDTH=36% | Index:
long
| WIDTH=35% | Deletes
Member from the Distributionlist
|}Table 20.
DistListItem Methods

=== Using theDistListItem Object ===
The following example shows how to create a new Distributionlist. Use the CreateRecipient method to create a Recipient and add it to the Distributiolist.

{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
Create a new Distributionlist
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;Newdistlist:
DistlistItem;Newrecipient:
Recipient;beginNewdistlist
:= Application.CreateItem(olContactItem) as DistListItem;Newrecipient
:= Application.CreateRecipient('John Smith');Newdistlist.Subject
:= 'Businesspartners';Newrecipient.Address
:= <A HREF="mailto:'john.smith@acme.com">'john.smith@acme.com</A>';Newdistlist.AddMember(Newrecipient);Newdistlist.Save;end;
|} <H2 CLASS="western" STYLE="font-style: normal"></H2>

== TaskItem Object ==
Represents a task (an assigned, delegated, or self-imposed task to be performed within a specified time frame) in a Tasks folder. A TaskItem posses properties described in Table 15 and Table 21, methods described in
Table 16.

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | EndDate
| WIDTH=25% | Date
| WIDTH=60% | Read/Write:
End date
|- VALIGN=TOP
| WIDTH=16% | StartDate
| WIDTH=25% | Date
| WIDTH=60% | Read/Write:
Start date
|- VALIGN=TOP
| WIDTH=16% | Importance
| WIDTH=25% | long
| WIDTH=60% | Read/Write:
Priority of the Item. 0 = low, 1 = middle, 2 = high
|}Table 21. TaskItem PropertiesUsing the TaskItem Object
The following example shows how to create a new Task.
{| WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0<COL WIDTH=256*>
| WIDTH=100% VALIGN=TOP | Delphi code
example:
Create a new Task
|-
| WIDTH=100% VALIGN=TOP BGCOLOR="#e6e6e6" | varApplication:
App;Newtask:
TaskItem;beginNewcontact
:= Application.CreateIem(olContactItem) as ContactItem;Newcontact.FirstName
:= 'John';Newcontact.LastName
:= 'Smith';Newcontact.EmailAddress1
:= 'John.Smith@acme.com'Newcontact.Save;end;
|} 

== Recipient Object ==
Represents a user or resource, generally a mail message addressee.

{| WIDTH=100% BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0 align="center" <COL WIDTH=40*><COL WIDTH=63*><COL WIDTH=152*> VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Type
| WIDTH=60% | Description
|- VALIGN=TOP
| WIDTH=16% | EntryID
| WIDTH=25% | Variant
| WIDTH=60% | ReadOnly:

|- VALIGN=TOP
| WIDTH=16% | Address
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:

|- VALIGN=TOP
| WIDTH=16% | Name
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:

|- VALIGN=TOP
| WIDTH=16% | Session
| WIDTH=25% | ISession
| WIDTH=60% | Readonly:
Reference to the current Session Object.
|- VALIGN=TOP
| WIDTH=16% | MailField
| WIDTH=25% | Variant
| WIDTH=60% | Read/Write:
|- VALIGN=TOP
| WIDTH=16% | FirstName
| WIDTH=25% | Variant
| WIDTH=60% | ReadOnly:
|- VALIGN=TOP
| WIDTH=16% | LastName
| WIDTH=25% | Variant
| WIDTH=60% | ReadOnly:
|}Table 22. Recipient Properties

=== Using the Recipient Object ===
An example how to use the the Recipient Object is described in the DistListItem Object module.

Oxmapi

2007-02-23T03:36:46Z

Ledil: New page: == Introduction == This document defines OXMAPI32 API. It provides access to a Open-Xchange 6 Server by using the Open-Xchange HTTP API. The OXMAPI32 API can be used for Windows applicati...

User:Ledil

2007-02-23T01:51:36Z

Ledil:

== Who ==

* '''Real name''' - Leonardo Di Lella 
* '''Current Nicknames''' - ledil 
* '''Hometown''' - Olpe, NRW (Germany) 
* '''Current Residence''' - Olpe, NRW (Germany) 

== What ==

* '''Position''' - Team Leader Development (Windows Development) 

=== OXtender for MS Outlook ===

The Open-Xchange OXtender for Microsoft Outlook provides a convenient method for 
Open-Xchange users to view all their groupware data. The OXtender for Microsoft 
Outlook enables Microsoft Outlook users to still to use their client application 
of choice yet smoothly transition to Open-Xchange collaboration server on the 
back end. 

With the help of the OXtender for Microsoft Outlook, users can sync their email, 
calendar, contacts and tasks with the Open-Xchange server. The use of a familiar 
client tool ensures that users do not have to learn a new environment for 
collaboration with others. Additionally, familiar functions such as working 
off-line, defining mailbox rules, and setting access rights work the same from 
within Outlook. 

The Open-Xchange OXtender for Microsoft Outlook ensures that Microsoft Outlook 
users can enjoy all the collaborative benefits of the Open-Xchange server 
without the need to switch tools. 

== How ==

* '''Email''' - [mailto:leonardo.dilella@open-xchange.com leonardo.dilella AT open-xchange D.O.T com] 
* '''ICQ''' - 340 727 159 
* '''Skype''' - leonardo_dilella 
* '''IRC''' - ledil 
* '''GPG''' - 0x15208141 | 2829 F2BE 2242 91F0 24EB C0A7 258E F1A2 1520 8141

User:Ledil

2007-02-23T01:48:23Z

Ledil: Outlook OXtender Microsoft Leonardo Di Lella

== Who ==

* '''Real name''' - Leonardo Di Lella 
* '''Current Nicknames''' - ledil 
* '''Hometown''' - Olpe, NRW (Germany) 
* '''Current Residence''' - Olpe, NRW (Germany) 

== What ==

* '''Position''' - Team Leader Development (Windows Development) 

=== Current Projects ===

==== OXtender for MS Outlook ====

The Open-Xchange OXtender for Microsoft Outlook provides a convenient method for 
Open-Xchange users to view all their groupware data. The OXtender for Microsoft 
Outlook enables Microsoft Outlook users to still to use their client application 
of choice yet smoothly transition to Open-Xchange collaboration server on the 
back end. 

With the help of the OXtender for Microsoft Outlook, users can sync their email, 
calendar, contacts and tasks with the Open-Xchange server. The use of a familiar 
client tool ensures that users do not have to learn a new environment for 
collaboration with others. Additionally, familiar functions such as working 
off-line, defining mailbox rules, and setting access rights work the same from 
within Outlook. 

The Open-Xchange OXtender for Microsoft Outlook ensures that Microsoft Outlook 
users can enjoy all the collaborative benefits of the Open-Xchange server 
without the need to switch tools. 

== How ==

* '''Email''' - [mailto:leonardo.dilella@open-xchange.com leonardo.dilella AT open-xchange D.O.T com] 
* '''ICQ''' - 340 727 159 
* '''Skype''' - leonardo_dilella 
* '''IRC''' - ledil 
* '''GPG''' - 0x15208141 | 2829 F2BE 2242 91F0 24EB C0A7 258E F1A2 1520 8141