Transcription
IceWarp Unified CommunicationsIceWarp Server APIReferenceVersion 12Published on 3/6/2017
ContentsIceWarp Server API . 10Introduction . 10API COM Object . 10Introduction . 11IceWarpServer.APIObject . 12Init . 14Done . 14UpdateConfiguration . 14ReloadServices . 14BackupConfig and RestoreConfig . 14SpamIndexNow. 14Save . 15Example . 15GetDomainCount . 15GetDomainList . 15DeleteDomain . 15RenameDomain . 15GetDomain . 15OpenDomain, NewDomain . 16Example . 16GetDomainIndex . 16LastErr . 16GetSchedule . 16SetSchedule . 16GetUserStatistics, GetUserStatisticsDays . 16CreateTables, DropTables, CheckDBConnection . 17Challenge Response functions . 17IceWarpServer.DomainObject . 18Name . 18Open, New . 18Delete . 18GetProperty, SetProperty, IPAddress, Save . 19Example . 19GetAccountCount . 19GetAccountList . 19
DeleteAccount, DeleteAccountID . 19GetAccount . 19OpenAccount, NewAccount. 20Example . 20GetAccountIndexByAlias. 20LastErr . 20IceWarpServer.AccountObject. 21Domain . 21EmailAddress . 21New, Open . 21Delete . 22SetProperty, GetProperty, Save . 22Example . 22AuthenticateUser, AuthenticateUserHash, ValidateUser . 22FindInit, FindNext, FindDone, FindInitQuery . 22MailboxConvertMessages . 23LastErr . 23IceWarpServer.RemoteAccountObject . 24LastErr . 24Count . 24New . 24Open . 24Delete, DeleteIndex . 25GetSchedule . 25SetSchedule . 25Example . 25IceWarpServer.ScheduleObject . 26LastErr . 26Count . 26Add . 26Delete . 26Select . 26SetProperty, GetProperty . 27Example . 27IceWarpServer.StatisticsObject . 28IsRunning . 28Reset . 28Poll . 28
GetProperty . 29Start, Stop . 29Example . 29IceWarpServer.TokenObject . 30Example . 30IceWarpServer.Mailer . 32IceWarpServer.IMMessage . 32IceWarpServer.IDP . 33IceWarpServer.IceWarpLicense . 34IceWarpServer.Groupware . 34IceWarpServer.ChallengeResponse . 35Examples . 36Creating New Domain . 36Creating New User . 36Deleting User . 36COM Usage under PHP . 37Creating Object . 37Working with Object . 37Working with Domain . 37Working with Accounts. 37Creating Domain . 38Creating Account . 38List all Accounts in all Domains . 38PHP API . 40How to Include PHP API into Script . 40How to Initialize New IceWarpServer Object . 40Differences from COM Usage . 40RPC. 42Tool.exe . 43Usage . 43Commands . 43Options . 45Parameters. 46Examples . 46Create New Domain. 46Create Accounts Using Name, Pass and Comment . 46Display Comments of All doe.com Accounts . 46Export All Accounts. . 46
Export All Accounts. . 46Display Comments of All doe.com Accounts . 46Delete All Domain Accounts . 46Import Accounts from File . 46Modify Comment of All Accounts @doe.com . 47Delete All Accounts of doe.com Domain and Delete doe.com Domain . 47Show some System Variables . 47Change System Variable . 47Display some Information. 47Create Remote Account. 47Upgrade Database from Version 8.0.3 to Current . 47Display All Domains on Remote Server and its Description . 47Display Variables of Object . 48Accessing a Remote Server . 48Using Filters . 48Example . 48Command Line Tool . 49Sendmail.exe . 51Config.exe . 52API Variables . 52Function Result Codes. 53Configuration . 54Version & License . 54Domains . 55Domain . 55Limits . 55Options . 56Accounts . 57Accounts, Shared . 57User Account . 57Read-only Variables . 57User . 58Mailbox . 59Limits . 59Options . 60Responder . 61B&W List . 61Group Account . 62
Group. 62Members . 62Options . 62Rules . 63Mailing List Account . 63Mailing List . 63Message . 63Security . 64Options . 65Rules . 65List Server Account . 65List Server . 65Lists . 66Options . 66Rules . 67Executable Account . 67Executable . 67Rules . 67Remote Account . 68Remote Account . 68Options . 68DomainPop . 69Static Route Account . 69Static Route . 69Notification Account . 70Notification . 70Options . 70Rules . 71Catalog Account . 71Catalog. 71Options . 72Rules . 72Global Settings . 73Accounts . 73Domains . 73Advanced . 73Policies . 75Login Policy . 75
Password Policy . 75System . 77System Services . 77SMTP Service . 77POP3 Service. 77IMAP Service. 78Web / Control Service . 78FTP Service . 79GroupWare Service . 79Instant Messaging Service . 80LDAP Service . 80System Logging . 81General . 81Services . 81System Tools . 83System Backup Tool. 83Server Watchdog Tool . 84System Monitor Tool . 84Remote Server Watchdog Tool. 84TCP/IP Tunnel Tool . 85Server Migration Tool . 85Statistics . 85System Storage . 86Accounts . 86Directories . 86Load Balancing. 87System Internet Connection . 87System Advanced . 87System Active Directory. 89SMTP Service. 90SMTP Service . 90General . 90Delivery. 91Header / Footer . 92SMTP Security . 92General . 92DNS . 92Intrusion Prevention . 93
Advanced . 93SMTP Filters . 94Content Filters . 94Rules . 94SMTP Archive . 94SMTP ETRN Download . 95AntiSpam. 96AS General . 96AS Quarantine. 96Anti-Virus . 98General . 98Action . 98Filters . 99Other . 99Services . 101Web Service . 101FTP Service . 101GroupWare . 101SyncML . 101SMS Service . 102Instant Messaging . 102General . 102Archive/History. 102SIP Service. 103Statistics . 105Schedule. 106Validation .
IceWarp Server API . 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 .
