advertisement
IceWarp Unified Communications
API Reference
Version 10.4
Printed on 5 April, 2012
Contents
IceWarp Server API 1
Introduction ................................................................................................................................................................... 2
API COM Object .............................................................................................................................................................. 3
Introduction ....................................................................................................................................................... 3
IceWarpServer.APIObject .................................................................................................................................. 4
Init ......................................................................................................................................................... 7
Done ...................................................................................................................................................... 7
UpdateConfiguration ............................................................................................................................. 7
ReloadServices ...................................................................................................................................... 8
BackupConfig and RestoreConfig .......................................................................................................... 8
SpamIndexNow ..................................................................................................................................... 8
Save ....................................................................................................................................................... 8
Example: .......................................................................................................................................... 8
GetDomainCount ................................................................................................................................... 9
GetDomainList ....................................................................................................................................... 9
DeleteDomain ....................................................................................................................................... 9
RenameDomain ..................................................................................................................................... 9
GetDomain ............................................................................................................................................ 9
OpenDomain, NewDomain.................................................................................................................... 9
Example: ........................................................................................................................................ 10
GetDomainIndex ................................................................................................................................. 10
LastErr ................................................................................................................................................. 10
GetSchedule ........................................................................................................................................ 10
SetSchedule ......................................................................................................................................... 10
ii Contents
GetUserStatistics, GetUserStatisticsDays ............................................................................................ 10
CreateTables, DropTables, CheckDBConnection ................................................................................. 10
Challenge Response functions ............................................................................................................. 11
IceWarpServer.DomainObject ......................................................................................................................... 11
Name ................................................................................................................................................... 12
Open, New ........................................................................................................................................... 12
Delete .................................................................................................................................................. 12
GetProperty, SetProperty, IPAddress, Save ......................................................................................... 13
Example: ........................................................................................................................................ 13
GetAccountCount ................................................................................................................................ 13
GetAccountList .................................................................................................................................... 13
DeleteAccount, DeleteAccountID ........................................................................................................ 13
GetAccount .......................................................................................................................................... 14
OpenAccount, NewAccount ................................................................................................................ 14
Example: ........................................................................................................................................ 14
GetAccountIndexByAlias ..................................................................................................................... 14
LastErr ................................................................................................................................................. 14
IceWarpServer.AccountObject ........................................................................................................................ 14
Domain ................................................................................................................................................ 15
EmailAddress ....................................................................................................................................... 16
New, Open ........................................................................................................................................... 16
Delete .................................................................................................................................................. 16
SetProperty, GetProperty, Save .......................................................................................................... 16
Example ......................................................................................................................................... 16
AuthenticateUser, AuthenticateUserHash, ValidateUser .................................................................... 17
FindInit, FindNext, FindDone, FindInitQuery ....................................................................................... 17
MailboxConvertMessages ................................................................................................................... 18
IceWarp Server API iii
LastErr ................................................................................................................................................. 18
IceWarpServer.RemoteAccountObject ............................................................................................................ 18
LastErr ................................................................................................................................................. 19
Count ................................................................................................................................................... 19
New ..................................................................................................................................................... 19
Open .................................................................................................................................................... 19
Delete, DeleteIndex ............................................................................................................................. 20
GetSchedule ........................................................................................................................................ 20
SetSchedule ......................................................................................................................................... 20
Example ......................................................................................................................................... 20
IceWarpServer.ScheduleObject ....................................................................................................................... 21
LastErr ................................................................................................................................................. 21
Count ................................................................................................................................................... 21
Add ...................................................................................................................................................... 21
Delete .................................................................................................................................................. 22
Select ................................................................................................................................................... 22
SetProperty, GetProperty .................................................................................................................... 22
Example ......................................................................................................................................... 22
IceWarpServer.StatisticsObject ....................................................................................................................... 23
IsRunning ............................................................................................................................................. 24
Reset .................................................................................................................................................... 24
Poll ....................................................................................................................................................... 24
GetProperty ......................................................................................................................................... 24
Start, Stop ............................................................................................................................................ 24
Example ......................................................................................................................................... 24
IceWarpServer.TokenObject ............................................................................................................................ 25
iv Contents
Example ............................................................................................................................................... 26
IceWarpCOM.Mailer ........................................................................................................................................ 26
IceWarpCOM.IMMessage ................................................................................................................................ 27
IceWarpCOM.IDP ............................................................................................................................................. 28
IceWarpCOM.IceWarpLicense ......................................................................................................................... 29
IceWarpCOM.Groupware ................................................................................................................................ 29
IceWarpCOM.ChallengeResponse ................................................................................................................... 30
Examples .......................................................................................................................................................... 30
Creating New Domain ......................................................................................................................... 30
Creating New User .............................................................................................................................. 31
Deleting User ....................................................................................................................................... 31
COM Usage under PHP .................................................................................................................................... 32
Creating Object.................................................................................................................................... 32
Working with Object ........................................................................................................................... 32
Working with Domain ......................................................................................................................... 33
Working with Accounts ....................................................................................................................... 33
Creating Domain .................................................................................................................................. 34
Creating Account ................................................................................................................................. 34
List all Accounts in all Domains ........................................................................................................... 34
RPC ............................................................................................................................................................................... 36
Tool.exe ........................................................................................................................................................................ 38
Usage ............................................................................................................................................................... 38
Commands ....................................................................................................................................................... 38
Options ............................................................................................................................................................ 39
Parameters ...................................................................................................................................................... 40
Examples .......................................................................................................................................................... 40
Create New Domain ............................................................................................................................ 40
IceWarp Server API
Create Accounts Using Name, Pass and Comment ............................................................................. 40
Display Comments of All doe.com Accounts ....................................................................................... 40
Export All Accounts of doe.com Where Comment Contains Word "first" to File doe_com.csv Using -filter Option ......................................................................................................................................... 41
Export All Accounts of doe.com to csv File (base64 Encoded) ............................................................ 41
Display Comments of All doe.com Accounts ....................................................................................... 41
Delete All Domain Accounts ................................................................................................................ 41
Import Accounts from File ................................................................................................................... 41
Modify Comment of All Accounts @doe.com ..................................................................................... 41
Delete All Accounts of doe.com Domain and Delete doe.com Domain .............................................. 41
Show some System Variables .............................................................................................................. 41
Change System Variable ...................................................................................................................... 41
Display some Information ................................................................................................................... 42
Create Remote Account ...................................................................................................................... 42
Upgrade Database from Version 8.0.3 to Current ............................................................................... 42
Display All Domains on Remote Server and its Description ................................................................ 42
Display Variables of Object .................................................................................................................. 42
Accessing a Remote Server .............................................................................................................................. 42
Using Filters ..................................................................................................................................................... 43
Example ............................................................................................................................................... 43
Command Line Tool...................................................................................................................................................... 44
Sendmail.exe ................................................................................................................................................................ 46
Config.exe ..................................................................................................................................................................... 47
API Variables ................................................................................................................................................................ 48
Function Result Codes ..................................................................................................................................... 48
Configuration ................................................................................................................................................... 49
Version & License ................................................................................................................................ 49
v
vi Contents
Domains ........................................................................................................................................................... 50
Domain ................................................................................................................................................ 50
Limits ................................................................................................................................................... 50
Options ................................................................................................................................................ 51
Accounts .......................................................................................................................................................... 52
Accounts, Shared ................................................................................................................................. 52
User Account ....................................................................................................................................... 52
Read-only Variables ...................................................................................................................... 52
User ............................................................................................................................................... 53
Mailbox ......................................................................................................................................... 53
Limits ............................................................................................................................................. 54
Options .......................................................................................................................................... 55
Responder ..................................................................................................................................... 55
B&W List ........................................................................................................................................ 56
Group Account .................................................................................................................................... 56
Group ............................................................................................................................................ 56
Members ....................................................................................................................................... 57
Options .......................................................................................................................................... 57
Rules .............................................................................................................................................. 57
Mailing List Account ............................................................................................................................ 57
Mailing List .................................................................................................................................... 57
Message ........................................................................................................................................ 58
Security ......................................................................................................................................... 59
Options .......................................................................................................................................... 59
Rules .............................................................................................................................................. 60
List Server Account .............................................................................................................................. 60
List Server ...................................................................................................................................... 60
IceWarp Server API vii
Lists ............................................................................................................................................... 61
Options .......................................................................................................................................... 61
Rules .............................................................................................................................................. 61
Executable Account ............................................................................................................................. 61
Executable ..................................................................................................................................... 61
Rules .............................................................................................................................................. 62
Remote Account .................................................................................................................................. 62
Remote Account ............................................................................................................................ 62
Options .......................................................................................................................................... 63
DomainPop.................................................................................................................................... 63
Static Route Account ........................................................................................................................... 64
Static Route ................................................................................................................................... 64
Notification Account............................................................................................................................ 64
Notification ................................................................................................................................... 64
Options .......................................................................................................................................... 65
Rules .............................................................................................................................................. 66
Catalog Account .................................................................................................................................. 66
Catalog .......................................................................................................................................... 66
Options .......................................................................................................................................... 66
Rules .............................................................................................................................................. 66
Global Settings ................................................................................................................................................. 67
Accounts .............................................................................................................................................. 67
Domains .............................................................................................................................................. 67
Advanced ............................................................................................................................................. 67
Policies ............................................................................................................................................................. 68
Login Policy .......................................................................................................................................... 68
viii Contents
Password Policy ................................................................................................................................... 68
System ............................................................................................................................................................. 69
System Services ................................................................................................................................... 69
SMTP Service ................................................................................................................................. 69
POP3 Service ................................................................................................................................. 69
IMAP Service ................................................................................................................................. 70
Web / Control Service ................................................................................................................... 70
FTP Service .................................................................................................................................... 71
GroupWare Service ....................................................................................................................... 71
Instant Messaging Service ............................................................................................................. 72
LDAP Service ................................................................................................................................. 72
System Logging .................................................................................................................................... 73
General .......................................................................................................................................... 73
Services ......................................................................................................................................... 73
System Tools........................................................................................................................................ 75
System Backup Tool ...................................................................................................................... 75
Server Watchdog Tool ................................................................................................................... 76
System Monitor Tool ..................................................................................................................... 76
Remote Server Watchdog Tool ..................................................................................................... 76
TCP/IP Tunnel Tool ........................................................................................................................ 77
Server Migration Tool ................................................................................................................... 77
Statistics ........................................................................................................................................ 77
System Storage .................................................................................................................................... 78
Accounts........................................................................................................................................ 78
Directories ..................................................................................................................................... 78
Load Balancing .............................................................................................................................. 78
System Internet Connection ................................................................................................................ 79
IceWarp Server API ix
System Advanced ................................................................................................................................ 79
System Active Directory ...................................................................................................................... 80
SMTP Service ................................................................................................................................................... 80
SMTP Service ....................................................................................................................................... 80
General .......................................................................................................................................... 80
Delivery ......................................................................................................................................... 81
Header / Footer ............................................................................................................................. 82
SMTP Security ...................................................................................................................................... 82
General .......................................................................................................................................... 82
DNS ............................................................................................................................................... 82
Intrusion Prevention ..................................................................................................................... 83
Advanced ...................................................................................................................................... 83
SMTP Filters ......................................................................................................................................... 84
Content Filters ............................................................................................................................... 84
Rules .............................................................................................................................................. 84
SMTP Archive ...................................................................................................................................... 84
SMTP ETRN Download ......................................................................................................................... 85
AntiSpam ......................................................................................................................................................... 85
AS General ........................................................................................................................................... 85
AS Quarantine ..................................................................................................................................... 85
Anti-Virus ......................................................................................................................................................... 86
General ................................................................................................................................................ 86
Action .................................................................................................................................................. 87
Filters ................................................................................................................................................... 87
Other ................................................................................................................................................... 87
Services ............................................................................................................................................................ 88
x Contents
Web Service ......................................................................................................................................... 88
FTP Service .......................................................................................................................................... 88
GroupWare .......................................................................................................................................... 89
SyncML ................................................................................................................................................ 89
SMS Service ......................................................................................................................................... 89
Instant Messaging ............................................................................................................................... 90
General .......................................................................................................................................... 90
Archive / History ........................................................................................................................... 90
SIP Service ........................................................................................................................................... 90
Statistics ........................................................................................................................................................... 92
Schedule .......................................................................................................................................................... 93
Validation ......................................................................................................................................................... 93
Mailing List ....................................................................................................................................................... 93
Services ............................................................................................................................................................ 94
Atomic Clock Sync ............................................................................................................................................ 94
Notification ...................................................................................................................................................... 94
C
H A P T E R
1
IceWarp Server API
In This Chapter
Command Line Tool ............................................................................... 44
1
2 API Reference
Introduction
The IceWarp Server API 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 classes.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
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.
API COM Object 3
API COM Object
In This Chapter
IceWarpServer.APIObject ...................................................................... 4
IceWarpServer.DomainObject ............................................................... 11
IceWarpServer.AccountObject .............................................................. 14
IceWarpServer.RemoteAccountObject .................................................. 18
IceWarpServer.ScheduleObject ............................................................. 21
IceWarpServer.StatisticsObject ............................................................. 23
IceWarpServer.TokenObject .................................................................. 25
IceWarpCOM.Mailer .............................................................................. 26
IceWarpCOM.IMMessage ...................................................................... 27
IceWarpCOM.IceWarpLicense ............................................................... 29
IceWarpCOM.Groupware ...................................................................... 29
IceWarpCOM.ChallengeResponse ......................................................... 30
COM Usage under PHP .......................................................................... 32
Introduction
Maintaining the IceWarp Email Server has never been easier. The API brings you the best way to maintain your IceWarp
Server from any programming language such as Visual C++, Visual Studio, Delphi, FreePascal, PHP, ASP, Visual Basic, Microsoft
.NET or any other.
You can use the RPC (Remote Procedure Call) to access the server remotely or COM object.
Both RPC and COM can be used right after the IceWarp Email Server installation has been finished
There are multiple objects you can use to maintain the server. The class names are:
IceWarpServer.APIObject
IceWarpServer.DomainObject
IceWarpServer.AccountObject
IceWarpServer.RemoteAccountObject
IceWarpServer.ScheduleObject
IceWarpServer.StatisticsObject
IceWarpServer.TokenObject
All of them interact with each other and make the hardest work for you.
4 API Reference
The APIObject is the root of the whole API. It offers the basic functions like Backup, Restore, Global settings maintenance and Domain access.
When accessed a domain the DomainObject is returned. This object lets you maintain your domains, edit, delete, settings, and account access. The object can be created without even creating the APIObject.
When accessing an account the AccountObject is returned which offers you complete account managment features, edit, delete, settings, browse all users and much more.
You can also create this object without any prior object creation.
Every object has the LastErr property which contains the last error. Error is any negative number a function or property returned. Any positive or zero number is considered as a success.
Any properties set or retrieved are automatically converted to the right variable type no matter if it is a number, string or date. See the complete list of all constant namess in the api\delphi\apiconst.pas file.
IceWarpServer.APIObject
IAPIObjectDisp = dispinterface
['{BFD83E1B-6F4A-4E06-B0DE-0427C73753C0}']
procedure Done; dispid 201;
function Init(const Path: WideString): WordBool; dispid 202;
procedure UpdateConfiguration; dispid 203;
procedure ReloadServices; dispid 204;
function BackupConfig(const Path: WideString): WordBool; dispid 205;
function RestoreConfig(const Path: WideString; const Password: WideString): WordBool; dispid 206;
function SpamIndexNow(const Email: WideString): WordBool; dispid 207;
function GetDomainCount: Integer; dispid 208;
function Save: WordBool; dispid 209;
function DeleteDomain(const Domain: WideString): WordBool; dispid 210;
function RenameDomain(const OldDomain: WideString; const NewDomain: WideString): WordBool; dispid 211;
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; dispid 212;
API COM Object
property LastErr: Integer readonly dispid 217;
function GetDomainList: WideString; dispid 213;
function GetDomain(Index: Integer): WideString; dispid 214;
function OpenDomain(const Domain: WideString): OleVariant; dispid 215;
function NewDomain(const Domain: WideString): OleVariant; dispid 216;
function GetProperty(Command: OleVariant): OleVariant; dispid 218;
function GetDomainIndex(const Domain: WideString): Integer; dispid 219;
function GetSchedule(Command: OleVariant): OleVariant; dispid 220;
function SetSchedule(Command: OleVariant; Schedule: OleVariant): WordBool; dispid 221;
function GetUserStatistics(const From: WideString; const To_: WideString; const Filter: WideString): WideString; dispid 222;
function GetUserStatisticsDays(const From: WideString; const To_: WideString; const Filter: WideString): WideString; dispid
223;
function CreateTables(Service: Integer; const Connection: WideString): WordBool; dispid 224;
function DropTables(Service: Integer): WordBool; dispid 225;
function ChallengeResponseList(const Recipient: WideString; const Flags: WideString): WideString; dispid 226;
function ChallengeResponseAdd(const Recipient: WideString; const Email: WideString; const State: WideString): WordBool; dispid 227;
function ChallengeResponseDelete(const Recipient: WideString; const Email: WideString; const Folder: WideString):
WordBool; dispid 228;
function ChallengeResponseAuthorize(const Folder: WideString): WordBool; dispid 229;
function ChallengeResponsePath(const Folder: WideString): WideString; dispid 230;
procedure AntiVirusUpdate; dispid 231;
procedure AntiSpamUpdate; dispid 232;
procedure SpamCompactDB; dispid 233;
procedure ConnectNow; dispid 234;
procedure RemoteServerWatchdogNow; dispid 235;
procedure TaskEventNow(Index: Integer); dispid 236;
procedure RemoteAccountNow(Index: Integer); dispid 237;
procedure FTPSyncNow(Item: Integer); dispid 238;
procedure ETRNNow(Index: Integer); dispid 239;
5
6 API Reference
function CheckDBConnection(const Connection: WideString): WordBool; dispid 240;
function CheckDNSServer(const DNS: WideString): WordBool; dispid 241;
function Migration_MigrateMessages(Single: WordBool; const User: WideString; const Pass: WideString; const Domain:
WideString; const BulkBuffer: WideString): WordBool; dispid 242;
function Migration_MigrateMessagesAccounts(Single: WordBool; const User: WideString; const Pass: WideString; const
BulkBuffer: WideString): WordBool; dispid 243;
function Migration_Finish: Integer; dispid 244;
function ProcessUpgradeTasks(const PreviousVersion: WideString): WordBool; dispid 245;
function IDNToUTF8(const IDN: WideString): WideString; dispid 246;
function UTF8ToIDN(const UTF8: WideString): WideString; dispid 247;
function GetLocalIPs: WideString; dispid 248;
property TokenHandle: Integer dispid 249;
function LocateString(const String_: WideString): WideString; dispid 250;
function QuarantineAuthorize(const Folder: WideString): WordBool; dispid 251;
function QuarantineDelete(const Owner: WideString; const Sender: WideString; const Folder: WideString): WordBool; dispid 252;
function QuarantineList(const Owner: WideString; const Flags: WideString; Count: Integer; Offset: Integer): WideString; dispid 253;
function SIPReferCall(const Owner: WideString; const Number: WideString): WordBool; dispid 226;
function GLList(const Email: WideString; const Flags: WideString; Count: Integer; Offset: Integer): WideString; dispid 227;
function QuarantineAdd(const Recipient: WideString; const Email: WideString; const State: WideString): WordBool; dispid
228;
function QuarantineSet(const Recipient: WideString; const Email: WideString; const State: WideString): WordBool; dispid
229;
function GLSet(const Value: WideString; const Email: WideString; const Status: WideString): WordBool; dispid 230;
function GLAdd(const Value: WideString; const Email: WideString; const Status: WideString): WordBool; dispid 254;
function GLDelete(const Value: WideString; const Email: WideString; const Status: WideString): WordBool; dispid 255;
function GetFolderList(const Folder: WideString; Rec: WordBool): WideString; dispid 256;
function DeleteFiles(const Folder: WideString; const Files: WideString; Rec: WordBool; Older: Integer): WordBool; dispid
257;
procedure PostServiceMessage(Service: Integer; Msg: Integer; WParam: Integer; LParam: Integer); dispid 258;
API COM Object
function MakePrimaryDomain(const Domain: WideString): WordBool; dispid 259;
function MigrateDatabase(const SourceDSN: WideString; const DestDSN: WideString; const LogFile: WideString; DBIndex:
Integer): WordBool; safecall; dispid 260;
function ConvertStorage(ToDB: WordBool): WordBool; dispid 261;
function GetFileList(const Folder: WideString; Rec: WordBool): WideString; dispid 262;
function GetMessageContent(const FileName: WideString; const Type_: WideString; MaxSize: Integer; MaxLines: Integer):
WideString; dispid 263;
function Base64FileEncode(const Source: WideString; const Dest: WideString): WordBool; dispid 264;
function SMSHTTP(const HTTP: WideString; BypassAuth: WordBool): WordBool; dispid 265;
function SyncMLPush(const Param1: WideString; const Param2: WideString; const Param3: WideString; const Param4:
WideString): WideString; dispid 266;
function CryptData(const Alg: WideString; const Key: WideString; const Data: WideString; Encode: WordBool): WideString; dispid 267;
end;
7
Init
function Init(const Path: WideString): WordBool
The Init function is automatically called by any object created. You should not call the function.
The path can be empty and in such case the COM object locates the IceWarp Email Server configuration files automatically or it can be the full path to the IceWarp Email Server directory. It loads all the settings and information the COM object might need.
Done
procedure Done
The Done function closes the COM object and frees the allocated data. It also saves the changed settings if any.
The function is called automatically when the COM object is freed.
UpdateConfiguration
procedure UpdateConfiguration
Notifies all of the running services of any new changes to the settings. This is required for global settings changed.
In such case the services need to be notified to reload their configuration files.
8 API Reference
ReloadServices
procedure ReloadServices
The ReloadServices restarts SMTP and POP3 service. To restart all services use function
Start(stAll)
from the
IceWarpServer.StatisticsObject
object .
BackupConfig and RestoreConfig
function BackupConfig(const Path: WideString): WordBool function RestoreConfig(const Path: WideString; const Password: WideString): WordBool
The Backup and Restore functions are identical to the IceWarp Email Server administration interface backup and restore features.
They let you backup and restore the IceWarp Email Server settings. The Path parameter specifies the complete file name of the destination backup file.
SpamIndexNow
function SpamIndexNow(const Email: WideString): WordBool
This function takes care of indexing the spam and genuine messages. The Email is the account email address to be indexed.
If empty the global spam and genuine messages will be indexed.
Save
function Save: WordBool function SetProperty(Command: OleVariant; Value: OleVariant): WordBool function GetProperty(Command: OleVariant): OleVariant
These three functions make it all easy. You can set or read any global setting value. The command specifies the variable ID and the value the variable content. When set all properties you should call the Save function.
Example:
$com->GetProperty("c_name");
$com->SetProperty("c_name", "mail.domain.com");
$com->Save();
GetDomainCount
function GetDomainCount: LongWord
Returns the number of all domains on the IceWarp Email Server.
GetDomainList
function GetDomainList: WideString
Returns the whole list of domains separated with semicolon.
DeleteDomain
function DeleteDomain(const Domain: WideString): WordBool
Deletes an existing domain with all its accounts.
RenameDomain
function RenameDomain(const OldDomain: WideString; const NewDomain: WideString): WordBool
Renames an old domain to the new domain name.
GetDomain
function GetDomain(Index: LongWord): WideString
Returns the name of the domain specified by the Index position from the domain list.
OpenDomain, NewDomain
function OpenDomain(const Domain: WideString): OleVariant function NewDomain(const Domain: WideString): OleVariant
Both of these functions return an instance to the IceWarpAPI.DomainObject.
The Domain parameter specifies the name of the domain to be opened or created.
Once the instance returned use the DomainObject functions and properties.
Use the OpenDomain function to edit an existing domain.
You can change the properties or accounts of the domain.
API COM Object 9
10 API Reference
The NewDomain lets you add a new domain.
Example:
$domain = $com->NewDomain("test.com");
GetDomainIndex
function GetDomainIndex(const Domain: WideString): Integer
Returns the position of the domain in the list. If not found a negative number will be returned.
LastErr
property LastErr: Integer
The LastErr property specifies the numeric value of the last function result. See the result description in the Introduction.
GetSchedule
function GetSchedule(Command: OleVariant): OleVariant;
Returns the schedule object for the specified variable.
SetSchedule
function SetSchedule(Command: OleVariant; Schedule: OleVariant): WordBool;
Sets the schedule data from the schedule object for the given variable.
GetUserStatistics, GetUserStatisticsDays
function GetUserStatistics(const From: WideString; const To_: WideString; const Filter: WideString): WideString; function GetUserStatisticsDays(const From: WideString; const To_: WideString; const Filter: WideString): WideString;
Retrieves the user statistics. From and To are date indicators, filter can contain email patterns.
CreateTables, DropTables, CheckDBConnection
function CreateTables(Service: Integer; const Connection: WideString): WordBool;
function DropTables(Service: Integer): WordBool; function CheckDBConnection(const Connection: WideString): WordBool;
Creates and destroys tables of specific services. Connection is the new connecting string.
Service values:
0 - Storage
1 - Logs
2 - GroupWare
3 - Challenge Response
API COM Object 11
Challenge Response functions
function ChallengeResponseList(const Recipient: WideString; const Flags: WideString): WideString; function ChallengeResponseAdd(const Recipient: WideString; const Email: WideString; const State: WideString): WordBool; function ChallengeResponseDelete(const Recipient: WideString; const Email: WideString; const Folder: WideString):
WordBool; function ChallengeResponseAuthorize(const Folder: WideString): WordBool; function ChallengeResponsePath(const Folder: WideString): WideString;
Challenge response management functions.
IceWarpServer.DomainObject
IDomainObjectDisp = dispinterface
['{92E93C97-041B-47CB-A565-387C44BCB9A7}']
property LastErr: Integer readonly dispid 201;
property Name: WideString dispid 202;
property IPAddress: WideString dispid 203;
function Open(const Domain: WideString): WordBool; dispid 204;
function Save: WordBool; dispid 205;
function New(const Domain: WideString): WordBool; dispid 206;
function GetAccountCount: Integer; dispid 207;
function GetAccountList: WideString; dispid 208;
12 API Reference
function GetAccount(Index: Integer): WideString; dispid 209;
function DeleteAccount(const Email: WideString): WordBool; dispid 210;
function DeleteAccountID(ID: Integer): WordBool; dispid 219;
function Delete: WordBool; dispid 211;
function GetProperty(Command: OleVariant): OleVariant; dispid 212;
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; dispid 213;
function OpenAccount(const Email: WideString): OleVariant; dispid 214;
function NewAccount(const Email: WideString): OleVariant; dispid 215;
function GetAccountIndexByAlias(const Email: WideString): Integer; dispid 216;
property TokenHandle: Integer dispid 218;
function ApplyTemplate(const Name: WideString): WordBool; dispid 217;
end;
Name
property Name: WideString
The Name property lets you read or set the Name of the domain you want to create or save. Usually you do not need to set this at all. Use the Open and New functions instead.
Open, New
function Open(const Domain: WideString): WordBool function New(const Domain: WideString): WordBool
The Open new functions let you open an existing domain or create a new domain. It loads the settings and initializes the variables. When accessed the domain from APIObject you do not need to use these functions. Use them only if creating a new object.
Delete
function Delete: WordBool
When editing an existing domain you can delete it by calling this function. The domain must be properly loaded.
API COM Object
GetProperty, SetProperty, IPAddress, Save
function GetProperty(Command: OleVariant): OleVariant function SetProperty(Command: OleVariant; Value: OleVariant): WordBool property IPAddress: WideString function Save: WordBool
You can edit or read the properties of the domain using these functions. The IPAddress property lets you specify all virtual IP addresses of the domain. The Save function is required to be called when finished editing.
When creating a new domain you also need to call the Save function once finished setting the properties.
You can then call the Save function again and the domain will be only updated and not added again.
13
Example:
$domain->SetProperty("d_postmaster", "postmaster;webmaster;admin");
$domain->SetProperty("d_description", "Demo Domain");
$domain->IPAddress = "192.168.0.1;192.168.0.2";
$domain->Save();
GetAccountCount
function GetAccountCount: LongWord
Returns the number of all accounts in the domain.
GetAccountList
function GetAccountList: WideString
Returns the whole domain list of all account aliases separated with semicolon.
DeleteAccount, DeleteAccountID
function DeleteAccount(const Email: WideString): WordBool function DeleteAccountID(ID: Integer): WordBool
Deletes an existing account. The Email parameter can be either a complete email address or just an alias.
14 API Reference
GetAccount
function GetAccount(Index: LongWord): WideString
Return the account's alias specified by the Index in the account list.
OpenAccount, NewAccount
function OpenAccount(const Email: WideString): OleVariant function NewAccount(const Email: WideString): OleVariant
Both of these functions return an instance to the IceWarpAPI.AccountObject. The Email parameter can be either an alias or a complete domain name. Once the instance returned use the AccountObject functions and properties.
Use the OpenAccount function to edit an existing account. The NewAccount lets you add a new account.
Example:
$account = $domain->NewAccount("test");
GetAccountIndexByAlias
function GetAccountIndexByAlias(const Email: WideString): Integer
Tries to find the alias in the domain. If found the index will be returned. If not a negative number will be returned.
The Email parameter can contain only the alias and in that case the domain name of the object will be used or it can contain the full email address.
LastErr
property LastErr: Integer
The LastErr property specifies the numeric value of the last function result. See the result description in the Introduction.
IceWarpServer.AccountObject
IAccountObjectDisp = dispinterface
['{F0816647-788E-4520-8685-BCDDAEBECCEF}']
property LastErr: Integer readonly dispid 201;
property Domain: WideString readonly dispid 202;
function New(const Email: WideString): WordBool; dispid 203;
function Open(const Email: WideString): WordBool; dispid 204;
function Save: WordBool; dispid 205;
function Delete: WordBool; dispid 206;
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; dispid 207;
function GetProperty(Command: OleVariant): OleVariant; dispid 208;
function AuthenticateUser(const Username: WideString; const Password: WideString;
const IP: WideString): WordBool; dispid 211;
function FindInit(const Domain: WideString): WordBool; dispid 212;
function FindNext: WordBool; dispid 213;
procedure FindDone; dispid 214;
function CanCreateMailbox(const Alias: WideString; const Mailbox: WideString;
const Password: WideString; const Domain: WideString): WordBool; dispid 209;
function FindInitQuery(const Domain: WideString; const Query: WideString): WordBool; dispid 216;
property EmailAddress: WideString readonly dispid 217;
function AuthenticateUserHash(const Username: WideString; const Hash: WideString;
const IP: WideString; const Method: WideString;
Flags: Unsigned Integer): WordBool; safecall; dispid 218;
function ValidateUser(Account: Integer): WordBool; dispid 219;
function GetUserGroups(const User: WideString): WideString; dispid 215;
property TokenHandle: Integer dispid 220;
function ApplyTemplate(const Name: WideString): WordBool; dispid 210;
function ValidateData(const Type_: WideString): WordBool; dispid 221;
end;
API COM Object 15
Domain
property Domain: WideString readonly
16 API Reference
The Domain property returns the name of the domain the account resides in.
EmailAddress
property EmailAddress: WideString readonly
The email address of the current user.
New, Open
function New(const Email: WideString): WordBool function Open(const Email: WideString): WordBool
The Open new New functions let you open an existing account or create a new one. It loads the settings and initializes the variables. When accessed the account from APIDomain you do not need to use these functions. Use them only if creating a new object.
Delete
function Delete: WordBool
You can delete an existing account you are editing by calling the Delete function.
SetProperty, GetProperty, Save
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool function GetProperty(Command: OleVariant): OleVariant function Save: WordBool
The same logic is applied as to other Property functions. When finished editing call the Save function. When adding a new user you are required to call the Save function which will add and save the user. You can then call the Save function again and the user will be only updated and not added again.
Example
$account->SetProperty("u_name", "My Name");
$account->SetProperty("u_password", "pass01");
$account->Save();
API COM Object
AuthenticateUser, AuthenticateUserHash, ValidateUser
function AuthenticateUser(const Username: WideString; const Password: WideString; const IP: WideString): WordBool function AuthenticateUserHash(const Username: WideString; const Hash: WideString; const IP: WideString; const Method:
WideString; Flags: Unsigned Integer): WordBool; safecall; function ValidateUser(Account: Integer): WordBool;
The AuthenticateUser function lets you check and load the user specified by the Username, Password and IP address.
If successful the user is loaded and you can edit it. The IP address is not required. Methods supported can be:
CRAM-MD5
DIGEST-MD5
SHA1
MD5
The flags parameter is interpreted as a bit mask. Bit 0: EmailLogin, Bit 1: Support migration (if login is not successfull and migration is running, migration session is initiated).
The ValidateUser function checks whether the successfully authenticated user can access his mailbox. Basically the validation function makes sure the user is not expired, has the right to login and other user restrictions.
17
FindInit, FindNext, FindDone, FindInitQuery
function FindInit(const Domain: WideString): WordBool function FindNext: WordBool procedure FindDone function FindInitQuery(const Domain: WideString; const Query: WideString): WordBool;
These functions let you loop through all accounts in the domain. It is not recommended to use the GetDomainCount and loop thru each account based on the Index. That would be too slow. Use these functions instead.
The FindInit function initializes the buffer and opens the database. If returned False there are no accounts and you must not call the other functions. If returned True call then the FindNext function in a loop until False returned. For each successful call you can use the object properties to query and update the account. Call the FindDone when finished to free the resources.
Example 1:
if ($account->FindInit("test.com"))
{
While ($account->FindNext()) {
echo $account->GetProperty("u_alias");
18 API Reference
}
$account->FindDone();
}
FindInitQuery function does the same job as the FindInit function except it accepts a Query parameter which lets you to loop thru accounts meeting the criteria. The query uses SQL syntax and is supported for file system accounts too. Numeric parameters should be treated like strings. Always use grouping brackets. The LIKE operator is also supported in the file system accounts mode.
Example 2:
$account->FindInitQuery("test.com", "(u_alias like '%john%') or (u_admin = '1')"); function CanCreateMailbox(const Alias: WideString; const Mailbox: WideString; const Password: WideString; const Domain:
WideString): WordBool
Returns True if an account with the given details can be created. You can call Save() instead to see if a false result will be returned but this function makes sure you know the state before.
MailboxConvertMessages
function MailboxConvertMessages(const MailboxPath: WideString; FromIMAP: WordBool): WordBool;
Converts all messages in the mailbox path of the account IMAP to POP3 and POP3 to IMAP.
LastErr
property LastErr: Integer
The LastErr property specifies the numeric value of the last function result. See the result description in the Introduction.
IceWarpServer.RemoteAccountObject
IRemoteAccountObjectDisp = dispinterface
['{7C845AFF-8FB4-4C67-AC29-7B47D11B6001}']
property LastErr: Integer readonly dispid 201;
function New: WordBool; dispid 203;
function Open(Index: Integer): WordBool; dispid 204;
function Save: WordBool; dispid 205;
function Delete: WordBool; dispid 206;
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; dispid 207;
function GetProperty(Command: OleVariant): OleVariant; dispid 208;
function DeleteIndex(Index: Integer): WordBool; dispid 209;
function Count: Integer; dispid 210;
function GetSchedule(Command: OleVariant): OleVariant; dispid 211;
function SetSchedule(Command: OleVariant; Schedule: OleVariant): WordBool; dispid 212;
property TokenHandle: Integer dispid 213;
function ApplyTemplate(const Name: WideString): WordBool; dispid 202;
end;
API COM Object 19
LastErr
property LastErr: Integer
The LastErr property specifies the numeric value of the last function result. See the result description in the Introduction.
Count
function Count: Integer;
Returns the total number of all system remote accounts on the server.
New
function New: WordBool;
Resets all settings and inner variables to create a new remote account.
Open
function Open(Index: Integer): WordBool;
Lets you load an existing remote account. You can then perform any actions on the loaded remote account.
SetProperty, GetProperty, Save function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; function GetProperty(Command: OleVariant): OleVariant;
20 API Reference
function Save: WordBool;
When finished editing call the Save function. When adding a new remmote account you are required to call the Save function which will add and save the accountr. You can then call the Save function again and the account will be only updated and not added again.
Delete, DeleteIndex
function Delete: WordBool; function DeleteIndex(Index: Integer): WordBool;
The Delete function lets you delete the currently open remote account. The DeleteIndex lets you delete an account without even opening it knowing the Index of the account.
GetSchedule
function GetSchedule(Command: OleVariant): OleVariant;
Returns the schedule object for the specified variable.
SetSchedule
function SetSchedule(Command: OleVariant; Schedule: OleVariant): WordBool;
Sets the schedule data from the schedule object for the given variable.
Example
$ra->SetProperty("ra_name", "Remote Name");
$ra->SetProperty("ra_domainstring", "domain.com");
$ra->SetProperty("ra_pop3server", "server.isphost.com");
$ra->SetProperty("ra_username", "userlogin");
$ra->SetProperty("ra_password", "password");
$ra->SetProperty("ra_forwardto", "[email protected]");
$ra->Save();
API COM Object
IceWarpServer.ScheduleObject
----------------------------
IScheduleObjectDisp = dispinterface
['{3411CE71-91A5-42D1-93F3-A0A38EF541D0}']
property LastErr: Integer readonly dispid 201;
function Add: WordBool; dispid 203;
function Delete(Index: Integer): WordBool; dispid 204;
function Select(Index: Integer): WordBool; dispid 205;
function GetProperty(Command: OleVariant): OleVariant; dispid 207;
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; dispid 208;
property Count: Integer dispid 206;
property TokenHandle: Integer dispid 209;
property Data: Integer readonly dispid 202;
end;
The schedule object makes it possible to edit and read any schedule structure of different mail server settings.
21
LastErr
property LastErr: Integer
The LastErr property specifies the numeric value of the last function result. See the result description in the Introduction.
Count
property Count: Integer
Lets you change and read the total number of all schedule items
Add
function Add: WordBool;
Adds a new schedule item to the structure and sets the active position to it.
22 API Reference
Delete
function Delete(Index: Integer): WordBool;
Deletes a schedule item from the structure.
Select
function Select(Index: Integer): WordBool;
Selets a schedule item so all property changes and reads will be done to that schedule item.
SetProperty, GetProperty
function SetProperty(Command: OleVariant; Value: OleVariant): WordBool; function GetProperty(Command: OleVariant): OleVariant;
Functions to manipulate the properties of the whole schedule structure.
Example
$ra->Open(0); // Opens the first remote account
$schedule = $ra->GetSchedule('ra_schedule'); // Retrieve the schedule for the object
$schedule->Count = 1; // Sets 1 schedule item
$schedule->SetProperty("s_weekdays_su", true);
$schedule->SetProperty("s_weekdays_mo", true);
$schedule->SetProperty("s_weekdays_tu", true);
$schedule->SetProperty("s_weekdays_we", true);
$schedule->SetProperty("s_weekdays_th", true);
$schedule->SetProperty("s_weekdays_fr", true);
$schedule->SetProperty("s_weekdays_sa", true);
$schedule->SetProperty("s_scheduletype", 0); // Every x minutes type
$schedule->SetProperty("s_every", 1200); // Sets 20 minutes
$schedule->SetProperty("s_wholeday", true); // Do not use day interval but rather the whole day
API COM Object
$ra->SetSchedule('ra_schedule', $schedule); // Sets the changed schedule structure back to the remote account
$ra->Save(); // Save the changed remote account
23
IceWarpServer.StatisticsObject
SMTP
POP3
IMAP
IM
GW
FTP
Control
SIP
LDAP
--------------------------
IStatisticsObjectDisp = dispinterface
['{A17B4801-6473-475E-89C9-20E246D1B4A6}']
function IsRunning(const Service: WideString): WordBool; dispid 201;
function Reset(const Service: WideString): WordBool; dispid 202;
function Poll(const Service: WideString): WordBool; dispid 203;
function GetProperty(Command: OleVariant): OleVariant; dispid 204;
function Start(const Service: WideString): WordBool; dispid 205;
function Stop(const Service: WideString): WordBool; dispid 206;
function GetSessions(const Service: WideString; History: WordBool): WideString; dispid 207;
property TokenHandle: Integer dispid 208;
end;
The statistics object lets you poll different services of the mail server and read the statistics such as running time, server connections, data sent received and much more.
Service variable can contain these values:
24 API Reference
IsRunning
function IsRunning(const Service: WideString): WordBool; dispid 201;
Returns True if the service is running.
Reset
function Reset(const Service: WideString): WordBool; dispid 202;
Resets the counters for the specified service. Only the datetime will be preserved.
Poll
function Poll(const Service: WideString): WordBool; dispid 203;
Reads the statistics from the service. Call this function once a time and then use the GetProperty method to retrieve the counters.
GetProperty
function GetProperty(Command: OleVariant): OleVariant; dispid 204;
Once used the Poll method use this method to retrieve the particular counters. All variables/commands can be found in the
APIConst.pas file.
Start, Stop
function Start(Service: OleVariant): WordBool; function Stop(Service: OleVariant): WordBool;
Starts and stops services.
Example
$stat = new COM("IceWarpServer.StatisticsObject");
$stat->Poll("SMTP"); echo $stat->GetProperty("st_serverconns"); // Total number of server connections echo $stat->GetProperty("st_server"); // Number of concurrent connections to the server echo $stat->GetProperty("st_smtp_messagesout"); // Number of sent messages
API COM Object
IceWarpServer.TokenObject
ITokenObjectDisp = dispinterface
['{4BF40970-D018-430C-A7B4-6D141F14102F}']
property URL: WideString dispid 201;
property TokenHandle: Integer readonly dispid 202;
property Counter: Integer readonly dispid 203;
end;
The token object lets you run API using RPC (Remote Procedure Calls) and connect to any remote server over the internet and use the API.
Before using any other class create the token object and set the URL to format: administrator ":" password "@" server
Then retrieve the TokenHandle.
Each class of the API has also the TokenHandle. Set the retrieved TokenHandle to any API class so it will use the RPC. It is easy as that.
List of variables that can be retrieved remotely
U_RulesContentXML
U_ResponderContent
U_MailboxSize
U_MailboxQuota
D_IPAddress
D_RulesContentXML
C_TimeZone
C_AS_Info_UpdateDate
C_AS_Info_UpdateVersion
C_AS_Info_UpdateSize
C_AS_Info_BayesWords
C_AS_Info_BayesSpamMessages
25
26 API Reference
C_AS_Info_BayesGenuineMessages
C_AS_Info_EngineVersion
C_AV_Info_UpdateDate
C_AV_Info_UpdateSize
C_AV_Info_UpdateVersion
C_License
NOTE: If you call any other API variable remotely, only the local value is returned.
Example
$token = new COM("IceWarpServer.TokenObject");
$token->URL = "admin:[email protected]";
$api = new COM("IceWarpServer.APIObject");
$api->TokenHandle = $token->TokenHandle;
$api->GetProperty("C_License");
The example above connects to remote.server.com and retrieves the
C_License
API variable.
IceWarpCOM.Mailer
IMailerDisp = dispinterface
['{AFE68541-8496-11D7-BE4E-00055DDED8D2}'] property RemoteHost: WideString dispid 201;
property FromAddress: WideString dispid 202;
property FromName: WideString dispid 203;
property BodyText: WideString dispid 204;
property Subject: WideString dispid 205;
property Recipients: WideString dispid 206;
property MailFrom: WideString dispid 207;
property ContentTransferEncoding: WideString dispid 208;
property Charset: WideString dispid 209;
property IsHTML: WordBool dispid 210;
property Result: Integer readonly dispid 211;
property Response: WideString readonly dispid 212;
procedure Reset; dispid 213;
property Helo: WideString dispid 214;
procedure AddRecipient(const Email: WideString; const Name: WideString); dispid 215;
procedure AddCc(const Email: WideString; const Name: WideString); dispid 216;
procedure AddBcc(const Email: WideString; const Name: WideString); dispid 217;
function SendMail: WordBool; dispid 218;
procedure AddCustomHeader(const HeaderValue: WideString); dispid 219;
procedure AddAddress(const Email: WideString; const Name: WideString); dispid 220;
procedure AddReplyTo(const Email: WideString; const Name: WideString); dispid 221;
procedure AddAttachment(const Attachment: WideString); dispid 222;
function EncodeHeader(const Header: WideString): WideString; dispid 223;
procedure AddEmbeddedImage(const FileName: WideString; const CID: WideString); dispid 224;
procedure AppendBodyFromFile(const FileName: WideString); dispid 225;
procedure ResetRecipients; dispid 226;
property UserName: WideString dispid 227;
property Password: WideString dispid 228;
end;
API COM Object 27
IceWarpCOM.IMMessage
IIMMessageDisp = dispinterface
['{A28A1D42-848B-11D7-BE4E-00055DDED8D2}']
property MessageBody: WideString dispid 201;
property MessageFrom: WideString dispid 202;
28 API Reference
property MessageSubject: WideString dispid 203;
property MessageTo: WideString dispid 204;
property MessageType: WideString dispid 205;
property MessageTag: WideString dispid 206;
procedure Reset; dispid 207;
function SendMessage: WordBool; dispid 208;
procedure AddAttribute(const Attribute: WideString; const Value: WideString); dispid 209;
procedure AddTag(const Tag: WideString); dispid 210;
function IsOnline(const Email: WideString): WordBool; dispid 211;
end;
IceWarpCOM.IDP
IIDPDisp = dispinterface
['{AEE4E6B2-CE55-4838-A591-056E56553AC0}']
function AddFiles(const PackageFile: WideString; const Directory: WideString): WordBool; dispid 201;
procedure RestoreFiles(const PackageFile: WideString; const Directory: WideString;
var Result: WordBool); dispid 202;
function ListFiles(const PackageFile: WideString): WideString; dispid 203;
function RestoreFilesEx(const PackageFile: WideString; const Directory: WideString;
const FilesList: WideString; const Password: WideString): WordBool; dispid 205;
function AddFilesEx(const PackageFile: WideString; const Directory: WideString;
const Password: WideString): WordBool; dispid 204;
end;
API COM Object
IceWarpCOM.IceWarpLicense
NOTE: This API object is obsolete and no longer returns correct values due to change in internal license system.
To get license data call
GetProperty('c_license_xml')
instead. You will obtain all license data in the xml format.
IIceWarpLicenseDisp = dispinterface
['{E0D781D9-47A0-425A-A02D-C537441B3CF2}']
property LicenseDemo: WordBool readonly dispid 201;
property LicenseAppID: Integer readonly dispid 202;
property LicenseDomains: Integer readonly dispid 203;
property LicenseUsers: Integer readonly dispid 204;
property LicenseProductID: Integer readonly dispid 205;
property LicenseExpiresAfter: Integer readonly dispid 206;
property LicenseValid: WordBool readonly dispid 207;
function ValidateLicense(const LicenseKey: WideString): WordBool; dispid 208;
function ValidateLicenseWithReferenceKey(const LicenseKey: WideString;
const ReferenceKey: WideString): WordBool; dispid 209;
property LicenseCreationDate: Integer readonly dispid 210;
property LicenseValidFor: Integer readonly dispid 211;
property LicenseCount: Integer readonly dispid 212;
function SelectLicense(Index: Integer): WordBool; dispid 213;
property LicenseXML: WideString readonly dispid 214;
property LicenseVersion: Integer readonly dispid 215;
property LicenseFraud: Integer readonly dispid 216;
end;
29
IceWarpCOM.Groupware
IGroupWare = interface(IDispatch)
['{6C999005-6566-47EC-852F-57AAC2B7BBE4}']
30 API Reference
function FunctionCall(const FuncName: WideString; const Param1: WideString; const Param2: WideString; const Param3:
WideString; const Param4: WideString): WideString; safecall;
function Connect(const Server: WideString; SSL: WordBool): WordBool; safecall;
function Disconnect: WordBool; safecall;
end;
NOTE: For more information on these functions and parameters, refer to the <install_dir>\calendar\doc\api.txt file.
IceWarpCOM.ChallengeResponse
IChallengeResponse = interface(IDispatch)
['{52A61EE2-1539-4669-B934-482470ACFCE6}']
function FunctionCall(const FuncName: WideString; const Param1: WideString; const Param2: WideString; const Param3:
WideString): WideString; safecall;
end;
Examples
You can find some simple example scripts in the API\COM\ directory. They demonstrate the basic functionality of the COM object. Adapting it to any other programming language is very easy.
Other examples can be found in this documentation below.
Creating New Domain
if ($com = new COM("IceWarpServer.APIObject"))
{
$domain = $com->NewDomain("test.com");
$domain->SetProperty("d_description", "Description");
$domain->SetProperty("d_adminemail", "[email protected]");
$domain->Save();
}
Creating New User
if ($account = new COM("IceWarpServer.AccountObject"))
{
$account->New("[email protected]");
$account->SetProperty("u_name", "Test Account");
$account->SetProperty("u_password", "Pass1");
$account->SetProperty("u_mailbox", "postmaster");
$account->Save();
}
Deleting User
} if ($account = new COM("IceWarpServer.AccountObject"))
{
$account->Open("[email protected]");
$account->Delete();
API COM Object 31
32 API Reference
COM Usage under PHP
In This Chapter
Working with Domain ............................................................................ 33
Working with Accounts .......................................................................... 33
List all Accounts in all Domains .............................................................. 34
Creating Object
<?
if ($com = new COM("IceWarpCOM.APIObject"))
{
echo "COM object created\r\n";
echo "\r\n";
?>
Working with Object
<?
$domcount = $com->GetDomainCount();
echo "Domain count: $domcount\r\n";
$domlist = $com->GetDomainList();
echo "Domain list: $domlist\r\n";
$domainname = $com->GetDomain(0);
echo "First domain: $domainname\r\n";
echo "\r\n";
?>
Working with Domain
<?
$domain = $com->OpenDomain($domainname);
$domname = $domain->Name;
echo "Loaded domain: $domname\r\n";
$accnum = $domain->GetAccountCount();
echo "Account count: $accnum\r\n";
$acclist = $domain->GetAccountList();
echo "Account list: $acclist\r\n";
$acc = $domain->GetAccount(0);
echo "First account: $acc\r\n";
echo "\r\n";
?>
Working with Accounts
<?
$account = $domain->OpenAccount($acc);
echo "Loaded account: $acc\r\n";
$accdom = $account->Domain;
echo "Account's domain: $accdom\r\n";
API COM Object 33
34 API Reference
echo "\r\n";
?>
Creating Domain
<?
$domain = $com->NewDomain("test.com");
$domain->SetProperty("D_Description", "Test Domain");
$domain->SetProperty("D_AdminEmail", "[email protected]");
$domain->Save();
?>
Creating Account
<?
$account = $domain->NewAccount("test");
$account->SetProperty("U_Password", "password");
$account->SetProperty("U_Name", "Test");
$account->SetProperty("U_Comment", "Comment");
$account->Save();
?>
List all Accounts in all Domains
<?
$api=new COM("IceWarpCOM.APIObject");
$account=new COM("IceWarpCOM.AccountObject");
$domcount = $api->GetDomainCount();
for ($i=0;$i<$domcount;$i++)
{
$domain_name=$api->GetDomain($i);
API COM Object
if (!$domain_name) break;
printf("%s:", $domain_name);
if ($account->FindInit($domain_name))
{
while ($account->FindNext())
printf(" %s", $account->GetProperty("u_alias") . " " . $account-
>GetProperty("u_name"));
$account->FindDone();
}
printf("\r\n");
}
?>
35
36 API Reference
RPC
If you are a developer and do not wish to use the COM you can use the RPC calls directly without any libraries from IceWarp.
All you need to know is the RPC usage. Read about RPC at
http://www.xmlrpc.com/
The API resides at http://server[:32000]/rpc/ and that is the URL you need to direct the RPC calls to.
There is a special way how to handle API classes over the RPC. See example below:
// The request below creates a new instance of the APIObject on the remote server
// The output will be the instance id of the handle you need to use for subsequent class calls
<?xml version="1.0"?>
<methodCall>
<methodName>0->Create</methodName>
<params>
<param>
<value>IceWarpServer.APIObject</value>
</param>
</params>
</methodCall>
// The call below assumes we already have the class instance which is 123456 from the server and thus
// need to specify it. We call the GetProperty method of the API class and request the c_version property.
<?xml version="1.0"?>
<methodCall>
<methodName>123456->GetProperty</methodName>
<params>
<param>
<value>c_version</value>
</param>
</params>
</methodCall>
RPC 37
38 API Reference
Tool.exe
In This Chapter
Accessing a Remote Server .................................................................... 42
Usage
tool [options] <command> <object> <parameters>
Commands
Command
Create
New
Add
Creates a new object
Options
-r
-p
-f
-q
Modify
Set
Change the properties of an object
Delete
Delete an object
-r
-p
-f
-q
-r
-p
-f
-q
Object
system domain account remoteaccount tables backup system domain account remoteaccount storage system domain account remoteaccount
Parameters
<name>
[<variable1>=<value1>
<variable2>=<value2>
<parameterN>=<valueN>] service connectionstring filename
<name>
[<variable1>=<value1>
<variable2>=<value2>
<parameterN>=<valueN>]
1 (Convert to database Storage)
<name>
Display
Get
List
Display the selected properties of an object
-r
-p
-f
-q
Check
Validate
Check the validity of a user account in accordance with the password policy
Search
Search the API for a string
Upgrade
Upgrade IceWarp
Server’s database to the latest version
Export
Import
Export or Import data to a file
-r
-p
-f
-q
-r
-p
-f
-q
Options
Option
-m (--template=) name tables system domain account remoteaccount service userstatistics account
Tool.exe
service connectionstring
<name>
[<variable1>
<variable2>
<parameterN>] or
<mask> (e.g. * to display all properties and values) fromdate todate filterstring passpolicy
39
string
<old version> domain account remoteaccount backup
<name>
[<variable1>
<variable2>
<parameterN>]
Filename
Function
Applies an object template.
40 API Reference
-r (--remote=) info
-p (--path=) dir
-f (--filter=) value
-m MyTemplate
Connects to a remote server.
r=user,userpw,www.RemoteServer:32001[,"ssl"
]
Path to the server directory.
Filter for objects.
--f="((U_Name like ''John%'')
OR (U_Name like ''George%''))
AND (U_AccountDisabled <> ''0'')"
Runs in quiet mode.
Displays help.
Displays a short tutorial.
Displays tool.exe version.
-q (--quiet)
-h (--help / -?)
-t (--tutorial)
-v (--version)
Parameters
Examples
Create New Domain
tool create domain doe.com d_description "Test domain"
Create Accounts Using Name, Pass and Comment
tool create account [email protected] u_name "John Doe" u_password "john_pass" u_comment
"First test account" tool create account [email protected] u_name "Alex Doe" u_password "alex_pass" u_comment
"Second test account" tool create account [email protected] u_name "Thomas Doe" u_password "tom_pass" u_comment
"Third test account. Tom's first mail account."
Display Comments of All doe.com Accounts
tool display account "*@doe.com" domain u_comment
Tool.exe
Export All Accounts of doe.com Where Comment Contains Word "first" to File doe_com.csv Using --filter Option
tool --filter="u_comment like ''%first%''" export account "*@doe.com" u_name u_password u_comment > doe_com.csv
41
Export All Accounts of doe.com to csv File (base64 Encoded)
tool export account "*@doe.com" u_backup > doe_com.csv
Display Comments of All doe.com Accounts
tool display account "*@doe.com" domain u_comment
Delete All Domain Accounts
tool delete account "*@doe.com"
Import Accounts from File
tool import account "doe_com.cvs" u_name u_password u_comment
Modify Comment of All Accounts @doe.com
tool modify account "*@doe.com" u_comment "Modified comment"
Delete All Accounts of doe.com Domain and Delete doe.com Domain
tool delete account "*@doe.com" tool delete domain "doe.com"
Show some System Variables
tool display system c_system_services_smtp_port c_version c_configpath
Change System Variable
tool modify system c_as_general_enable 1
42 API Reference
Display some Information
tool display service smtp st_runningtime st_serverout st_server tool display userstatistics 2004/10/01 2004/10/31 "*" tool display remoteaccount "*@icewarp.com" ra_server ra_username
Create Remote Account
tool create remoteaccount @doe.com ra_server server.name.com ra_username user_name
Upgrade Database from Version 8.0.3 to Current
tool upgrade 8.0.3
Note: Backup your database before calling this upgrade function.
Display All Domains on Remote Server and its Description
tool -remote="admin,adminspass,remote.server.com:32000" display domain "*"
D_Description
Display Variables of Object
tool search domain
Accessing a Remote Server
tool --remote=<info> [options] <command> <object> <parameters> where <info>=<user>,<pass>,<server:port>[,"ssl"] user = admin username pass = admin password server:port = remote server and port
Using Filters
Usage: tool (--filter|-f)=<conditions> [options] <command> <object> <params>
<conditions are specified using an SQL-like syntax:
--filter="(<variable> like ''<pattern>'') AND (<variable> = ''<value>'')"
Tool.exe 43
Example
tool --filter="((U_Name like ''John%'') OR (U_Name like ''George%'')) AND
(U_AccountDisabled <> ''0'')" get account *@icewarpdemo.com U_Name'
NOTES:
If you are using file-system account storage you can use all API variables.
If you are using database account storage you can only use a subset of the API variables, based on the defined fields in the database.
You cannot use filter for domain variables, only for user variables.
44 API Reference
Command Line Tool
There is a completely new command line tool which you can use to administer domains and accounts as well as all system variables. This tool is called tool.exe and you can find it directly in the
<InstallDirectory>
folder. For Linux this is called tool.sh. It is easy to use and you only have to know the API constants. Complete list of API constants is in APIconst.pas file in the
<InstallDirectory>\API\Delphi\
folder.
NOTE: Using tool.exe for performing large operation can cause temporary service unavailability because the service needs to be restarted for some changes in configuration. For servers with many domains and many users with high load, restarting can take some time. Therefore, we recommend performing large batches of changes in low-load periods.
NOTE: Command line tool does not support multi-line – you can encounter this e.g. using the autoresponder variable.
Command
CREATE
DELETE
MODIFY
DISPLAY
EXPORT
Description
Creates a new object. It is followed by a type (domain or account) and a list of variables and values you want to assign to these variables.
Deletes an object. It is followed by a type (domain or account) and a unique name of object you want to delete.
Modifies any variable (property) of an object. It is followed by a type of object and a list of variables and values you want to assign to these variables.
Displays any variable (property) of an object. It is followed by a type of object (domain, account or system) and a list of variables you want to show. Result is generated with double line feeds.
Does the same as DISPLAY command but this command shows on the screen everything separated by comma (CSV format). Result is generated without double line feeds.
Calls file functions. It is followed by USERSTATISTICS and all its parameters (see below). FILE
Parameter
ACCOUNT [variables]
DOMAIN [variables]
SYSTEM [variables]
Description
Address any account on the server.
Address any domain on the server.
Address any system variable such as c_version, c_name, etc. List is also in APIConst.pas
Command Line Tool 45
BATCH batchfile
USERSTATISTICS fromdate todate filterstring outputfile
Allows you to run a batch file with a set of commands included. See examples below.
Batchfile is just a common text file with commands. Each on a separate line. These commands must not include "tool" at the beginning. Just the commands and parameters.
Saves userstatistics between fromdate and todate to specified output file for all users that fulfill the condition of filterstring. fromdate,todate have yyyy/mm/dd format filterstring supports also asterisks and question marks to specify more accounts. If it does not contain @ symbol it is considered as domain name. outputfile If you do not specify absolute path, it will be saved to <InstallDirectory> folder.
How to create other types of accounts
To do this, you have to use u_type property. Its values are also written in APIConst.pas file. For example mailing list has 1 as a value of this property. So if I want to create mailing list I will have to use this:
tool create account [email protected] u_type 1 m_owneraddress "[email protected]"
Usage
tool create account [email protected] u_name "New Account" u_password "pass" u_accounttype 2
It creates an account with New Account in Full Name field and pass as password.
tool display account [email protected] u_mailbox u_accounttype
It shows you values of both variables u_mailbox and u_accounttype of [email protected] account.
tool delete domain oldone.net
It deletes oldone.net domain from your server.
tool modify account *@icewarpdemo.com u_accounttype 2
It changes all accounts in icewarpdemo.com to IMAP accounts.
tool file userstatistics 2004/12/25 2004/12/31 icewarpdemo.com statistics.txt
It saves userstatistics between dates 2004/12/25 and 2004/12/31 for all accounts in icewarpdemo.com domain to statistics.txt file. This file can be found in <InstallDirectory> folder.
tool export domain * d_description d_postmaster
It shows on the screen d_description and d_postmaster variables for all domains in CSV format - each value is separated by comma.
tool export account *@* u_mailbox u_name u_password > accounts.txt
besides exporting the 3 above fields it also puts user's full email address in first column
tool import account contas.txt u_name u_password
import the 3 fields from CSV
46 API Reference
NOTE: The first field imported from this CSV file is an email address – it is imported automatically and is not to be written in the import command. It has to be specified in CSV in the first place.
tool display system c_config_services_pop3_port
It shows the system variable that contains a POP3 service port.
tool file batch create_mailing.txt
where create_mailing.txt looks like: create account [email protected] u_type 1 m_owneraddress "[email protected]" create account [email protected] u_type 1 m_owneraddress "[email protected]" create account [email protected] u_type 1 m_owneraddress "[email protected]"
It creates three mailing lists defined in create_mailing.txt file.
tool check account *@* passpolicy
It verifies which accounts do not comply with the new password policy.
tool check account *@* passpolicy > <filename>
It redirects to a file.
Example:
tool check account *@* passpolicy>outofpolicy.txt
tool display account @*@ > accounts.txt
gets a listing of accounts with double line feeds
tool export account *@* > accounts.txt
gets listing with single line feeds
Sendmail.exe
This tool (located in the installation directory) is used for sending email messages via command line. It can be used in a batch file.
Syntax Examples
1.
sendmail.exe < messagefile.imap
It reads the headers from the file and then sends it to the proper recipient(s)
2.
sendmail.exe [email protected] [email protected]
Interactive mode – you can compose a message. The mail
FROM:
header will read
[email protected],
the
RCPT TO: one will read
[email protected].
3.
sendmail.exe -F fullname -f [email protected] [email protected] < message_file
Config.exe
Message file have to be placed in the same directory as sendmail.exe.
The tool has following switches:
-F fullname – sets the full name of the sender
-f name – sets the name of the 'from' person (mail
From:
)
-i – Ignore dots alone on lines (in Interactive mode - it doesn't end the input by "." on a line by itself)
-t – Read message for recipients
E. g.:
sendmail.exe -F Flavio -f [email protected] [email protected] < teste.tmp
A message included in the
teste.tmp
file is sent to
[email protected]
with sender's full name of
Flavio
and the mail
From:
header of
[email protected].
47
Config.exe
This is a tool that enables the administrator to remotely access the server to configure basic settings.
You can run multiple instances of Config.exe allowing you to compare settings on different servers. All you need to install on the machine you are connection from is the Remote Administration Console, or Remote Config. Simply unzip it to any directory and you can access a remote IceWarp Server by launching the config.exe program.
Command Line Use
You can use command line parameters for Config.exe:
Parameter
/dnstool
/sqlmanager
/bookmark=<server>
/ftpsync=<item_no>
/forceconnect=ID
Description
Launches the console and opens the DNS Tool dialog.
Launches the console on the SQL Manager tab.
Launches the console and connects it with the specified server.
Launches FTP synchronization. (E. g.
/ftpsync=7
)
Launches the console and connects it with the server defined by its ID. The QuickID is meant here. See Bookmarks Manager – QuickID.
48 API Reference
API Variables
This section lists all the available API variables.
These variables can be used either with the tool.exe command line tool or directly for API programming.
In This Chapter
Function Result Codes
Variable Name
S_OK
E_FAILURE
E_LICENSE
E_PARAMS
E_PATH
E_CONFIG
E_PASSWORD
E_CONFLICT
E_INVALID
Type Description
Function Successful
Function failure
Insufficient license
Size of parameters too short
Configuration not found
Password policy
Item already exists
Item already exists
Configuration
Version & License
Variable Name
C_Version
C_Date
C_Backup
C_OS
C_TimeZone
C_SuiteType
C_InstallPath
C_ConfigPath
C_WebPath
C_SpamPath
C_CalendarPath
C_PathServiceID
C_GUI_RequireAuth
C_GUI_SafeConfirm
C_License_XMLFile
C_License
C_Reference
C_OnlineLicense
API Variables 49
Int
Int
Bool
String
String
String
String
String
String
String
String
String
String
Bool
Type
String
String
String
Bool
Description
Server version
Server release date
Server OS version
0 - Windows
1 - Linux
Time zone in seconds
IceWarp Email Server license type
1 - Pro
2 - Standard
3 - Lite
NOTE: Deprecated.
IceWarp Email Server installation path
Path to Config folder
Require authentification to access Admin console
Use Safe confirmation
XML license
Server license (read/export and add new license)
Server refefence key
Retrieve online license using orderid
50 API Reference
Domains
Domain
Variable Name
D_Description
D_Type
D_DomainValue
D_VerifyType
D_PostMaster
D_AdminEmail
D_UnknownUsersType
D_UnknownForwardTo
D_InfoToAdmin
Limits
Variable Name
D_AccountNumber
D_DiskQuota
D_VolumeLimit
D_NumberLimit
D_DisableLogin
Type
String
Int
String
Int
String
String
Int
String
Bool
Description
Domain description
Domain Type
0 - Standard domain
1 - ETRN/ATRN queue
2 - Domain Alias
3 - Backup domain
4 - Distributed domain
Domain Type To value
User verification mode
0 - Default
1 - Issue RCPT
2 - Issue VRFY
Default Administrator's alias
Administrator's email
Unknown users action
0 - Reject
1 - Forward to address
2 - Delete
Unknown users Forward to Address
Send information to administrator 0
Type
Int
Int
Int
Int
Bool
Description
Domain Admin account limit
Domain disk quota (kB)
Limit of data sent from domain per day
Limit of emails sent from domain per day
Disable login to this domain 0
D_UserMailbox
D_UserMsg
D_UserMB
D_UserNumber
D_Expires
D_ExpiresOn
D_NotifyExpire
D_NotifyBeforeExpires
D_DeleteExpired
Options
Variable Name
D_IPAddress
D_Hostname
D_Folderpath
D_AVScan
D_AntiSpam
<BAC998XY> quarantine?
D_IM
D_Calendar
D_SyncML
D_SIP
D_ChallengeResponse
D_Backup
D_RulesContentXML
Int
Int
Int
Int
Bool
Int
Bool
Int
Bool
User Mailbox size (kB)
User max message size (kb)
User send out data limit (MB/day)
User send out messages limit (#/day)
Enable domain expiration 0
Domain Expires On (Date)
Enable Notify before expiration 0
Notify before expiration (Days)
Delete Expired domains 0
API Variables 51
Type
Bool
Bool
Bool
String
String
String
String
String
Bool
Bool
Bool
Bool
Description
Hostname
Folder path
Access mode - AV
Access mode - Antispam
THIS WAS CHALLENGE RESPONSE?
Access mode - IM
Access mode - GW
Access mode - SyncML
Access mode - SIP
Access mode - Challenge Response
Structure backup
52 API Reference
Accounts
Accounts, Shared
Variable Name
U_Type
Type
Int
String
String
String
Bool
Bool
Description
Account type
0 - User
1 - Mailing list
2 - Executable
3 - Notification
4 - Static Route
5 - Catalog
6 - List server
7 - User group
Account's alias
Account's full name/description
Structure backup
Non user account antispam access
Non user account quarantine access
U_Alias
U_Name
U_Backup
U_NonUserAS
U_NonUserQA
User Account
Read-only Variables
Variable Name
U_QuarantineSupport
U_ASSupport
U_SpamFolderSupport
U_SIPSupport
U_AVSupport
U_IMSupport
Type
Bool
Bool
Bool
Bool
Bool
Bool
Description
Read only variable to check if the user has quarantine enabled
Read only variable to check if the user has antispam enabled
Read only variable to check if the user has spam folder enabled
Read only variable to check if the user has SIP enabled
Read only variable to check if the user has IceWarp Anti-
Virus enabled
Read only variable to check if the user has instant messaging enabled
U_GWSupport
U_SyncMLSupport
User
Variable Name
U_EmailAlias
U_PhoneAlias
U_Mailbox
U_Password
U_AuthMode
U_AuthModeValue
U_Comment
U_AccountType
U_Admin
U_DomainAdmin
U_ForwardTo
U_GW_DailyAgenda
U_GW_Reminders
Mailbox
Variable Name
U_MailBoxPath
U_FullMailboxPath
U_UseRemoteAddress
Bool
Bool
API Variables
Read only variable to check if the user has GroupWare enabled
Read only variable to check if the user has syncML enabled
53
Type
String
String
String
String
Int
String
String
Int
Bool
Bool
String
Bool
Bool
Description
Email alias
Phone alias
Username
Password
Authentication mode
0 - Standard
1 - NT domain
2 - Active Directory
3 - Any password
Authentication mode value
User comment
Mailbox protocol type
0 - POP3
1 - IMAP & POP3
2 - IMAP
Administrator permissions 0
Domain administrator permissions 0
Forward to address
Sending of daily agenda to a user
Sending of reminders to a user
Type
String
String
Bool
Description
Mailbox path
Full mailbox path
Mailbox local/remote
0 - Local mailbox
54 API Reference
U_RemoteAddress
U_NULL
U_DeleteOlder
U_DeleteOlderDays
U_ForwardOlder
U_ForwardOlderDays
U_ForwardOlderTo
U_MailIn
U_MailOut
U_AlternateEmail
Limits
Variable Name
U_MaxBox
U_MaxBoxSize
U_MaxMessageSize
U_MegabyteSendLimit
U_NumberSendLimit
U_AccountDisabled
U_InactiveFor
U_AccountValid
U_AccountValidTill
U_ValidityReport
U_ValidityReportDays
U_DeleteExpire
U_ValidReport
String
Bool
Bool
Int
Bool
Int
String
String
String
String
1 - Remote address
Remote address
Null account 0
Enable Delete messages older than 0
Delete messages older than (Days)
Enable Forward messages older than 0
Forward messages older than (Days)
Forward messages older then x to address
Copy incoming email address
Copy outgoing email address
Alternate email
Type
Bool
Int
Int
Int
Int
Int
Int
Bool
Int
Bool
Int
Bool
String
Description
Enable mailbox size limit 0
Mailbox size limit (kB)
User max message size (kB)
Send out data limit (MB/day)
Send out messages limit (#/day)
Account state
0 - Enabled
1 - Disabled (Login)
2 - Disabled (Login, Receive)
3 - Disabled (Tarpitting)
Expires if inactive for (Days)
Enable Expires on 0
Expires on (Date)
Enable Notify before exiration 0
Notify before expiration (Days)
Delete account when expired 0
Notification file
Options
Variable Name
U_SMTP
U_POP3IMAP
U_WebMail
U_AVScan
U_AS
U_Quarantine
U_IM
U_GW
U_SyncML
U_SIP
U_QuarantineReports
U_SpamFolder
U_SpamAdmin
U_ETRN
U_XEnvelopeTo
U_NoMailList
U_LocalDomain
Responder
Variable Name
U_Respond
API Variables 55
Type
Bool
Bool
Bool
Bool
Bool
Int
Bool
Bool
Bool
Bool
Bool
Int
Bool
Bool
Bool
Bool
Bool
Description
Access mode - SMTP 1
Access mode - IMAP & POP3 1
Access mode - Webmail 1
Access mode - AV 1
Access mode - AntiSpam 1
Access mode - Challenge response 1
Access mode - IM 1
Access mode - GroupWare 1
Access mode - SyncML 1
Access mode - SIP 1
0 - Disabled
1 - Default
2 - New Items only
3 - All items
Spam folder mode
0 - Default
1 - Do not use Spam folder
2 - Use Spam folder
Spam administrator 0
ETRN/ATRN account 0
Add X-Envelope-To header to all messages 0
No mailing lists 0
Setting this to 1 will have the effect of removing this
User account from any Mailing list where it not explicitly specified as a member.
For example, if this user is a Domain Admin and a
Mailing List has been setup for "Domain Admins" then this user is included unless this variable is set to 1.
User can send to local domains only 0
Type
Int
Description
Autoresponder mode
56 API Reference
U_RespondPeriod
U_RespondWith
U_ReplyFrom
U_RespondBetweenFrom
U_RespondBetweenTo
U_RespondOnlyIfToMe
U_ResponderContent
B&W List
Variable Name
U_BlackWhiteFilter
U_RulesContentXML
U_IMAPMailbox
U_PasswordExpired
U_MailboxQuota
U_MailboxSize
Group Account
Group
Variable Name
G_Name
G_Description
G_GroupwareShared
G_GroupwareDefaultRights
G_GroupwareMailDelivery
G_GroupwareMembers
Int
String
String
String
String
Bool
String
0 - Do not respond
1 - Respond always
2 - Respond once
3 - Respond once in period
Responder period (Days)
Responder file
Reply from
Responder active from (Date)
Responder active till (Date)
Reply only if to me 0
Auto responder content
Type
Bool
String
String
Bool
Int
Int
Description
Use B&W list 0
Rules content xml
IMAP mailbox settings
Type
String
String
Bool
String
Bool
Bool
Description
Folder name
Description
GroupWare shared
GroupWare default rights
GroupWare mail delivery
GroupWare members address book
Members
Variable Name
G_ListFile
Options
Variable Name
G_Moderated
G_ModeratedPassword
G_AVScan
G_AS
G_QA
U_GW_DailyAgenda
U_GW_Reminders
Rules
Variable Name
G_BlackWhiteFilter
Mailing List Account
Mailing List
Variable Name
M_Alias
M_Name
M_OwnerAddress
M_SendAllLists
Type
String
Description
List file
Type
Int
String
Bool
Bool
Bool
Bool
Bool
Description
Moderated mode
0 - None
1 - Client moderated
2 - Server moderated
Password
Access mode - AntiVirus 1
Access mode - Antispam
Access mode - Quarantine
Sending of daily agenda to group members
Sending of reminders to group members
Type
Bool
Description
Use B&W list 0
Type
String
String
String
Int
Description
Alias
Description
Owner address
Members source
0 - List file
1 - All current domain users
API Variables 57
58 API Reference
M_ListFile
M_ODBC
M_SQL
Message
Variable Name
M_SetSender
String
String
String
2 - All system users
3 - All domain administrators
4 - All system administrators
5 - Members from ODBC
Path to list file
ODBC connection
DSN,user,pwd,server,type
SQL statement
M_SetValue
M_ValueMode
M_HeaderValue
FromValue|ReplyToValue
M_SeparateTo
M_AddToSubject
M_AddToHeader
M_ListSender
M_HeaderFile
M_FooterFile
Type
Int
Int
Bool
String
Bool
String
String
Int
String
String
Description
Set From or Reply-to headers to sender
0 - Off
1 - Set From: to sender
2 - Set Reply-To: to sender
Set From or Reply-to headers to value
0 - Off
1 - Set From: to value
2 - Set Reply-To: to value
Order of "header value" mode
0 - From: header set to value
1 - Reply To: header set to value
From or Reply-to headers value
Set Recipients to To: header 1
Add to Subject value
Add headers value
Originator
0 - Blank
1 - Sender
2 - Owner
Header file
Footer file
Security
Variable Name
M_MembersOnly
M_Moderated
M_ModeratedPassword
M_AllowSubscribers
M_DefaultRights
M_MaxList
M_MaxListSize
M_MaxMembers
M_DenyEXPNList
M_AVScan
M_AS
M_QA
Options
Variable Name
M_SendToSender
M_CopyToOwner
M_DigestConfirmed
M_ListSubject
M_Personalized
M_RemoveDead
M_ListBatch
M_NotifyJoin
M_NotifyLeave
M_SubListFile
M_LeaveFile
Type
Bool
Int
Bool
Int
Int
Bool
Bool
Bool
Bool
String
String
Int
Description
Only members can post new messages 0
Moderated mode
0 - None
1 - Client moderated
2 - Server moderated
Moderated password
Allow subscribers file
Default rights
0 - Receive & post
3 bits - 1st (Receive), 2nd (Post), 3rd (Digest)
Enable Maximum message size 0
Maximim message size value (kB)
Max members
Deny EXPN 0
Access mode - Antivirus 1
Access mode - Antispam
Access mode - Quarantine
API Variables 59
Type
Bool
Bool
Byte
Bool
Bool
Bool
Int
Bool
Bool
String
String
Description
Send copy to Sender 1
Forward copy to owner 0
Digest mailing list 0
Relay local messages
Process mailing list variables 0
Personalized mailing list 0
Remove dead email addresses 0
Max # of messages sent out in 1 minute
Notify owner - Join 0
Notify owner - Leave 0
Join file
Leave file
60 API Reference
Rules
Variable Name
M_BlackWhiteFilter
List Server Account
List Server
Variable Name
L_Alias
L_Name
L_OwnerAddress
L_SendAllLists
L_ListFile
L_DigestConfirmed
L_ListSubject
M_JoinR
M_LeaveR
M_ListsR
M_WhichR
M_ReviewR
M_VacationR
M_WLR
M_BLR
M_DeliverExternally
Type
Bool
Description
Use B&W list 0
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Type
String
String
String
Int
String
Byte
Description
Alias
Description
Owner address
Members source
0 - List file
1 - All domain mailing lists
Path to list file
Subscription
0 - No confirmation
1 - User confirmation
2 - Owner confirmation
Commands in subject 1
Join right 1
Leave right 1
Lists right 1
Which right 1
Review right 1
Vacation right 1
Whitelist right 1
Blacklist right 1
Deliver externally 1
Lists
Variable Name
M_ListServer
Options
Variable Name
L_Moderated
L_ModeratedPassword
M_HelpFile
L_ListSender
L_MaxList
L_AVScan
L_AS
L_QA
Rules
Variable Name
L_BlackWhiteFilter
Executable Account
Executable
Variable Name
E_Alias
E_Name
E_Application
E_ExecType
Type
Bool
Description
List server vs mailing list 1
Type
Bool
String
String
Int
Bool
Bool
Bool
Bool
Description
Moderated list server 0
Moderated password
List server help file
Originator
0 - Blank
1 - Sender
2 - Owner
Suppress command responses 0
Access mode - Antivirus 1
Access mode - Antispam
Access mode - Quarantine
Type
Bool
Description
Use B&W list 0
Type
String
String
String
Int
Description
Alias
Description
Application
Application type
0 - Executable
API Variables 61
62 API Reference
E_Parameters
E_ExecPass
E_ExecForwardCopy
E_AVScan
E_AS
E_QA
Rules
Variable Name
E_BlackWhiteFilter
Remote Account
Remote Account
Variable Name
RA_Enabled
RA_Name
RA_Server
RA_IMAP
RA_UserName
RA_Password
RA_APOP
RA_TLSSSL
String
String
String
Bool
Bool
Bool
1 - StdCall library
2 - Cdecl library
3 - URL
Application parameters
Password
Forward to address
Access mode - Antivirus 1
Access mode - Antispam
Access mode - Quarantine
Type
Bool
Description
Use B&W list 0
Type
Bool
String
String
Bool
String
String
Bool
Int
Description
Is this Account Active
0 - No
1 - Yes
Name
Server
Server type
0 - POP3
1 - IMAP
Username
Password
Logging using APOP 0
TLS/SSL
0 - Detect TLS/SSL
1 - Direct TLS/SSL
RA_ForwardTo
RA_Schedule
Options
Variable Name
RA_NotifyAdmin
RA_Dedupe
RA_LeaveMessagesOnServer
RA_DeleteOlder
RA_DeleteCount
RA_ExtraForward
RA_ConvertDomains
RA_Routing
DomainPop
Variable Name
RA_DomainPOP
RA_NoReceived
RA_ReceiveAll
RA_XEnvelopeTo
RA_NoNames
RA_MatchEmail
RA_DomainString
RA_LeaveMessageFile
RA_Backup
String
????
2 - Disable TLS/SSL
Forward to address
Schedule Remote account schedule
Type
Bool
Bool
Bool
Bool
Int
String
Bool
Bool
Description
Notify administrator of session problems
Dedupe collected emails 0
Leave messages on server 0
Delete messages older than (Days)
Delete if more than (Messages)
Forward extra copy to address
Convert domain names 0
Email address routing 0
API Variables 63
Type
Bool
Bool
Bool
Bool
Bool
String
String
String
String
Description
Domain POP 0
Do not processed Received: header 0
Stop parsing if Received: yields a local address 0
Parse these headers 0
Real name address matching 0
If email:
Domain it belongs to
Path to file to keep uids
Structure backup
64 API Reference
Static Route Account
Static Route
Variable Name
R_Alias
R_Name
R_Activity
R_ExternalDomain
R_ActivityValue
R_SaveTo
R_ExternalFilter
R_FilterFile
R_ExternalFilterFile
R_ExternalFilterType
Type
String
String
Int
Bool
String
String
Int
String
String
Int
Description
Alias
Description
Action
0 - Forward to address
1 - Forward to domain
2 - Forward to host
3 - Delete
4 - Deliver to this domain
Forward
Value
Forward to address
Service access??
Filter
0 - Filter
1 - External
2 - All
Filter file
External filter file
External filter type
0 - StdCall library
1 - Cdecl library
2 - Executable
3 - URL
Notification Account
Notification
Variable Name
N_Alias
N_Name
Type
String
String
Description
Alias
Description
N_NotifyTo
N_IMNotification
N_Size
N_Count
N_FilterType
N_Send
N_FilterFile
Options
Variable Name
N_IntoSubject = $A1;
N_SendTo
N_SendFrom
N_SendSubject
N_SendDateTime
N_SendBody
N_From
N_Subject
N_Body
N_File
N_ForwardCopy
N_Sender
N_AVScan
N_AS
N_QA
String
Bool
Int
Int
Int
Bool
String
Notify to:
IM notification
Max message size (Bytes) 128
Split to multiple messages (Messages) 1
Filter
0 - All
1 - None
2 - Filter
Send 0
Filter file path
API Variables 65
Type
Bool
String
String
String
String
String
Int
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Description
Insert information into subject 1
Insert To: header 0
Insert From: header 0
Insert Subject 1
Insert Date/Time 0
Insert Body 1
From:
Subject
Body
Text file
Forward to:
Originator
0 - Empty
1 - Sender
2 - Owner
Access mode - Antivirus 1
Access mode - Antispam
Access mode - Quarantine
66 API Reference
Rules
Variable Name
N_BlackWhiteFilter
Catalog Account
Catalog
Variable Name
T_Alias
T_Name
T_CatalogPass
T_CatalogSubject
T_CatalogFile
Options
Variable Name
T_CatalogGet
T_CatalogDir
T_CatalogSendTo
T_CatalogSender
T_AVScan
T_AS
T_QA
Rules
Variable Name
T_BlackWhiteFilter
Type
Bool
Description
Use B&W list 0
Type
String
String
String
Bool
String
Description
Alias
Description
Password
Commands in subject 1
Catalog file
Type
Bool
Bool
Bool
Int
Bool
Bool
Bool
Description
Get right 1
Dir right 1
SendTo right 1
Originator
0 - Empty
1 - Sender
2 - Owner
Access mode - Antivirus 1
Access mode - Antispam
Access mode - Quarantine
Type
Bool
Description
Use B&W list 0
Global Settings
Accounts
Variable Name
C_Accounts_Global_Accounts_Maint enanceLog
Type
Bool
Description
Maintenance log
API Variables 67
Domains
Variable Name
C_Accounts_Global_Domains_UseDiskQuota
C_Accounts_Global_Domains_UseDomainLimits
C_Accounts_Global_Domains_UseUserLimits
C_Accounts_Global_Domains_UseExpiration
C_Accounts_Global_Domains_OverrideGlobal
C_Accounts_Global_Domains_DomainKeys
C_Accounts_Global_Domains_Literals
C_Accounts_Global_Domains_Hostname
C_Accounts_Global_Domains_IPAddress
C_Accounts_Global_Domains_WelcomeMsgs
C_Accounts_Global_Domains_WarnMailboxUsage
C_Accounts_Global_Domains_WarnDomainSize
C_Accounts_Global_ActiveDirectorySyncInterval
Type
Int
Int
Int
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Advanced
Variable Name
C_Accounts_Global_LDAP_Synchronize
C_Accounts_Global_LDAP_Host
C_Accounts_Global_LDAP_Base
C_Accounts_Global_LDAP_User
C_Accounts_Global_LDAP_Pass
C_Accounts_Global_Console_ShowAccounts
Description
Use Domain disk quota 0
Use Domain limits 0
Use Domain user limits 0
Use Domain expiration 0
Override global limits 0
Enable DomainKeys support 0
Enable Domain literals 0
Use domain hostnames for outgoing msgs 0
Use domain IP address for outgoing msgs 0
Use Welcome messages 0
Warn when mailbox size exceeds (%)
Warn when domain size exceeds (%)
Minutes interval
Type
Bool
String
String
String
String
Int
Description
LDAP user synchronization 0
Number of shown accounts in a domain
68 API Reference
C_Accounts_Global_Console_AccountsPosition
C_Accounts_Global_Console_DomainDescription
Int
Int
1000
Database account display start position 0
Domain list display mode
0 - Domain
1 - Description + Domain
2 - Domain + Description
Policies
Login Policy
Variable Name
C_Accounts_Policies_Login_Enable
C_Accounts_Policies_Login_Attempts
C_Accounts_Policies_Login_BlockPeriod
C_Accounts_Policies_Login_Block
C_Accounts_Policies_Login_LoginSettings
Type
Bool
Int
Int
Bool
Bool
C_Accounts_Policies_Login_ConvertChars
C_Accounts_Policies_Login_IPRestriction
C_Accounts_Policies_Login_RevealPasswords
C_Accounts_Policies_Login_DisableDomainIPLogin
C_Accounts_Policies_SuperUser
C_Accounts_Policies_SuperUserPassword
C_Accounts_Policies_Login_AuthWISIDDisable
Password Policy
Variable Name
C_Accounts_Policies_Pass_Enable
C_Accounts_Policies_Pass_UserAlias
C_Accounts_Policies_Pass_Encrypt
C_Accounts_Policies_Pass_MinLength
Bool
Bool
Bool
Bool
Bool
String
Bool
Type
Bool
Bool
Bool
Int
Description
Enable Login policy 0
Number of failed logins
Block user login for (Min)
0 - Do not block but delay authentication
1 - Block account for specified time
Login settings mode
0 - login with username
1 - login with full email address
Convert chars %/ to @ in username 0
Enables account IP restriction
Description
Enable Password policy 0
Check password against username/alias 0
Password database encryption 0
Min password length
C_Accounts_Policies_Pass_Digits
C_Accounts_Policies_Pass_NonAlphaNum
C_Accounts_Policies_Pass_Alpha
C_Accounts_Policies_Pass_Expiration
C_Accounts_Policies_Pass_ExpireAfter
C_Accounts_Policies_Pass_DenyExport
C_Accounts_Policies_Pass_AllowAdminPass
System
System Services
SMTP Service
Variable Name
C_System_Services_SMTP_Port
C_System_Services_SMTP_SSLPort
C_System_Services_SMTP_AltPort
C_System_Services_SMTP_Traffic
C_System_Services_SMTP_IPList
C_System_Services_SMTP_AccessMode
C_System_Services_SMTP_ThreadCache
C_System_Services_SMTP_MonitorData
C_System_Services_SMTP_MonitorConn
C_System_Services_SMTP_MaxInConn
C_System_Services_SMTP_MaxOutConn
C_System_Services_SMTP_Bandwidth
POP3 Service
Variable Name
C_System_Services_POP3_Port
C_System_Services_POP3_SSLPort
Int
Int
Int
Bool
Int
Bool
Bool
API Variables
Number of numeric chars in password
Number of non alphanumeric characters
Number of alpha characters
Enable password expiration 0
Expire after (Days)
Passwords cannot be read or exported 0
Allow Admin's password to be exported 0
69
Int
Int
Int
Int
Int
Int
Type
Int
Int
Int
Bool
String
Bool
Description
SMTP service port 25
SMTP service SSL port 465
SMTP service alternative port 366
Enable SMTP traffic logs 1
List of Denied/Granted IPs
Service access mode
0 - Deny
1 - Grant
SMTP service Thread cache 40
Monitor increased traffic
Monitor number of increased connections
Max number of Incoming connections 256
Max number of Outgoing connections 256
Max transfer bandwidth (kB/s) 0
Type
Int
Int
Description
POP3 service port 110
POP3 service SSL port 995
70 API Reference
C_System_Services_POP3_Traffic
C_System_Services_POP3_IPList
C_System_Services_POP3_Accessmode
C_System_Services_POP3_ThreadCache
C_System_Services_POP3_MaxInConn
C_System_Services_POP3_MaxOutConn
C_System_Services_POP3_Bandwidth
C_System_Services_POP3_MonitorData
C_System_Services_POP3_MonitorConn
IMAP Service
Variable Name
C_System_Services_IMAP_Port
C_System_Services_IMAP_SSLPort
C_System_Services_IMAP_Traffic
C_System_Services_IMAP_ThreadCache
C_System_Services_IMAP_MaxInConn
C_System_Services_IMAP_MaxOutConn
C_System_Services_IMAP_Bandwidth
C_System_Services_IMAP_IPList
C_System_Services_IMAP_Accessmode
C_System_Services_IMAP_MonitorData
C_System_Services_IMAP_MonitorConn
C_System_Services_IMAP_FileNameFlags
Web / Control Service
Variable Name
C_System_Services_Control_Port
C_System_Services_Control_SSLPort
C_System_Services_Control_Traffic
C_System_Services_Control_IPList
Int
Int
Int
Int
Int
Int
Bool
String
Bool
Enable SMTP traffic logs 1
List of Denied/Granted IPs
Service access mode 0
0 - Deny
1 - Grant
POP3 service thread cache 40
Max number of Incoming connections 256
Max number of Outgoing connections 1
Max transfer bandwidth (kb/s) 0
Monitor increased traffic
Monitor number of increased connections
Type
String
Bool
Int
Int
Bool
Int
Int
Bool
Int
Int
Int
Int
Description
IMAP service port 143
IMAP service SSL port 993
Enable IMAP traffic logs 1
IMAP service thread cache 40
Max number of Incoming connections 256
Max number of Outgoing connections 1
Max transfer bandwidth (kB/s) 0
List of Denied/Granted IPs
Service access mode 0
Monitor increased traffic
Monitor number of increased connections
Type
Int
Int
Bool
String
Description
Control service port 32000
Control service SSL port 32001
Enable Control traffic logs 1
List of Denied/Granted IPs
C_System_Services_Control_AccessMode
C_System_Services_Control_ThreadCache
C_System_Services_Control_MaxInConn
C_System_Services_Control_Bandwidth
C_System_Services_Control_MonitorData
C_System_Services_Control_MonitorConn
FTP Service
Variable Name
C_System_Services_FTP_Port
C_System_Services_FTP_SSLPort
C_System_Services_FTP_Traffic
C_System_Services_FTP_IPList
C_System_Services_FTP_AccessMode
C_System_Services_FTP_ThreadCache
C_System_Services_FTP_MaxInConn
C_System_Services_FTP_MaxOutConn
C_System_Services_FTP_Bandwidth
C_System_Services_FTP_MonitorData
C_System_Services_FTP_MonitorConn
GroupWare Service
Variable Name
C_System_Services_GW_Port
C_System_Services_GW_Traffic
C_System_Services_GW_IPList
C_System_Services_GW_AccessMode
Int
Int
Int
Int
Int
Bool
API Variables
Service access mode
0 - Deny
1 - Grant
Control service Thread cache 40
Max number of Incoming connections 256
Max transfer bandwidth (kB/s) 0
Monitor increased traffic
Monitor number of increased connections
71
Int
Int
Int
Int
Int
Int
Type
Int
Int
Bool
String
Bool
Description
FTP service port 21
FTP service SSL port 990
Enable FTP traffic logs 1
List of Granted/Denied IPs
Service access mode
0 – Deny
1 - Grant
Service thread cache 40
Max number of Incoming connections 256
Max number of Outgoing connections 256
Max transfer bandwidth (kB/s) 0
Monitor increased traffic
Monitor number of increased connections
Type
Int
Bool
String
Bool
Description
GW service port 5229
Enable GW traffic logs 1
List of Denied/Granted IPs
Service access mode
0 - Deny
1 - Grant
72 API Reference
C_System_Services_GW_ThreadCache
C_System_Services_GW_MaxInConn
C_System_Services_GW_Bandwidth
C_System_Services_GW_MonitorData
C_System_Services_GW_MonitorConn
C_System_Services_SyncML_AccessMode
C_System_Services_SyncML_AccessGroup
Instant Messaging Service
Variable Name
C_System_Services_IM_Port
C_System_Services_IM_SSLPort
C_System_Services_IM_AltPort
C_System_Services_IM_Traffic
C_System_Services_IM_IPList
C_System_Services_IM_AccessMode
C_System_Services_IM_ThreadCache
C_System_Services_IM_MaxInConn
C_System_Services_IM_Bandwidth
C_System_Services_IM_MonitorData
C_System_Services_IM_MonitorConn
LDAP Service
Variable Name
C_System_Services_LDAP_Enable
C_System_Services_LDAP_Port
C_System_Services_LDAP_SSLPort
C_System_Services_LDAP_MaxInConn
C_System_Services_LDAP_Bandwidth
Int
Int
Int
Int
Int
Bool
String
GW service Thread cache 40
Max number of Incoming connections 256
Max transfer bandwidth (kB/s) 0
Monitor increased traffic
Monitor number of increased connections
Service access mode 0
Int
Int
Int
Int
Int
Type
Int
Int
Int
Bool
String
Bool
Description
IM service port 5222
IM service SSL port 5223
IM service alternative port 5269
Enable IM traffic logs 1
List of Granted?Denied IPs
Service access mode
0 - Deny
1 - Grant
Service thread cache 40
Max number of Incoming connections 256
Max transfer bandwidth (kB/s) 0
Monitor increased traffic
Monitor number of increased connections
Type
Bool
Int
Int
Int
Int
Description
Enable LDAP service 0
LDAP service port 389
LDAP service SSL port 636
Max number of Incoming connections 256
Max transfer bandwidth (kB/s) 0
System Logging
General
Variable Name
C_System_Logging_General_AppendFiles
C_System_Logging_General_DeleteOlder
C_System_Logging_General_Archive
C_System_Logging_General_ArchiveTo
C_System_Logging_General_LogCache
C_System_Logging_General_LogRotation
C_System_Logging_General_SystemLogFunction
C_System_Logging_Syslog_Active
C_System_Logging_Syslog_Server
C_System_Logging_General_EnableODBCLog
C_System_Logging_General_ODBCLogConn
C_System_Logging_General_LogTimeFormat
C_System_Sessions_DisableHistory
Services
Variable Name
C_System_Log_Services_SMTP
C_System_Log_Services_POP3
C_System_Log_Services_IMAP
Type
Int
Int
Int
Description
SMTP service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
POP3 service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
IMAP service logging level
0 - None
API Variables 73
Type
Bool
String
Bool
String
Int
Bool
Int
Bool
String
Int
Int
Bool
Bool
Description
Append logs to files 1
Delete logs after (Days) 7
Logging cache (B) 0
Size of the log file (kB) 0
Send logs to system log function 0
Send logs to server 0
Syslog server name
Enable ODBC logging
ODBC logging connection
Log time format
0 - sltfTime
1 - sltfScientific
2 - sltfRFC822
Disable session history
74 API Reference
C_System_Log_Services_IM
C_System_Log_Services_GW
C_System_Log_Services_Control
C_System_Log_Services_FTP
C_System_Log_Services_LDAP
C_System_Log_Services_AV
C_System_Log_Services_AS
Int
Int
Int
Int
Int
Int
Int
1 - Debug
2 - Summary
3 - Debug & Summary
IM service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
GW service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
Control service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
FTP service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
LDAP service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
AV logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
AS logging level
0 - None
1 - Debug
API Variables 75
C_System_Log_Services_SIP
C_System_Log_Services_SMS
Int
Int
C_System_Log_Services_SyncMLPush Int
2 - Summary
3 - Debug & Summary
SIP logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
SMS service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
SyncML service logging level
0 - None
1 - Debug
2 - Summary
3 - Debug & Summary
Debug logging - internal usage only C_System_Log_MailQueue
System Tools
System Backup Tool
Variable Name
C_System_Tools_AutoBackup_Enable
C_System_Tools_AutoBackup_BackupTo
C_System_Tools_AutoBackup_Password
C_System_Tools_AutoBackup_Schedule
C_System_Tools_AutoBackup_DeleteAfter
C_System_Tools_IncludeMailDir
C_System_Tools_ExcludeLicense
C_System_Tools_Backup_Emails
C_System_Tools_Backup_SkipLarger
C_System_Tools_Backup_SkipOlder
C_System_Tools_Backup_Dirs
C_System_Tools_Backup_Logs
Bool
Type
Bool
String
String
Int
Bool
Bool
Bool
Int
Int
String
Bool
Description
Enable Auto backup 0
Path to backup file
Password
Schedule Auto backup Schedule
Delete backup file after (Days)
Include mail folder settings to backup 0
Do not include license to backup file 0
Backup emails
Skip emails larger (MB)
Skip emails older (Days)
Additional directories to backup
Backup logs
76 API Reference
Server Watchdog Tool
Variable Name
C_System_Tools_WatchDog_SMTP
C_System_Tools_WatchDog_POP3
C_System_Tools_WatchDog_IM
C_System_Tools_Watchdog_GW
C_System_Tools_Watchdog_Control
C_System_Tools_Watchdog_Int
System Monitor Tool
Variable Name
C_System_Tools_Monitor_Enable
C_System_Tools_Monitor_ReportAddress
C_System_Tools_Monitor_FreeMem
C_System_Tools_Monitor_DiskSize
C_System_Tools_Monitor_CPUUsagePerc
C_System_Tools_Monitor_CPUUsagePeriod
Remote Server Watchdog Tool
Variable Name
C_System_Tools_RemoteServer_Enable
C_System_Tools_RemoteServer_MoreThan
C_System_Tools_RemoteServer_Email
C_System_Tools_RemoteServer_Schedule
C_System_Tools_RemoteServer_NotifyAgain
Type
Bool
Bool
Bool
Bool
Bool
Int
Description
Enable Watchdog for SMTP 0
Enable Watchdog for POP3 0
Enable Watchdog for IM 0
Enable Watchdog for GW 0
Enable Watchdog for Control 0
Watchdog Interval
Type
Bool
String
Int
Int
Int
Int
Description
Enable System monitor 0
Disk monitor report address
Alert if free memory drops below (kB) 0
Alert if free disk space drops below (MB) 0
CPU utilization threshold (%) 0
Alert if CPU usage exceeds threshold for (Min) 0
Type
Bool
Int
String
Bool
Description
Enable Remote server watchdog 0
Server is down if unreachable for (Min) 0
Report Email address
Schedule Remote Server Watchdog Schedule
Notify when server is back online 0
TCP/IP Tunnel Tool
Variable Name
C_System_Tools_Tunnel_Enable
Server Migration Tool
Variable Name
C_System_Tools_Migration_Active
C_System_Tools_Migration_Server
C_System_Tools_Migration_MigrateService
C_System_Tools_Migration_NoXEnvelopeTo
C_System_Tools_Migration_NoReceived
C_System_Tools_Migration_MultiDomain
Statistics
Variable Name
C_System_Tools_Migration_Stat_Start
C_System_Tools_Migration_Stat_TotalUsers
C_System_Tools_Migration_Stat_Users
C_System_Tools_Migration_Stat_Aliases
C_System_Tools_Migration_Stat_Messages
C_System_Tools_Migration_Stat_Last
C_System_Tools_Migration_Stat_Errors
Type
Bool
API Variables 77
C_System_Tools_Migration_InfoAccount
C_System_Tools_Migration_LogFile
C_System_Tools_Migration_MessageProcessType
Type
Bool
String
Int
String
String
Int
Bool
Bool
Bool
Description
Enable Migration 0
Migration source host
Migration service
0 - Both
1 - POP3
2 - IMAP
Migration account
Path to log file
Access mode
0 - Standard
1 - Extended alias resolving
2 - Username
Do not use X-Envelope-To header 0
Do not process received header 0
Multidomain migration 0
Type
Int
Int
Int
Int
Int
Int
Int
Description
Enable TCP/IP tunnel 0
Description
Unix time of start
Total number of migrated mailboxes
Number of migrated mailboxes
Number of migrated aliases
Number of messages migrated
Unix time of last migrated mailbox
Number of migration errors
78 API Reference
System Storage
Accounts
Variable Name
C_System_Storage_Accounts_StorageMode
C_System_Storage_Accounts_ProModeCache
C_System_Storage_Accounts_ODBCConnString
C_System_Storage_Accounts_ODBCMultithread
C_System_Storage_Accounts_ODBCMaxThreads
Directories
Variable Name
C_System_Storage_Dir_MailPath
C_System_Storage_Dir_TempPath
C_System_Storage_Dir_LogPath
C_System_Storage_Mailbox_UseSorting
C_System_Storage_Mailbox_PrefixLen
Load Balancing
Variable Name
C_System_Storage_LB_ServerID
C_System_Storage_LB_AutoCheckConfig
C_System_MySQLDefaultCharset
Type
Int
Int
String
Bool
Int
Description
(stProfessional, stFileSystem, stODBC) 1
Accounts storage mode
0 - Professional file system
1 - Standard file system
2 - ODBC
Professional file system memory cache 10
ODBC connection string
Use Multithreaded ODBC 0
Type
String
String
String
Bool
Int
Description
Path to mail folder
Path to temp folder
Path to log folder
Enables mailbox path alphabetical sorting
Number of characters from alias to prefix
Type
String
Bool
String
Description
Server ID
Periodically check if settings have been changed and auto-reloaded 0
Default charset for direct mysql client library - as of v5 the default is latin1 so this needs to be changed to utf8
System Internet Connection
Variable Name
C_System_Conn_Type
C_System_Conn_UpName
C_System_Conn_UpUsername
C_System_Conn_UpPassword
C_System_Conn_UpHangUpAfter
C_System_Conn_UpOlderthan
C_System_Conn_DialOnDemandExceed
C_System_Conn_DialOnDemandHeader
C_System_Conn_Schedule
C_System_Conn_GlobalSchedule
System Advanced
Variable Name
C_System_Adv_Protocols_SessionTimeOut
C_System_Adv_Protocols_ResponseDelay
C_System_Adv_Protocols_MaxBadCommands
C_System_Adv_Protocols_BackLog
C_System_Adv_Protocols_DNSTimeout
C_System_Adv_Protocols_DNSCache
C_System_Adv_Protocols_DNSRetry
C_System_Adv_Protocols_DNSCacheLimit
C_System_Adv_Protocols_IMAPTimeout
C_System_Adv_Ext_DisableSSLTLS
C_System_Adv_Ext_EnableIPv6
C_System_Adv_Ext_ChangePassServer
C_System_Adv_Ext_DaytimeServer
C_System_Adv_Ext_DayTimePort
C_System_Adv_Ext_DisableMultiCPU
API Variables 79
Type
Int
String
String
String
Int
Int
Int
Bool
Description
Connection mode
0 - Network connection
1 - Dial-up
2 - Dial-up on demand router
Connection name
Username
Password
Hang up after (sec)
COnnect if msg waits for more than (Min)
Connect if number of msgs exceeds
Connect if message with this header
Schedule Connection schedule
Schedule Global schedule
Type
Bool
Int
Int
Int
Bool
Bool
Bool
Bool
Int
Bool
Int
Int
Int
Int
Int
Description
Session timeout 300
Protocol response delay 0
Max number of bad commands 8
Listen back logs 5
DNS Timeout 5
Use DNS smart cache 1
DNS retries 1
DNS cache items limit 128
IMAP timeout
Disable SSL/TLS 1
Enable IPv6 Protocol 0
Enable Change password server 0
Enable Daytime server 0
Daytime port
Disable Multiple CPU 1
80 API Reference
C_System_Adv_Ext_SNMPServer
C_System_Adv_Ext_SNMPPort
C_System_Adv_Ext_SocksServer
C_System_Adv_Ext_SocksPort
C_System_Adv_Ext_SSLServerMethod
C_System_Adv_Ext_SSLClientMethod
System Active Directory
Variable Name
C_System_ADSyncLogType
C_System_ADSyncIgnoreSearchError
Bool
Int
Bool
Int
Enable SNMP server
SNMP port
Enable Socks server
Socks port
(Default, smSSLv2_method, smSSLv23_method, smSSLv3_method, smTLSv1_method)
(Default, smSSLv2_method, smSSLv23_method, smSSLv3_method, smTLSv1_method)
C_System_ADSyncMaxDeleteThreshold
SMTP Service
SMTP Service
General
Variable Name
C_Mail_SMTP_General_HostName
C_Mail_SMTP_General_DeliveryMode
C_Mail_SMTP_General_RelayMailServer
Type
Integer
Bool
Integer
Description
AD synchronization logging level. 0 – none, 1 – debug, 2 – summary, 3 – debug & summary.
If AD synchronization search returns error, but still some data returned, by default (
false
), synchronization does not perform any delete operation.
Set to
true
, delete operations are enabled fro these cases.
If set to value greater than 0 (zero), AD synchronization does not perform
any
account delete, if the number should exceed this value.
Type
String
Bool
String
Description
Mailserver hostname
SMTP service delivery mode
0 - Use SMTP relay server
1 - Use DNS lookup
SMTP relay server
C_Mail_SMTP_General_DNSServer
C_Mail_SMTP_Other_Dedupe
C_Mail_SMTP_Other_SearchInLocalDomains
C_Mail_SMTP_Other_HeaderFunctions
C_Mail_SMTP_Other_MaxHopCount
C_Mail_SMTP_Other_MaxRecipients
C_Mail_SMTP_Other_MaxMTARecipients
C_Mail_SMTP_Other_LocalDelivery
C_Mail_SMTP_Other_ExternalDelivery
C_Mail_SMTP_Other_NoRetryQueue
C_Mail_SMTP_Other_BounceBackMode
C_Mail_SMTP_Other_SMTPPipelining
C_Mail_SMTP_Other_SPFSRS
C_Mail_SMTP_Other_SPFSRSKey
C_Mail_SMTP_Other_MailboxSeparator
Delivery
Variable Name
C_Mail_SMTP_Delivery_UseTLSSSL
C_Mail_SMTP_Delivery_RetrySMTP
C_Mail_SMTP_Delivery_LimitMsgSize
C_Mail_SMTP_Delivery_MaxMsgSize
C_Mail_SMTP_Delivery_MXReconnectFailure
C_Mail_SMTP_Delivery_HideIP
C_Mail_SMTP_Delivery_RDNSLookup
C_Mail_SMTP_Delivery_UndelivAfter
C_Mail_SMTP_Delivery_UndelivWarning
C_Mail_SMTP_Delivery_DaemonAlias
C_Mail_SMTP_Delivery_DaemonName
C_Mail_SMTP_Delivery_BadMail
C_Mail_SMTP_Delivery_DoNoTruncate
C_Mail_SMTP_Delivery_InfoToAdmin
C_Mail_SMTP_Delivery_UseIncomingQueue
API Variables
Bool
Bool
Bool
Int
Bool
Bool
String
String
String
Bool
Bool
Bool
Int
Int
Int
DNS servers
Dedupe email messages 0
Search for alias in other local domains 0
Activate message header functions 0
Max SMTP hop count 20
Max SMTP server recipients 32768
Max SMTP client recipients 100
Enable remote delivery from local server 0
Deliver all messages externally 0
Do not queue messages 0
Bounce back mode
Enable SMTP pipelining 0
Enable SRS 0
SRS secret key
Mailbox separator / extension separator (eg: alias:extension@domain)
81
Bool
Bool
Int
Int
String
String
String
Bool
Bool
Bool
Type
Bool
Bool
Bool
Int
Bool
Description
Use TLS/SSL 0
Retry with SMTP when ESMTP failed
Enable Max message size 0
Max message size (B)
Deliver message via relay server when direct delivery fails
Hide IP from received header
Undeliverable after (Minutes) 0
Undeliverable warning (Minutes) 0
Mailer Daemon report alias MAILER-DAEMON
Mailer Daemon report name Mail Delivery
Subsystem
Bad mail address
Do not truncate mailer daemon's msgs 0
Send info to admin 0
Use incoming mail queue
82 API Reference
C_Mail_SMTP_Delivery_IncomingQueueSize
C_Mail_SMTP_Delivery_MDAInternal
C_Mail_SMTP_Delivery_ReturnPath
Header / Footer
Variable Name
C_Mail_SMTP_HeaderFooter_Enable
Int
Bool
Bool
Size of the queue (# threads)
Use MDA queue for internal delivery 0
Add return-path
Type
Bool
Description
Enable Header/Footer 0
SMTP Security
General
Variable Name
C_Mail_Security_Relay_RelayMode
C_Mail_Security_Relay_IPList
C_Mail_Security_Relay_POPSMTP
C_Mail_Security_Relay_POPSMTPInt
C_Mail_Security_Relay_POPSMTPGlobal
C_Mail_Security_Relay_RejectLocalUnauth
DNS
Variable Name
C_Mail_Security_Protection_DNSBL
C_Mail_Security_Protection_CloseDNSBLConn
C_Mail_Security_Protection_RejectrDNS
C_Mail_Security_Protection_RejectMX
C_Mail_Security_Protection_SMTPWait
C_Mail_Security_Protection_LocalDomain
C_Mail_Security_Protection_DomainIPShield
C_Mail_Security_Protection_RejectSMTPAuthSender
Type
Bool
String
Bool
Int
Bool
Bool
Description
Relay mode
0 - Open relay
1 - Close relay
List of relayed IP addresses
Enable POP before SMTP
POP before SMTP interval (Min)
Enable POP before SMTP global mode
Reject if orig's domain is local&unauth 0
Type
Bool
Bool
Bool
Bool
Int
Bool
Bool
Bool
Description
Enable DNSBL 0
Close connection for DNSBL sessions 0
Reject if sender's IP has no rDNS 0
Reject if orig's domain has no MX rec 0
Wait before processing a new conn 0
Relay only if orig's domain's local 0
Use Domain IP shielding 0
Reject if SMTP AUTH different from sender
API Variables
C_Mail_Security_Protection_HELOEHLO
C_Mail_Security_Protection_IgnoreBlankHeloHost
Intrusion Prevention
Variable Name
C_Mail_Security_Tarpit_Enable
C_Mail_Security_Tarpit_Count
C_Mail_Security_Tarpit_Period
C_Mail_Security_Tarpit_RelayTarpit
C_Mail_Security_Tarpit_BlockIP
C_Mail_Security_Tarpit_BlockIPValue
C_Mail_DoNot_Tarpit_IPs
C_Mail_Security_Tarpit_CloseConnection
C_Mail_Security_Tarpit_CrossSession
C_Mail_Security_Tarpit_Msg_Enabled
C_Mail_Security_Tarpit_Msg_Value
C_Mail_Security_Tarpit_Spam
C_Mail_Security_Tarpit_SpamScore
C_Mail_Security_Tarpit_DNSBL
C_Mail_Security_Tarpit_RSET
C_Mail_Security_Tarpit_RSETCount
Advanced
Variable Name
C_Mail_Security_Protocols_DenyESMTP
C_Mail_Security_Protocols_AllowSMTPAuth
C_Mail_Security_Protocols_DenyVRFY
C_Mail_Security_Protocols_DenyEXPN
C_Mail_Security_Protocols_DenyTelnet
Bool
Bool
Require HELO/EHLO 0
Igonore Blank Helo Host
Type
Bool
Int
Int
Bool
Bool
Int
Bool
Int
Bool
Bool
Int
Int
Bool
Bool
Bool
Bool
Description
Enable tarpitting 0
Number of attempts
Tarpitting interval (intrusion prevention)
Tarpit relay rejected IPs 0
Block IPs that establish more than BlockIPValue connections within a minute 0
Number of limited of connections
Do not tarpit IP addresses 0
Close tarpitted connections 0
Cross session processing 0
Tarpit message size
Tarpit message size value
Tarpit spam
Tarpit spam score (* 100)
Tarpit DNSBL
Tarpit RSET
Tarpit RSET count
Type
Bool
Bool
Bool
Bool
Bool
Description
Deny ESMTP protocol 0
Allow SMTP Auth 1
Deny VRFY command 0
Deny EXPN command 0
Deny Telnet access 0
83
84 API Reference
SMTP Filters
Content Filters
Variable Name
C_Mail_Filter_Content_Enable
Rules
Variable Name
C_Mail_Filter_BW_Enable
C_Mail_Filter_RulesContentXML
C_Mail_Filter_MaxThreads
Type
Bool
Type
Bool
String
Int
SMTP Archive
Variable Name
C_System_Tools_AutoArchive_Enable
C_System_Tools_AutoArchive_Path
C_System_Tools_AutoArchive_DeleteOlder
C_System_Tools_AutoArchive_Outgoing
C_System_Tools_AutoArchive_Backup_Active
C_System_Tools_AutoArchive_Backup_DeleteOlder
C_System_Tools_AutoArchive_Backup_File
C_System_Tools_AutoArchive_Backup_Password
C_System_Tools_AutoArchive_Backup_Domains
C_System_Tools_AutoArchive_IMAPArchiveSent
C_System_Tools_AutoArchive_IMAPArchiveInbox
C_System_Tools_AutoArchive_UnknownUsers
Description
Enable Content filters 0
Description
Enable B&W lists 0
Number of filter threads 0
Type
Bool
String
Int
Bool
Int
String
String
Bool
String
String
Bool
Description
Enable Auto archive 0
Auto archive path
Delete archive older than (Days)
(ammIncoming, ammBoth, ammOutgoing)
Backup archive
Delete old archive backups
Archive backup file
Password
Archive specified domains
Archive subfolders rename
Archive subfolders rename
Archive emails for unknown users.
NOTE: Applies only for backup domains or distributed ones, as standard domains do not accept such emails.
SMTP ETRN Download
Variable Name
C_Mail_ETRN_Count
C_Mail_ETRN_Config
C_Mail_ETRN_Schedule
Type
Int
Int
Description
Number of ETRN connections 0
Pointer to ETRN conn configuration
Schedule ETRN Schedule
AntiSpam
AS General
Variable Name
C_AS_General_Enable
C_AS_General_ProcessingMode
Type
Bool
Int
C_AS_General_ProcessingGroup
C_AS_Info_UpdateDate
C_AS_Info_UpdateVersion
C_AS_Info_EngineVersion
C_AS_Info_UpdateSize
C_AS_Info_BayesWords
C_AS_Info_BayesSpamMessages
C_AS_Info_BayesGenuineMessages
String
String
String
String
Int
Int
Int
Int
AS Quarantine
Variable Name
C_AS_Challenge_ProcessingMode
Type
Int
Description
Enable Spam Engine 1
AS access mode bit
0 - All messages
1 - All except selected
3 - Group
5 - Selected domains only
9 - Selected accounts only
Access mode group
Update date
Update version
Engine version
Description
CR access mode bit
0 - All messages
1 - All except selected
API Variables 85
86 API Reference
C_AS_Challenge_ProcessingGroup
C_AS_Challenge_ReportsSchedule
String
Schedule
3 - Group
5 - Selected domains only
9 - Selected accounts only
Access mode group
Anti-Virus
General
Variable Name
C_AV_General_IntegratedAV
C_AV_General_ProcessingMode
C_AV_General_ProcessingGroup
C_AV_General_UpdateType
C_AV_General_UpdateNotWeekdays Int
C_AV_General_UpdateTime Int
C_AV_General_EveryHour
C_AV_General_ActiveUpdate
C_AV_General_ActiveAddress
C_AV_Info_UpdateDate
Int
Bool
String
String
Type
Bool
Int
String
Int
Description
Enable Integrated AV scanner 1
AV access mode - bit based bit
0 - All messages
1 - All except selected
3 - Group
5 - Selected domains only
9 - Selected accounts only
Access mode group
Update Schedule
0 - Disabled
1 - Once at
2 - Every x hours
List of days when server does not check for update bit 1 - Monday ... bit 7 - Sunday
Update time hours - upper byte minutes - lower byte
Check for update every (Hours)
Enable Active Update 0
Deprecated.
Active update email trigger
Deprecated.
Update date
C_AV_Info_UpdateSize
C_AV_Info_UpdateVersion
Action
Variable Name
C_AV_Action_ScanAllParts
C_AV_Action_Mode
Int
String
Update size
Update version
C_AV_Action_CleanInfected
C_AV_Action_InfoToAdmin
C_AV_Action_InfoToRecipient
C_AV_Action_InfoToSender
C_AV_Action_UseQuarantine
C_AV_Action_QuarantineAddress
C_AV_Action_QuarantineMode
Type
Int
Int
Bool
Bool
Bool
Bool
Bool
String
Bool
Description
Scan All message parts
AV Action mode
1 - Reject
2 - Remove infected attachments
3 - Delete
Clean infected messages if possible 0
Notification to Admin 0
Notification to Recipient 0
Notification to Sender 0
Quarantine infected messages 0
Quarantine address/path
Virus Quarantine mode
0 - Quarantine whole infected messages
1 - Quarantine only infected attachments
Filters
Variable Name
C_AV_Filters_BlockFiles
Other
Variable Name
C_AV_Misc_RejectPassProtected
C_AV_Misc_ApplyAsLast
C_AV_Misc_Outgoing
C_AV_Misc_DisableExternalAV
Type
Bool
Type
Bool
Bool
Bool
Bool
Description
Block files with following extensions 0
Description
Reject password protected files 0
Apply antivirus as the last filter 0
Apply antivirus to outgoing messages
Disable External AV 1
API Variables 87
88 API Reference
C_AV_MaxThreads
C_AV_MaxFile
C_AV_Avast
C_AV_Symantec
C_AV_AVG
C_AV_Kaspersky
Int
Int
Int
Int
Int
Int
Max number of concurrent threads 0
Max message size
Avast Antivirus usage
0 - Default
1 - Enabled
2 - Disabled
Symantec Antivirus usage
0 - Default
1 - Enabled
2 - Disabled
AVG Antivirus usage
0 - Default
1 - Enabled
2 - Disabled
Kaspersky Antivirus usage
0 - Default
1 - Enabled
2 - Disabled
Services
Web Service
Variable Name
C_WebService_AppMaxThreads
FTP Service
Variable Name
C_FTPService_Active
Type
Int
Description
Number of web service application threads
Type
Bool
Description
Activate FTP service
GroupWare
Variable Name
C_GW_General_Disable
C_GW_ProcessingMode
C_GW_ProcessingGroup
C_GW_SuperUser
C_GW_SuperPass
SyncML
Variable Name
C_SyncML_Push_Active
C_SyncML_Push_Port
C_SyncML_URL
SMS Service
Variable Name
C_SMSService_Active
C_SMSService_RequireAuth
Type
Bool
Int
String
String
String
Description
Disable GW service 0
GW service access mode bit
0 - All messages
1 - All except selected
3 - Group
5 - Selected domains only
9 - Selected accounts only
Type
Bool
Int
String
Description
Set SyncML PUSH active:
1 = Active
0 = Inactive
Set port for SyncML PUSH
Set URL for SyncML PUSH
Type
Bool
Bool
Description
API Variables 89
90 API Reference
Instant Messaging
General
Variable Name
C_IM_General_Disable
C_IM_General_Redirectunknown
C_IM_General_Anonymous
C_IM_General_FileTransfer
C_IM_General_AccountRegistration
C_IM_General_ServerOSReport
C_IM_ProcessingMode
Type
Bool
Bool
Bool
Bool
Bool
Bool
Int
String
String
String
Description
Disable IM service 0
Redirect unknown domain to local domain 0
Enable Anonymousserver to server communication 0
Enable Server file transfer 0
Enable Account registration 0
Enable Server OS report 0
IM access mode - bit based bit 0
0 - All messages
1 - All except selected
3 - Group
5 - Selected domains only
9 - Selected accounts only
C_IM_ProcessingGroup
C_IM_EmailTransportNode
C_IM_SocksServerIP
Archive / History
Variable Name
C_IM_Archive_Enable
C_IM_Archive_DeleteAfter
C_IM_Presence_History
C_IM_Presence_HistoryDelete
SIP Service
Variable Name
C_System_Services_SIP_Enable
C_System_Services_SIP_Port
Type
Bool
Int
Bool
Int
Description
Enable IM archive
Delete IM archive after (Days)
Type
Bool
Int
Description
C_System_Services_SIP_DebugFile
C_System_Services_SIP_NoRecordRoute
C_System_Services_SIP_LocalNet
C_System_Services_SIP_RemoteAccessHost
C_System_Services_SIP_LocalAccessHost
C_System_Services_SIP_OtherProxy
C_System_Services_SIP_UseOtherProxy
C_System_Services_SIP_DisableAnonymousAccess
C_System_Services_SIP_DisableRegistrar
C_System_Services_SIP_DisableSymmetricResponseRouting
C_System_Services_SIP_Calls
C_System_Services_SIP_CallsFile
C_System_Services_SIP_UserCalls
C_System_Services_SIP_AwayPrefix
C_System_Services_SIP_ResetPrefix
C_System_Services_SIP_RedialPrefix
C_System_Services_SIP_ENUM
C_System_Services_SIP_SDPProxy
C_System_Services_SIP_SDPRemoteAccessHost
C_System_Services_SIP_Mode
C_System_Services_SIP_RTPProxy
C_System_Services_SIP_RTPStart
C_System_Services_SIP_RTPMax
C_System_Services_SIP_MaxCalls
C_System_Services_SIP_DNSEnabled
C_System_Services_SIP_AccessGroup
C_System_Services_SIP_SSLPort
C_System_Services_SIP_List
C_System_Services_SIP_Grant
C_System_Services_SIP_DisableRTPProxy
C_System_Services_SIP_ContactExpires
Bool
String
Int
String
Bool
Bool
Int
Int
Int
Int
Int
Bool
Bool
String
Int
Bool
Bool
Bool
Bool
String
Bool
String
String
String
String
Bool
String
String
String
String
Bool
API Variables 91
92 API Reference
Statistics
Variable Name
ST_Time
ST_ServerOut
ST_ServerIn
ST_ClientOut
ST_ClientIn
ST_Server
ST_ServerPeak
ST_Client
ST_ClientPeak
ST_ServerConns
ST_PeakWorkingSetSize
ST_PageFileUsage
ST_WorkingSetSize
ST_RunningTime
ST_SMTP_MessageOut
ST_SMTP_MessageIn
ST_SMTP_MessageFailed
ST_SMTP_FailedGL
ST_SMTP_FailedVirus
ST_SMTP_FailedCF
ST_SMTP_FailedStaticFilter
ST_SMTP_FailedFilter
ST_SMTP_FailedRBL
ST_SMTP_FailedTarpit
ST_SMTP_FailedSpam
ST_SMTP_FailedSpamQuarantine
ST_SMTP_FailedSpamRefused
ST_SIP_PacketsIn
ST_SIP_PacketsOut
ST_SIP_RTPPacketsIn
ST_SIP_RTPPacketsOut
Description
kB kB
Unix time kB kB
Type
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
API Variables 93
Schedule
Variable Name
S_ForceDial
S_WeekDays_Mo
S_WeekDays_Tu
S_WeekDays_We
S_WeekDays_Th
S_WeekDays_Fr
S_WeekDays_Sa
S_WeekDays_Su
S_ScheduleType
S_ScheduleWhen
S_DaysInMonth
S_OnceAt
S_Every
S_WholeDay
S_BetweenFrom
S_BetweenTo
S_Backup
Validation
Variable Name
V_Account_PassPolicy = 'passpolicy';
Type
Type
Bool
String
Int
Bool
Bool
Bool
Bool
Bool
Bool
Bool
Int
Bool
Int
Int
String
Description
(stEvery, stOnce, stDisabled)
(stWeekdays, stDaysInMonth,stDisabled)
Description
Mailing List
Variable Name
M_GroupwareDefaultRights
C_AS_Mailinglist_Quarantine_Disable
Type
String
Bool
Description
GroupWare default rights
Disables quarantine for mailing lists
0 – enabled, 1 – disabled
94 API Reference
C_AS_Mailinglist_Antispam_Disable
Services
Variable Name
C_System_Services_Firewall
C_System_Services_BindIPAddress
Atomic Clock Sync
Variable Name
C_System_Tools_AtomicClockSync_Enable
Notification
Variable Name
C_System_Adv_Notification_Active
C_System_Adv_Notification_Host
Bool Disables AntiSpam for mailing lists
0 – enabled, 1 – disabled
Type
Bool
String
Description
Restrict access to all services 0
IP addresses to bind services to
Type
Bool
Description
Enable Atomic clock sync
Type
Bool
String
Description
Notification messages active
Notification messages host
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project