Introduction

The IceWarp ServerAPI is an application programming interface for developers who wish to maintain basic tasks with the IceWarp Email Server objects. These tasks can maintain domains, accounts and other global server settings.

The API can be used in several different ways, including the COM object, RPC or the direct API library linking.

Once installed the IceWarp Email Server the API COM object gets registered automatically and can be used immediately.

It is recommended for developers to use the COM object which is the easiest way to get started.

Use the RPC for platform independent usage and remote calls. See more information in the IceWarp\api\readme.txt file.

You might also want to take a look at sources and examples in the API folders.

\delphi - Delphi sources, Users and Domains command line tools

\vc - Visual C++

\vb - Visual Basic

\php - examples for using IceWarp COM API with IceWarp webserver PHP engine

\calendar\doc - more info for working with GroupWare API

For the complete list of properties / constants see the \delphi\apiconst.pas file.

Some of the other programming language directories might be obsolete and contain old information.

If you are looking for something specific always see the \delphi directory and update your files accordingly.

apiconst.pas:

Contains all constants required to use the API functions.

Function results

OK: >=0

ERROR: < 0

Study the constant names carefully. They also contain comments that might be useful for you.

Note: For users of IIS and external DB systems. If you use API through IIS or similar, and an external Database Storage system, strongly consider adding <InstallDirectory> to your PATH variable as it contains some libraries that will be required.