Previous Topic

Next Topic

Book Contents

Book Index

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;

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;

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;

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;

In This Section

Init

Done

UpdateConfiguration

ReloadServices

BackupConfig and RestoreConfig

SpamIndexNow

Save

GetDomainCount

GetDomainList

DeleteDomain

RenameDomain

GetDomain

OpenDomain, NewDomain

GetDomainIndex

LastErr

GetSchedule

SetSchedule

GetUserStatistics, GetUserStatisticsDays

CreateTables, DropTables, CheckDBConnection

Challenge Response functions

See Also

API COM Object

Introduction

IceWarpServer.DomainObject

IceWarpServer.AccountObject

IceWarpServer.RemoteAccountObject

IceWarpServer.ScheduleObject

IceWarpServer.StatisticsObject

IceWarpServer.TokenObject

IceWarpCOM.Mailer

IceWarpCOM.IMMessage

IceWarpCOM.IDP

IceWarpCOM.IceWarpLicense

IceWarpCOM.Groupware

IceWarpCOM.ChallengeResponse

Examples

COM Usage under PHP