Home

API Reference

Contents

1.
2. Options Variable Name Type Description U_SMTP Bool Access mode SMTP 1 U_POP3IMAP Bool Access mode IMAP amp POP3 1 U_WebMail Bool Access mode Webmail 1 U_AVScan Bool Access mode AV 1 U_AS Bool Access mode AntiSpam 1 U_Quarantine Bool Access mode Challenge response 1 U_IM Bool Access mode IM 1 U_GW Bool Access mode GroupWare 1 U_SyncML Bool Access mode SyncML 1 U_SIP Bool Access mode SIP 1 U_QuarantineReports Int 0 Disabled 1 Default 2 New Items only 3 All items U_SpamFolder Int Spam folder mode 0 Default 1 Do not use Spam folder 2 Use Spam folder U_SpamAdmin Bool Spam administrator O U_ETRN Bool ETRN ATRN account 0 U_XEnvelopeTo Bool Add X Envelope To header to all messages O U_NoMailList Bool No mailing lists O 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 U_LocalDomain Bool User can send to local domains only O Responder Variable Name Type Description U_Respond Int Autoresponder mode 55 56 API Reference 0 Do not respond 1 Respond always 2 Respond once 3 Respond once in period U_RespondPeriod In
3. N_NotifyTo String Notify to N_IMNotification Bool IM notification N_Size Int Max message size Bytes 128 N_Count Int Split to multiple messages Messages 1 N_FilterType Int Filter 0 All 1 None 2 Filter N_Send Bool Send 0 N_FilterFile String Filter file path Options Variable Name Type Description N_IntoSubject A1 Bool Insert information into subject 1 N_SendTo Bool Insert To header O N_SendFrom Bool Insert From header 0 N_SendSubject Bool Insert Subject 1 N_SendDateTime Bool Insert Date Time O N_SendBody Bool Insert Body 1 N_From String From N_Subject String Subject N_Body String Body N_File String Text file N_ForwardCopy String Forward to N_Sender Int Originator 0 Empty 1 Sender 2 Owner N_AVScan Bool Access mode Antivirus 1 N_AS Bool Access mode Antispam N_QA Bool Access mode Quarantine 65 66 API Reference Rules Variable Name Type Description N_BlackWhiteFilter Bool Use B amp W list O Catalog Account Catalog Variable Name Type Description T_Alias String Alias T_Name String Description T_CatalogPass String Password T_CatalogSubject Bool Commands in subject 1 T_CatalogFile String Catalog file Options Variable Name Type Description T_CatalogGet Bool Get right 1 T_CatalogDir Bool Dir right 1 T_CatalogSendTo Bool SendTo right 1 T_CatalogSender I
4. Security Variable Name Type Description M_MembersOnly Bool Only members can post new messages O M_Moderated Int Moderated mode 0 None 1 Client moderated 2 Server moderated M_ModeratedPassword String Moderated password M_AllowSubscribers String Allow subscribers file M_DefaultRights Int Default rights O Receive amp post 3 bits 1st Receive 2nd Post 3rd Digest M_MaxList Bool Enable Maximum message size 0 M_MaxListSize Int Maximim message size value kB M_MaxMembers Int Max members M_DenyEXPNList Bool Deny EXPN O M_AVScan Bool Access mode Antivirus 1 M_AS Bool Access mode Antispam M_QA Bool Access mode Quarantine Options Variable Name Type Description M_SendToSender Bool Send copy to Sender 1 M_CopyToOwner Bool Forward copy to owner 0 M_DigestConfirmed Byte Digest mailing list O Relay local messages M_ListSubject Bool Process mailing list variables O M_Personalized Bool Personalized mailing list O M_RemoveDead Bool Remove dead email addresses O M_ListBatch Int Max of messages sent out in 1 minute M_NotifyJoin Bool Notify owner Join O M_NotifyLeave Bool Notify owner Leave 0 M_SubListFile String Join file M_LeaveFile String Leave file 59 60 API Reference Rules Variable Name Type Description M_BlackWhiteFilter Bool Use B amp W list O List Server Account List Server Variable Name Typ
5. Variable Name Type Description C_System_Tools_AutoBackup_Enable Bool Enable Auto backup O C_System_Tools_AutoBackup_BackupTo String Path to backup file C_System_Tools_AutoBackup_Password String Password C_System_Tools_AutoBackup_Schedule Schedule Auto backup Schedule C_System_Tools_AutoBackup_DeleteAfter Int Delete backup file after Days C_System_Tools_IncludeMailDir Bool Include mail folder settings to backup O C_System_Tools_ExcludeLicense Bool Do not include license to backup file O C_System_Tools_Backup_Emails Bool Backup emails C_System_Tools_Backup_SkipLarger Int Skip emails larger MB C_System_Tools_Backup_SkipOlder Int Skip emails older Days C_System_Tools_Backup_Dirs String Additional directories to backup C_System_Tools_Backup_Logs Bool Backup logs 76 API Reference Server Watchdog Tool Variable Name Type Description C_System_Tools_WatchDog_SMTP Bool Enable Watchdog for SMTP O C_System_Tools_WatchDog_POP3 Bool Enable Watchdog for POP3 O C_System_Tools_WatchDog_IM Bool Enable Watchdog for IM O C System Tools Watchdog GW Bool Enable Watchdog for GW 0 C System Tools Watchdog Control Bool Enable Watchdog for Control O C System Tools Watchdog Int Int Watchdog Interval System Monitor Tool Variable Name Type Description C System Tools Monitor Enable Bool Enable System monitor O C_System_Tools_Moni
6. f U_Name like Johns OR U Name like George AND U_AccountDisabled lt gt 0 q quiet Runs in quiet mode h help Displays help t tutorial Displays a short tutorial v version Displays tool exe 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 john doe com u name John Doe u_password john pass u comment First test account tool create account alex doe com u_name Alex Doe u_password alex pass u comment Second test account tool create account tom doe com 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 41 Export All Accounts of doe com Where Comment Contains Word first to File doe_com csv Using filter Option tool filter u comment like Sfirst export account doe com u name u password u comment gt doe com csv Export All Accounts of doe com to csv File base64 Encoded tool export account doe com u backup gt 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
7. C_System_ADSyncLogType Integer AD synchronization logging level 0 none 1 debug 2 summary 3 debug amp summary C_System_ADSynclgnoreSearchError Bool 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 C_System_ADSyncMaxDeleteThreshold Integer If set to value greater than 0 zero AD synchronization does not perform any account delete if the number should exceed this value SMTP Service SMTP Service General Variable Name Type Description C_Mail_SMTP_General_HostName String Mailserver hostname C_Mail_SMTP_General_DeliveryMode Bool SMTP service delivery mode 0 Use SMTP relay server 1 Use DNS lookup C_Mail_SMTP_General_RelayMailServer String SMTP relay server API Variables 81 C_Mail_SMTP_General_DNSServer String DNS servers C_Mail_SMTP_Other_Dedupe Bool Dedupe email messages O C_Mail_SMTP_Other_SearchInLocalDomains Bool Search for alias in other local domains O C_Mail_SMTP_Other_HeaderFunctions Bool Activate message header functions O C_Mail_SMTP_Other_MaxHopCount Int Max SMTP hop count 20 C_Mail_SMTP_Other_MaxRecipients Int Max SMTP server recipients 32768 C_Mail_SMTP_Other_MaxMTARecipients Int Max SMTP client re
8. Debug amp Summary C_System_Log_Services_IM Int IM service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C System Log Services GW Int GW service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_Control Int Control service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_FTP Int FTP service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_LDAP Int LDAP service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_AV Int AV logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_AS Int AS logging level 0 None 1 Debug API Variables 2 Summary 3 Debug amp Summary C_System_Log_Services_SIP Int SIP logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_SMS Int SMS service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_Services_SyncMLPush Int SyncML service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C_System_Log_MailQueue Bool Debug logging internal usage only System Tools System Backup Tool 75
9. 86 API Reference 3 Group 5 Selected domains only 9 Selected accounts only Anti Virus C AS Challenge ProcessingGroup String Access mode group C AS Challenge ReportsSchedule Schedule General Variable Name Type Description C AV General IntegratedAV Bool Enable Integrated AV scanner 1 C AV General ProcessingMode Int AV access mode bit based bit 0 All messages 1 All except selected 3 Group 5 Selected domains only 9 Selected accounts only C AV General ProcessingGroup String Access mode group C AV General UpdateType Int Update Schedule O Disabled 1 Once at 2 Every x hours C_AV_General_UpdateNotWeekdays Int List of days when server does not check for update bit 1 Monday bit 7 Sunday C_AV_General_UpdateTime Int Update time hours upper byte minutes lower byte C_AV_General_EveryHour Int Check for update every Hours C_AV_General_ActiveUpdate Bool Enable Active Update O Deprecated C_AV_General_ActiveAddress String Active update email trigger Deprecated C_AV_Info_UpdateDate String Update date API Variables C_AV_Info_UpdateSize Int Update size C_AV_Info_UpdateVersion String Update version Action Variable Name Type Description C_AV_Action_ScanAllParts Int Scan All message parts C_AV_Action_Mode Int AV Action mode 1 Reject 2
10. Remove infected attachments 3 Delete C_AV_Action_CleanInfected Bool Clean infected messages if possible 0 C_AV_Action_InfoToAdmin Bool Notification to Admin O C_AV_Action_InfoToRecipient Bool Notification to Recipient O C_AV_Action_InfoToSender Bool Notification to Sender O C_AV_Action_UseQuarantine Bool Quarantine infected messages O C_AV_Action_QuarantineAddress String Quarantine address path C_AV_Action_QuarantineMode Bool Virus Quarantine mode 0 Quarantine whole infected messages 1 Quarantine only infected attachments Filters Variable Name Type Description C_AV_Filters_BlockFiles Bool Block files with following extensions 0 Other Variable Name Type Description C_AV_Misc_RejectPassProtected Bool Reject password protected files O C_AV_Misc_ApplyAsLast Bool Apply antivirus as the last filter O C_AV_Misc_Outgoing Bool Apply antivirus to outgoing messages C_AV_Misc_DisableExternalAV Bool Disable External AV 1 87 88 API Reference C AV MaxThreads Int Max number of concurrent threads O C_AV_MaxFile Int Max message size C_AV_Avast Int Avast Antivirus usage 0 Default 1 Enabled 2 Disabled C_AV_Symantec Int Symantec Antivirus usage O Default 1 Enabled 2 Disabled C_AV_AVG Int AVG Antivirus usage 0 Default 1 Enabled 2 Disabled C_AV_Kaspersky Int Kaspersky Antivirus usage 0 Default 1 Enabled 2 Disabled Services Web Service Variabl
11. WideString safecall function Connect const Server WideString SSL WordBool WordBool safecall function Disconnect WordBool safecall end B NOTE For more information on these functions and parameters refer to the lt install_dir gt 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 Scom new COM IceWarpServer APIObject Sdomain Scom gt NewDomain test com Sdomain gt SetProperty d_description Description Sdomain gt SetProperty d_adminemail postmaster test com Sdomain gt Save API COM Object 31 Creating New User if Saccount new COM IceWarpServer AccountObject Saccount gt New postmaster test com Saccount gt SetProperty u_name Test Account Saccount gt SetProperty u_password Pass1 Saccount gt SetProperty u_mailbox postmaster Saccount gt Save Deleting User if Saccount new COM IceWarpServer AccountObject
12. E_ExecType Int Application type 0 Executable 61 62 API Reference 1 StdCall library 2 Cdecl library 3 URL E_Parameters String Application parameters E_ExecPass String Password E_ExecForwardCopy String Forward to address E_AVScan Bool Access mode Antivirus 1 E_AS Bool Access mode Antispam E_QA Bool Access mode Quarantine Rules Variable Name Type Description E_BlackWhiteFilter Bool Use B amp W list O Remote Account Remote Account Variable Name Type Description RA_Enabled Bool Is this Account Active 0 No 1 Yes RA_Name String Name RA_Server String Server RA_IMAP Bool Server type 0 POP3 1 IMAP RA_UserName String Username RA_Password String Password RA_APOP Bool Logging using APOP O RA_TLSSSL Int TLS SSL O Detect TLS SSL 1 Direct TLS SSL API Variables 2 Disable TLS SSL RA_ForwardTo String Forward to address RA_Schedule 222 Schedule Remote account schedule Options Variable Name Type Description RA_NotifyAdmin Bool Notify administrator of session problems RA_Dedupe Bool Dedupe collected emails O RA_LeaveMessagesOnServer Bool Leave messages on server O RA_DeleteOlder Bool Delete messages older than Days RA_DeleteCount Int Delete if more than Messages RA_ExtraForward String
13. Forward extra copy to address RA_ConvertDomains Bool Convert domain names O RA_Routing Bool Email address routing O DomainPop Variable Name Type Description RA_DomainPOP Bool Domain POP 0 RA_NoReceived Bool Do not processed Received header O RA_ReceiveAll Bool Stop parsing if Received yields a local address O RA_XEnvelopeTo Bool Parse these headers 0 RA_NoNames Bool Real name address matching O RA_MatchEmail String If email RA_DomainString String Domain it belongs to RA_LeaveMessageFile String Path to file to keep uids RA_Backup String Structure backup 63 64 API Reference Static Route Account Static Route Variable Name Type Description R_Alias String Alias R_Name String Description R_Activity Int Action O Forward to address 1 Forward to domain 2 Forward to host 3 Delete 4 Deliver to this domain R_ExternalDomain Bool Forward R_ActivityValue String Value R_SaveTo String Forward to address Service access R_ExternalFilter Int Filter O Filter 1 External 2 All R_FilterFile String Filter file R_ExternalFilterFile String External filter file R_ExternalFilterType Int External filter type 0 StdCall library 1 Cdecl library 2 Executable 3 URL Notification Account Notification Variable Name Type Description N_Alias String Alias N_Name String Description API Variables
14. 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 Saccount gt 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 API COM Object function Delete WordBool dispid 206 function SetProperty Command OleVariant Value OleVariant WordBool dispid 207 function GetProperty Command OleVariant OleVariant dispid 208 f
15. Saccount gt Open postmaster test com Saccount gt Delete 32 API Reference COM Usage under PHP In This Chapter Creating Objeto is de 32 Working with Object Working with Domain En e 33 Working With Accounts oo oom 33 Creating Domain inn nang ada 34 Creating ACCOUNT Aa 34 List all Accounts in all DOMAINS oooWooWoWoWoWWoWoW Wc WWW 34 Creating Object lt if Scom new COM IceWarpCOM APIObject echo COM object created r n echo r n 2 gt Working with Object lt Sdomcount com gt GetDomainCount echo Domain count domcountirin Sdomlist Scom GetDomainList echo Domain list domlist r n Sdomainname com gt GetDomain 0 echo First domain S domainname r n 2 gt echo rin Working with Domain lt gt domain com gt OpenDomain domainname Sdomname Sdomain gt Name echo Loaded domain Sdomname r n Saccnum Sdomain gt GetAccountCount echo Account count Saccnum r n Sacclist Sdomain gt GetAccountList echo Account list S acclist r n Sacc Sdomain gt GetAccount 0 echo First account acc r n echo r n Working with Accounts lt Saccount Sdomain gt OpenAccount acc echo Loaded account Sacc r n Saccdom Saccount gt Domain echo Account s domain Saccdom r n API COM Object 33 34 API Reference echo r n 2
16. Type Description S_ForceDial Bool S_WeekDays_Mo Bool S_WeekDays_Tu Bool S_WeekDays_We Bool S_WeekDays_Th Bool S_WeekDays_Fr Bool S_WeekDays_Sa Bool S_WeekDays_Su Bool S ScheduleType stEvery stOnce stDisabled S ScheduleWhen stWeekdays stDaysinMonth stDisabled S DaysinMonth String S OnceAt Int S Every Int S WholeDay Bool S_BetweenFrom Int S_BetweenTo Int S_Backup String Validation Variable Name Type Description V Account PassPolicy passpolicy Mailing List Variable Name Type Description M_GroupwareDefaultRights String GroupWare default rights C AS Mailinglist_Quarantine_Disable Bool Disables guarantine for mailing lists 0 enabled 1 disabled 93 94 API Reference Services C_AS_Mailinglist_Antispam_Disable Bool Disables AntiSpam for mailing lists 0 enabled 1 disabled Variable Name Type Description C System Services Firewall Bool Restrict access to all services O C_System_Services_BindlPAddress String IP addresses to bind services to Atomic Clock Sync Variable Name Type Description C_System_Tools_AtomicClockSync_Enable Bool Enable Atomic clock sync Notification Variable Name Type Description C_System_Adv_Notification_Active Bool Notification messages active C_System_Adv_Notification_Host String Notification messages host
17. 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 lt xml version 1 0 gt lt methodCall gt lt methodName gt 0 gt Create lt methodName gt lt params gt lt param gt lt value gt IceWarpServer AP Object lt value gt lt param gt lt params gt lt methodCall gt 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 lt xml version 1 0 gt lt methodCall gt lt methodName gt 123456 gt GetProperty lt methodName gt lt params gt lt param gt lt value gt c_version lt value gt lt param gt lt params gt lt methodCall gt RPC 37 38 API Reference Tool exe In This Chapter Commands Options Parameters Examples Kasasi Accessing a Remote Server iss ss Using FI ETS ii banana Usage tool options lt command gt lt object gt lt parameters gt Commands Command Options Object Parameters Create r system lt name gt New p domain lt variable1 gt lt value1 gt Add f account lt variable2 gt lt value2 gt q remoteaccount lt parameterN gt lt valueN gt Creates a new object tables service connectionstring backup filename Modify r system lt name gt Set p domain lt variab
18. 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 Sstat new COM IceWarpServer StatisticsObject Sstat gt Poll SMTP echo stat gt GetProperty st_serverconns Total number of server connections echo S stat gt GetProperty st_server Number of concurrent connections to the server echo S stat gt GetProperty st_smtp_messagesout Number of sent messages API COM Object 25 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 an
19. dispid 204 property Subject WideString dispid 205 property Recipients WideString dispid 206 property MailFrom WideString dispid 207 API COM Object 27 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 IceWarpCOM IMMessage IIMMessageDisp dis
20. 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 TaskEven
21. 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 BODE 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
22. msgs 0 C Mail SMTP Delivery InfoToAdmin Bool Send info to admin 0 C Mail SMTP Delivery UselncomingOueue Bool Use incoming mail gueue 82 API Reference C_Mail_SMTP_Delivery_IncomingQueueSize Int Size of the queue threads C_Mail_SMTP_Delivery_MDAlInternal Bool Use MDA queue for internal delivery 0 C_Mail_SMTP_Delivery_ReturnPath Bool Add return path Header Footer Variable Name Type Description C_Mail_SMTP_HeaderFooter_Enable Bool Enable Header Footer 0 SMTP Security General Variable Name Type Description C_Mail_Security_Relay_RelayMode Bool Relay mode 0 Open relay 1 Close relay C_Mail_Security_Relay_IPList String List of relayed IP addresses C_Mail_Security_Relay_POPSMTP Bool Enable POP before SMTP C_Mail_Security_Relay_POPSMTPInt Int POP before SMTP interval Min C_Mail_Security_Relay_POPSMTPGlobal Bool Enable POP before SMTP global mode C_Mail_Security_Relay_RejectLocalUnauth Bool Reject if orig s domain is local amp unauth O DNS Variable Name Type Description C_Mail_Security_Protection_DNSBL Bool Enable DNSBL O C_Mail_Security_Protection_CloseDNSBLConn Bool Close connection for DNSBL sessions O C_Mail_Security_Protection_RejectrDNS Bool Reject if sender s IP has no rDNS O C_Mail_Security_Protection_RejectMX Bool Reject if orig s domain has no MX rec 0 C_Mail_Security_Protection_SMTPWait Int Wait before processing a n
23. naek AAA 73 O na na 73 SYSTEM Ko 1a I na ne san 75 System Bae ku pro Ol ee te Sele leet tai Nan 75 Server Watchdog Tool EEE AN iia DN 76 SystemiMonitor Told ad DN 76 Remote Server Watchdog Tool civic edad 76 TEP IP TUNE Tool as 77 Server Migration TOOL ui ia 77 Mati iii A AA Ai 77 System SCO O O NA 78 ACC A ah NAN 78 DECO a iaa 78 toad Bl NO A AA Na 78 System Interet COnN e CTO in a ia 79 IceWarp Server API System Advance kos Kisses bs ada man maen an Haa an an Bo an Gohan 79 System Active Directo Ve ana na ne ena en On AN buana 80 A an aa an an AN 80 SMEP SEr NN 80 Generals Benahi a ana ana EN an Aa maan ian 80 Delivery Kanan kasat enakan NN NE EN 81 Header e aa 82 SMTP Uria A A nana aa EME naa 82 A NO 82 NON 82 Intrusion PREVENTION iii A AA AAA 83 AdVanGed sms masam ea an aa 83 SMTP Fiersa Me ema ema em na aa ia Sean ain 84 Content Filters snora ia 84 EE EE EEE TEE A EEEE id NN aan 84 SMTP ACV ita S E 84 SMTP ETRN Download eiii illa 85 AO DANN EEE an aa E NU 85 AS General ici iii uban E 85 A A A O as ba KN nan 85 A O O O O 86 A A E T E AE O 86 A r AE N E E A AA 87 Filters E E E NN ea ea NA 87 Other eae EEE ee ee E 87 ix Contents Web SelVitesc n aaa aera ieee anna 88 AA NN 88 ASA AN 89 SVG Liss E E E E N E T E E T EA E A rs ss sn NB BB 89 MASIA o 89 Instant Messaging Bu ea AS 90 A em ea ana an En aa 90 Archive History en a 90 SIPSErvIice atasan ae ema aa EA NA 90 StatiStiCS A hana inna N
24. 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
25. ricino iia nidos 32 Working With Domaine oie aiii 33 Working with ACCOUNTS an nina ini 33 Creating Domani 34 Creating ACCOU bean dass aa Pan aan 34 List all Accounts inall DoMaiNS 40k ied iia c 34 iea E eee ae aa naas akan ama an ea mana 36 TOOL EXEr Ain ea AA naa she nana ie 38 U Saber tanda Ne mam in A Ha 38 COMMAN GS 4 mna un uan sana ana an ina ana 38 OPIO en A BE ana Aa aah 39 PAM maan nana AAN Aan 40 EXAMS EEN PE E ENE A emas ena san ngan AAA 40 Cr ate New DOMAIN sean nee nga en ae Ina angan nang 40 IceWarp Server API Create Accounts Using Name Pass and Comment o ooooo Woo Jalanan 40 Display Comments of All doe com ACCOUNTS ooroWo oWooWoWo mma 40 Export All Accounts of doe com Where Comment Contains Word first to File doe_com csv Using O 41 Export All Accounts of doe com to csv File base64 Encoded oooooooooooWoo 41 Display Comments of All doe com ACCOUNTS cccesceesseesseceseecsseesseecsseecsneeeseessaecsseesessesseeseaeessneseaeees 41 Delete All Domain Accor 41 Import Accountstrom File ios 41 Modify Comment of All Accounts doe COM scccssceesseesseeececsseecssecseessneeceeesaeesuessaeesseeseseessneeeaeees 41 Delete All Accounts of doe com Domain and Delete doe com DOMAIN oooooo Woo ooo 41 Show some System Varia DIES ii bsa nas Sala Bu naa 41 Change System Variable xica a ld lio asta 41 Display SOMEINfOrMatiOn 4 uan Nania bana 42 Creat
26. 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 Scom gt GetProperty c_name Scom gt SetPro
27. 256 C System Services GW Bandwidth Int Max transfer bandwidth kB s O C System Services GW MonitorData Int Monitor increased traffic C System Services GW MonitorConn Int Monitor number of increased connections C System Services SyncML AccessMode Bool Service access mode 0 C System Services SyncML AccessGroup String Instant Messaging Service Variable Name Type Description C System Services IM Port Int IM service port 5222 C System Services IM SSLPort Int IM service SSL port 5223 C System Services IM AltPort Int IM service alternative port 5269 C System Services IM Traffic Bool Enable IM traffic logs 1 C System Services IM IPList String List of Granted Denied IPs C System Services IM AccessMode Bool Service access mode 0 Deny 1 Grant C_System_Services_IM_ThreadCache Int Service thread cache 40 C_System_Services_IM_MaxInConn Int Max number of Incoming connections 256 C_System_Services_IM_Bandwidth Int Max transfer bandwidth kB s 0 C_System_Services_IM_MonitorData Int Monitor increased traffic C_System_Services_IM_MonitorConn Int Monitor number of increased connections LDAP Service Variable Name Type Description C_System_Services_LDAP_Enable Bool Enable LDAP service O C_System_Services_LDAP_Port Int LDAP service port 389 C_System_Services_LDAP_SSLPort Int LDAP service SSL port 636 C_System_Services_LDAP_MaxInConn Int Max number of Incoming connections 256 C_S
28. AN NN AGE 92 Schedule ea Sh anna e ana 93 Validati Onde ah A AAA ERA A 93 Mailing ES En ASIN NAN dede cedo AN La E ate el aros BNN Gots a 93 SOlVICES ee ea nona nana papua nan 94 Atomic Glock MC Ne aus na 94 NOtifiGatiOn Saras as na 94 CHAPTER 1 IceWarp Server API In This Chapter Tool exe iooooo oo Wo Command Line Tool Sendmail exe Oni A Pen DA A an APIVariables ni aU RN NN an BER Bin 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 wc Visual C wb 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 i
29. Description C System Storage Dir MailPath String Path to mail folder C System Storage Dir TempPath String Path to temp folder C System Storage Dir LogPath String Path to log folder C System Storage Mailbox UseSorting Bool Enables mailbox path alphabetical sorting C System Storage Mailbox PrefixLen Int Number of characters from alias to prefix Load Balancing Variable Name Type Description C System Storage LB ServeriD String Server ID C System Storage LB AutoCheckConfig Bool Periodically check if settings have been changed and auto reloaded O C System MySOLDefaultCharset String Default charset for direct mysal client library as of v5 the default is latin1 so this needs to be changed to utf8 System Internet Connection API Variables 79 Variable Name Type Description C_System_Conn_Type Int Connection mode 0 Network connection 1 Dial up 2 Dial up on demand router C_System_Conn_UpName String Connection name C_System_Conn_UpUsername String Username C_System_Conn_UpPassword String Password C System Conn UpHangUpAfter Int Hang up after sec C System Conn UpOlderthan Int COnnect if msg waits for more than Min C_System_Conn_DialOnDemandExceed Int Connect if number of msgs exceeds C_System_Conn_DialOnDemandHeader Bool Connect if message with this header C_System_Conn_Schedule Schedule Connection schedule C_System_Conn_Gl
30. IMAP Port Int IMAP service port 143 C System Services IMAP SSLPort Int IMAP service SSL port 993 C System Services IMAP Traffic Bool Enable IMAP traffic logs 1 C System Services IMAP ThreadCache Int IMAP service thread cache 40 C System Services IMAP MaxlnConn Int Max number of Incoming connections 256 C System Services IMAP MaxOutConn Int Max number of Outgoing connections 1 C System Services IMAP Bandwidth Int Max transfer bandwidth kB s O C System Services IMAP IPList String List of Denied Granted IPs C System Services IMAP Accessmode Bool Service access mode O C System Services IMAP MonitorData Int Monitor increased traffic C System Services IMAP MonitorConn Int Monitor number of increased connections C System Services IMAP FileNameFlags Bool Web Control Service Variable Name Type Description C System Services Control Port Int Control service port 32000 C System Services Control SSLPort Int Control service SSL port 32001 C System Services Control Traffic Bool Enable Control traffic logs 1 C System Services Control IPList String List of Denied Granted IPs API Variables 71 C_System_Services_Control_AccessMode Bool Service access mode 0 Deny 1 Grant C System Services Control ThreadCache Int Control service Thread cache 40 C System Services Control MaxInConn Int Max number of Incoming connections 256 C System Services Control Ba
31. IceWarp Unified Communications API Reference Version 10 4 Icel arp gt Printed on 5 April 2012 Contents IceWarp Server API Introduction API COM Object isis 22an ana amen Nama anakan ena busui umataa tahun Introduction oia soldada ll saldo lo od a ld ds do UpdateConfiguration iia Relda0SErVICES 2 ee BAR AINI E dan hana eatin ates BackupConfig and Restore Config uti ii SpamIndexNOW ae NN EN bni GEt DOMAIN List ea EEEE EE E EEE E EE NE Rn an Delete DOMAIN tea nr SALA AAN PAN AN delo de an dedo dd o de dd do EN 10 TO 10 A TO 10 Contents GetUserStatistics GetUserStatisticsDays oooooooWo W Woo Woman CreateTables DropTables CheckDBConnection oooooooWooW Woman Challenge Response fUNCti ons san buanyak a a IceWarpServer Domain Object ika aka nun acid GEA COUNE LI SEE ANN NENEK DeleteAccount DeleteAccountilD ooooooocooooooooooo nana COCACOLA AA IcoWarpServer AccOUNtOb jet cc ri oia DOMAIN iii A A a AN ae SetProperty GetProperty Save narea naene eN ane e E aa S E Ea aa A NAVA KEKE ETS ESAN AE ENKEN Exam pl E EEEE anne P EE O A E T AuthenticateUser AuthenticateUserHash ValidateUser ooooocoooooooo FindInit FindNext FindDone FindInitQue ry ooo oWoWoWo WWW bakalan MallboxCoOnvert Messages ii ias IceWarp Server API iii KAS ENI capis ir rn E an ai anak 18 IceWarpServer RemoteAccountObject ooo
32. Read only variable to check if the user has antispam enabled U_SpamFolderSupport Bool Read only variable to check if the user has spam folder enabled U_SIPSupport Bool Read only variable to check if the user has SIP enabled U_AVSupport Bool Read only variable to check if the user has IceWarp Anti Virus enabled U_IMSupport Bool Read only variable to check if the user has instant messaging enabled API Variables U_GWSupport Bool Read only variable to check if the user has GroupWare enabled U_SyncMLSupport Bool Read only variable to check if the user has syncML enabled User Variable Name Type Description U_EmailAlias String Email alias U PhoneAlias String Phone alias U Mailbox String Username U Password String Password U AuthMode Int Authentication mode 0 Standard 1 NT domain 2 Active Directory 3 Any password U_AuthModeValue String Authentication mode value U_Comment String User comment U_AccountType Int Mailbox protocol type 0 POP3 1 IMAP amp POP3 2 IMAP U_Admin Bool Administrator permissions O U_DomainAdmin Bool Domain administrator permissions O U_ForwardTo String Forward to address U_GW_DailyAgenda Bool Sending of daily agenda to a user U_GW_Reminders Bool Sending of reminders to a user Mailbox Variable Name Type Description U_MailBoxPath String Mailbox path U_FullMailboxPath String Full mailbox path U_U
33. Rena hn Been HE Rs nan una aah aa 58 SO CUDIEY ceme II bu Nusa A nga Kagak 59 OPUS A kena aan an aah 59 RUGS Aa eevee hie ee cer ei ee SEA aah 60 LiSt Server ACCOUN N EE E E A cave seen anne ana aan EA aan 60 IceWarp Server API O O A OO 61 OPIO ii a 61 RUGS asia e Beban NN NAN BN BN 61 Executable ACCOUNT mei keganasan BR aan 61 ExecUtable nnti EEEE EEEE NE 61 RULES vita NE 62 Remote Account idea ang nana naa aa ana 62 Remote ACCOUNT Tangan 62 OPUS cari ia REA AA AAA AAA AAA AAA AAA AAA aan aa 63 DOMAIN POP mau A AS AS AA AAA Ar 63 Static ROUTE ACCOUNT eomma nana cubes nev ana ana una 64 Static ROUTE ia A nan daan au Ana 64 Notification Accounts aena toa 64 Noticia An aan 64 O TOTS Ke ai nh Dean aa an na Si aa 65 RUE Se an Pa as an en ee Sa na Ea nan 66 Catalog Account stan da HENNA nee ana 66 Gatal Op sentana tee Mens dele ed ll delo do da ld ed eet 66 Op cui at 66 Rules aras alioli italia 66 Global Settings airada dd alo dos helo na 67 ACCOUNES aca 67 DOMAINS NN 67 a ee NN am eee 67 Policia Anna 68 vii viii Contents Password Polly luca 68 System aa NB na Bl man 69 System A Ao EE T EE ORAE AEE E 69 A E E E A AAE E SE aa ana 69 POPS Serice aneka asa ee a E ana naa 69 IMAP Service aset a a es 70 W b Contras ias 70 A ea nan nana 71 GroupWare Service ed es an anang 71 Instant Messaging Servicio En Nas abu 72 LDAP Service seen at na nh han aan uan Ann 72 System LO EME Aria En AA hn ada NAN NN RERE a a 73 Generasi an ha
34. Security_Tarpit_DNSBL Bool Tarpit DNSBL C_Mail_Security_Tarpit_RSET Bool Tarpit RSET C_Mail_Security_Tarpit_RSETCount Int Tarpit RSET count Advanced Variable Name Type Description C_Mail_Security_Protocols_DenyESMTP Bool Deny ESMTP protocol O C_Mail_Security_Protocols_AllowSMTPAuth Bool Allow SMTP Auth 1 C_Mail_Security_Protocols_DenyVRFY Bool Deny VRFY command 0 C_Mail_Security_Protocols_DenyEXPN Bool Deny EXPN command 0 C_Mail_Security_Protocols_DenyTelnet Bool Deny Telnet access O 84 API Reference SMTP Filters Content Filters Variable Name Type Description C_Mail_Filter_Content_Enable Bool Enable Content filters O Rules Variable Name Type Description C_Mail_Filter_BW_Enable Bool Enable B amp W lists O C_Mail_Filter_RulesContentXML String C_Mail_Filter_MaxThreads Int Number of filter threads O SMTP Archive Variable Name Type Description C_System_Tools_AutoArchive_Enable Bool Enable Auto archive 0 C_System_Tools_AutoArchive_Path String Auto archive path C_System_Tools_AutoArchive_DeleteOlder Int Delete archive older than Days C_System_Tools_AutoArchive_Outgoing ammincoming ammBoth ammOutgoing C_System_Tools_AutoArchive_Backup_Active Bool Backup archive C_System_Tools_AutoArchive_Backup_DeleteOlder Int Delete old archive backups C_System_Tools_AutoArchive_Backup_File String Archive backup file C_System_Tools_AutoArchive_Backup_Password S
35. Server license read export and add new license C Reference String Server refefence key C OnlineLicense String Retrieve online license using orderid 50 API Reference Domains Domain Variable Name Type Description D_Description String Domain description D_Type Int Domain Type 0 Standard domain 1 ETRN ATRN queue 2 Domain Alias 3 Backup domain 4 Distributed domain D_DomainValue String Domain Type To value D_VerifyType Int User verification mode 0 Default 1 Issue RCPT 2 Issue VRFY D_PostMaster String Default Administrator s alias D_AdminEmail String Administrator s email D_UnknownUsersType Int Unknown users action O Reject 1 Forward to address 2 Delete D_UnknownForwardTo String Unknown users Forward to Address D_InfoToAdmin Bool Send information to administrator O Limits Variable Name Type Description D_AccountNumber Int Domain Admin account limit D_DiskQuota Int Domain disk quota kB D_VolumeLimit Int Limit of data sent from domain per day D_NumberLimit Int Limit of emails sent from domain per day D_DisableLogin Bool Disable login to this domain O API Variables D_UserMailbox Int User Mailbox size kB D_UserMsg Int User max message size kb D_UserMB Int User send out data limit MB day D_UserNumber Int User send out messages
36. 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 Saccount gt SetProperty u_name My Name Saccount gt SetProperty u_password pass01 Saccount gt Save API COM Object 17 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 initi
37. allDirectory gt 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 gt 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 mailing1 icewarpdemo com u type 1 m_owneraddress admin icewarpdemo com create account mailing2 icewarpdemo com u type 1 m_owneraddress admin icewarpdemo com create account mailing3 icewarpdemo com u_type 1 m_owneraddress admin icewarpdemo com 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 gt lt filename gt It redirects to a file Example tool check account passpolicy gt outofpolicy txt tool disp
38. assword 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 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
39. ated 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 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 Saccount gt FindInit test com While Saccount gt FindNext echo Saccount gt GetProperty u_alias 18 API Reference Saccount gt 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
40. cipients 100 C_Mail_SMTP_Other_LocalDelivery Bool Enable remote delivery from local server O C_Mail_SMTP_Other_ExternalDelivery Bool Deliver all messages externally 0 C_Mail_SMTP_Other_NoRetryQueue Bool Do not queue messages 0 C_Mail_SMTP_Other_BounceBackMode Int Bounce back mode C_Mail_SMTP_Other_SMTPPipelining Bool Enable SMTP pipelining O C_Mail_SMTP_Other_SPFSRS Bool Enable SRS O C_Mail_SMTP_Other_SPFSRSKey String SRS secret key C_Mail_SMTP_Other_MailboxSeparator String Mailbox separator extension separator eg alias extension domain Delivery Variable Name Type Description C_Mail_SMTP_Delivery_UseTLSSSL Bool Use TLS SSL O C_Mail_SMTP_Delivery_RetrySMTP Bool Retry with SMTP when ESMTP failed C_Mail_SMTP_Delivery_LimitMsgSize Bool Enable Max message size O C_Mail_SMTP_Delivery_MaxMsgSize Int Max message size B C_Mail_SMTP_Delivery_MXReconnectFailure Bool Deliver message via relay server when direct delivery fails C_Mail_SMTP_Delivery_HidelP Bool Hide IP from received header C_Mail_SMTP_Delivery_RDNSLookup Bool C_Mail_SMTP_Delivery_UndelivAfter Int Undeliverable after Minutes O C_Mail_SMTP_Delivery_UndelivWarning Int Undeliverable warning Minutes O C Mail SMTP Delivery DaemonAlias String Mailer Daemon report alias MAILER DAEMON C Mail SMTP Delivery DaemonName String Mailer Daemon report name Mail Delivery Subsystem C Mail SMTP Delivery BadMail String Bad mail address C Mail SMTP Delivery DoNoTruncate Bool Do not truncate mailer daemon s
41. coWo WoWo W oom o W W WWW manakala 18 KS EN ae ee an en aa mana Na man uu ayak 19 COUNE Aa Sian mn A aan ha ana ika 19 New esa ea am aga na ena ha an Ban kuasa aah 19 O peng en aan ema men ina aman A mna en rm in 19 Delete Dale ii ENNE A EES 20 GetSCheEdUle sera ae sana aan ama aa aah 20 SetSChed 4 mens NN NN 20 Eli A A AA AAA han akan nanah 20 IceWarpServer ScheduleO bject coccion kemasan an Na 21 E NN 21 UU iz 21 A an ae aa Banana 21 A ama an en he an Ba naa 22 Seleb ne RN 22 SetProperty Get Property esa eiii 22 EXA Mp Ek sai aan asma ka nngnga Na ban aan Nan na Una BNN EN BN 22 IcowarpServer StatisticsObje Cursi lanas NN NN NN ds 23 ISRUNNIN is anna ana EN BN NA NN 24 Reset en en naa Hamka veaysteasveae nangka BB he AN EN una 24 Poli Senen O Nae an Banana ngan an 24 GetPro pertya ON 24 Sak SOP a ls OE 24 EXA Mp ken dgan na An NN Nia ana 24 IceWarpServer Token Objett 000 ida 25 Contents Ml aie eee E N 26 IceWarpCOM Mailer ii ee ede ee ee 26 IceWarpcOM IMM ess Sica ia iria 27 Ice WarpCOM IDR cirio decia 28 IceWarpCOMilceWarplicense iii A A ican aie 29 lceWarpCOM Gro pWwar easi a a a et 29 IceWarpCOM ChallengeResponse kinen a E E E aia 30 NN 30 Creating NeW DOM Mii ea En 30 Creating New USer ii iaa ira 31 Deleting Useren AIA NA NA o do dada o beto o bile da dd dede ero o dedo dede 31 COM Usage Under PHP ini A A A AA A AAA AAA 32 Creating Ob etnia NAN NN do de dd 32 Working With Objectos occiso leccion
42. d 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 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 Stoken gt URL admin password remote server com Sapi new COM IceWarpServer APIObject Sapi gt TokenHandle Stoken gt TokenHandle Sapi gt 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
43. dd 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 GetAccountInd
44. e Description L_Alias String Alias L_Name String Description L_OwnerAddress String Owner address L_SendAllLists Int Members source O List file 1 All domain mailing lists L_ListFile String Path to list file L_DigestConfirmed Byte Subscription 0 No confirmation 1 User confirmation 2 Owner confirmation L_ListSubject Bool Commands in subject 1 M_JoinR Bool Join right 1 M_LeaveR Bool Leave right 1 M_ListsR Bool Lists right 1 M_WhichR Bool Which right 1 M_ReviewR Bool Review right 1 M_VacationR Bool Vacation right 1 M_WLR Bool Whitelist right 1 M_BLR Bool Blacklist right 1 M_DeliverExternally Bool Deliver externally 1 API Variables Lists Variable Name Type Description M_ListServer Bool List server vs mailing list 1 Options Variable Name Type Description L_Moderated Bool Moderated list server O L_ModeratedPassword String Moderated password M_HelpFile String List server help file L_ListSender Int Originator O Blank 1 Sender 2 Owner L_MaxList Bool Suppress command responses 0 L_AVScan Bool Access mode Antivirus 1 L_AS Bool Access mode Antispam L_QA Bool Access mode Quarantine Rules Variable Name Type Description L_BlackWhiteFilter Bool Use B amp W list 0 Executable Account Executable Variable Name Type Description E_Alias String Alias E_Name String Description E_Application String Application
45. e Name Type Description C_WebService_AppMaxThreads Int Number of web service application threads FTP Service Variable Name Type Description C_FTPService_Active Bool Activate FTP service API Variables GroupWare Variable Name Type Description C_GW_General_Disable Bool Disable GW service O C_GW_ProcessingMode Int GW service access mode bit 0 All messages 1 All except selected 3 Group 5 Selected domains only 9 Selected accounts only C_GW_ProcessingGroup String C_GW_SuperUser String C_GW_SuperPass String SyncML Variable Name Type Description C_SyncML_Push_Active Bool Set SyncML PUSH active 1 Active 0 Inactive C_SyncML_Push_Port Int Set port for SyncML PUSH C_SyncML_URL String Set URL for SyncML PUSH SMS Service Variable Name Type Description C_SMSService_Active Bool C_SMSService_RequireAuth Bool 89 90 API Reference Instant Messaging General Variable Name Type Description C_IM_General_Disable Bool Disable IM service O C_IM_General_Redirectunknown Bool Redirect unknown domain to local domain O C_IM_General_Anonymous Bool Enable Anonymousserver to server communication O C_IM_General_FileTransfer Bool Enable Server file transfer O C_IM_General_AccountRegistration Bool Enable Account registration O C_IM_General_ServerOSReport Bool Enable Server OS repor
46. e REMOte ACCOUNE Aa ena ias 42 Upgrade Database from Version 8 0 3 to Current ooocooWoWoo W oom 42 Display All Domains on Remote Server and its Description oooooWooWoo own 42 Display Variables of OB A da 42 Accessing a RAM a aa aan 42 Usinge Fiersa NE ade lb laced Os ete eet lade cee 43 BEKAM pe tt mma ede Sed ed ee oe ee bn ee ey oe 43 Command Line Toolin ben a 44 Sendmail exes Ae ea RN an a anda aan 46 Config EXC AAN AAN SANA ANANDA ANN SNN NN an rd ed ee 47 ARI Waid bles aset anna nan aan aa Ana AN Naa als decal balled shea 48 Function Result Codes en anna NN anne ea aa sasa 48 CON fi BUAT ON arta ALASAN NASA LAN INN LE ANA tilled RASA SAN 49 Version Beli ceme es SARA NASA ANN SNN LSN NN ANA AN 49 v vi Contents DOMAINS mangan saci ceesees E E ieee ee E sags maan kaan aah 50 DOMAIN pede O Rei naa nanah 50 LIMIES Ai ee Lana NE BNN RE ana Ba BA 50 A anna pn Pan LN E NE TE EE 51 ACCOUNTS seis Kutim uan ana ac 52 O 52 USEF AU Ae ei 52 Read only Variable ii KN BAN ee ase 52 NN 53 Mail box ten 53 A nenen aa EA SE 54 Opi ON Shen ae oe AAA ANE Ba 55 Responden Senen angan anna anne NN 55 BOI ES te ang ngga 56 Group ATOE SIE ah ae A Ne BN 56 GiOUP NN en ne NN NN TON 56 Memberi ena aka nara oie 57 an Ne en aa NAN Pan en nan at Taat 57 RULES ananda aan ia Bimasakti 57 Mailing List ACCOUNT 05 bsa se badknnga sanga maan nan NN NN nas akun 57 Mailing List 411i ea husen ena EN BN NE ang 57 MeSSag iii aan
47. e to edit and read any schedule structure of different mail server settings 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 Sra gt Open 0 Opens the first remote account Sschedule Sra gt GetSchedule ra_schedule Retrieve the schedule for the object Sschedule gt Count 1 Sets 1 schedule item Sschedule gt SetProperty s_weekdays_su true Sschedule gt SetProperty s_weekdays_mo true Sschedule gt SetProperty s_weekdays_tu true Sschedule gt SetProperty s_weekdays_we true Sschedule gt SetProperty s_weekdays_th true Sschedule gt SetProperty s_weekdays_fr true Sschedule gt SetPr
48. ely 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 dnstool Launches the console and opens the DNS Tool dialog sqlmanager Launches the console on the SQL Manager tab bookmark lt server gt Launches the console and connects it with the specified server ftpsync lt item_no gt Launches FTP synchronization E g ftpsync 7 forceconnect ID Launches the console and connects it with the server defined by its ID The QuickID is meant here See Bookmarks Manager QuickID r v5 5 EN Administrator Command Prompt ol ll C Program Files x86 gt IceWarp gt config sqlmanager C Program Files x86 gt IceWarp gt config dnstool C Program Files x86 IceWarp 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 cai anna Configuration th Shel NN San aka aa DOMAINS ii ias AGGOUNUS fos 3ssscssesisiovashisiesscdissevsstasucsassiaies
49. es You can then call the Save function again and the domain will be only updated and not added again Example Sdomain gt SetProperty d_postmaster postmaster webmaster admin Sdomain gt SetProperty d_description Demo Domain Sdomain gt IPAddress 192 168 0 1 192 168 0 2 Sdomain gt 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 Saccount Sdomain gt NewAcc
50. ess mode O Standard 1 Extended alias resolving 2 Username C_System_Tools_Migration_NoXEnvelopeTo Bool Do not use X Envelope To header O C_System_Tools_Migration_NoReceived Bool Do not process received header 0 C_System_Tools_Migration_MultiDomain Bool Multidomain migration O Statistics Variable Name Type Description C_System_Tools_Migration_Stat_Start Int Unix time of start C System Tools Migration Stat TotalUsers Int Total number of migrated mailboxes C System Tools Migration Stat Users Int Number of migrated mailboxes C System Tools Migration Stat Aliases Int Number of migrated aliases C System Tools Migration Stat Messages Int Number of messages migrated C System Tools Migration Stat Last Int Unix time of last migrated mailbox C System Tools Migration Stat Errors Int Number of migration errors 78 API Reference System Storage Accounts Variable Name Type Description C System Storage Accounts StorageMode Int stProfessional stFileSystem stODBC 1 Accounts storage mode 0 Professional file system 1 Standard file system 2 ODBC C System Storage Accounts ProModeCache Int Professional file system memory cache 10 C System Storage Accounts ODBCConnString String ODBC connection string C System Storage Accounts ODBCMultithread Bool Use Multithreaded ODBC O C System Storage Accounts ODBCMaxThreads Int Directories Variable Name Type
51. ew conn O C_Mail_Security_Protection_LocalDomain Bool Relay only if orig s domain s local 0 C Mail Security Protection DomainlPShield Bool Use Domain IP shielding O C Mail Security Protection RejectSMTPAuthSender Bool Reject if SMTP AUTH different from sender API Variables 83 C_Mail_Security_Protection_HELOEHLO Bool Require HELO EHLO O C Mail Security Protection IgnoreBlankHeloHost Bool Igonore Blank Helo Host Intrusion Prevention Variable Name Type Description C Mail Security Tarpit Enable Bool Enable tarpitting O C_Mail_Security_Tarpit_Count Int Number of attempts C_Mail_Security_Tarpit_Period Int Tarpitting interval intrusion prevention C_Mail_Security_Tarpit_RelayTarpit Bool Tarpit relay rejected IPs O C_Mail_Security_Tarpit_BlockIP Bool Block IPs that establish more than BlockIPValue connections within a minute 0 C_Mail_Security_Tarpit_BlockIPValue Int Number of limited of connections C_Mail_DoNot_Tarpit_IPs Bool Do not tarpit IP addresses O C_Mail_Security_Tarpit_CloseConnection Bool Close tarpitted connections O C_Mail_Security_Tarpit_CrossSession Bool Cross session processing O C_Mail_Security_Tarpit_Msg_Enabled Bool Tarpit message size C_Mail_Security_Tarpit_Msg_Value Int Tarpit message size value C_Mail_Security_Tarpit_Spam Bool Tarpit spam C_Mail_Security_Tarpit_SpamScore Int Tarpit spam score 100 C_Mail_
52. exByAlias 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 13 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 properti
53. filterstring filterstring outputfile 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 lt InstallDirectory gt 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 want to create mailing list will have to use this tool create account mailing icewarpdemo com u_type 1 m_owneraddress admin icewarpdemo com Usage tool create account new icewarpdemo com 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 new icewarpdemo com u_mailbox u_accounttype It shows you values of both variables u_mailbox and u_accounttype of new icewarpdemo com 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 lt Inst
54. gt Creating Domain lt Sdomain com gt NewDomain test com domain gt SetProperty D Description Test Domain domain gt SetProperty D AdminEmail postmaster test com Sdomain gt Save 2 gt Creating Account lt Saccount domain gt NewAccount test Saccount gt SetProperty U Password password Saccount SetProperty U Name Test Saccount SetProperty U Comment Comment Saccount gt Save 2 gt List all Accounts in all Domains lt Sapi new COM IceWarpCOM APIObject Saccount new COM IceWarpCOM AccountObject Sdomcount Sapi gt GetDomainCount for i 0 i lt Sdomcount i domain name api gt GetDomain i if Sdomain name break printf Ss Sdomain name if Saccount gt FindInit domain name while Saccount gt FindNext printf s Sfaccount gt GetProperty u alias gt GetProperty u_name Saccount gt FindDone printf r n 2 gt API COM Object Saccount 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
55. id 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 fu
56. internal license system To get license data call GetProperty c license xmi instead You will obtain all license data in the xml format IlceWarpLicenseDisp dispinterface EOD781D9 47A0 425A A02D C537441B3CF2 property LicenseDemo WordBool readonly dispid 201 property LicenseApplD 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 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
57. lay account gt accounts txt gets a listing of accounts with double line feeds tool export account gt 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 lt messagefile imap It reads the headers from the file and then sends it to the proper recipient s 2 sendmail exe senderOdomain1 com recipient domain2 com Interactive mode you can compose a message The mail FROM header will read sender domain1i com the RCPT TO one will read berecipient domain2 com 3 sendmail exe F fullname f sender domaini com recipient domain2 com lt message file Config exe 47 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 avisos pingu company com br angela company com br lt teste tmp A message included in the teste tmp file is sent to angela company com br with sender s full name of Flavio and the mail From header of avisos pingu company com br Config exe This is a tool that enables the administrator to remot
58. le1 gt lt value1 gt f account lt variable2 gt lt value2 gt Change the properties q remoteaccount lt parameterN gt lt valueN gt of an object storage 1 Convert to database Storage Delete r system lt name gt p domain Delete an object f account q remoteaccount Tool exe Options tables service connectionstring Display r system lt name gt Get p domain lt variable1 gt List f account lt variable2 gt q remoteaccount lt parameterN gt Display the selected service or roperties of an object prop J lt mask gt e g to display all properties and values userstatistics fromdate todate filterstring Check r account passpolicy Validate p f Check the validity of a q user account in accordance with the password policy Search string Search the API for a string Upgrade lt old version gt Upgrade IceWarp Server s database to the latest version Export r domain lt name gt Import p account lt variable1 gt f remoteaccount lt variable2 gt Export or Import data q lt parameterN gt to a file backup Filename Option Function m template name Applies an object template 39 40 API Reference m MyTemplate r remote info Connects to a remote server r user userpw www RemoteServer 32001 ssl p path dir Path to the server directory f filter value Filter for objects
59. limit day D_Expires Bool Enable domain expiration O D_ExpiresOn Int Domain Expires On Date D_NotifyExpire Bool Enable Notify before expiration O D_NotifyBeforeExpires Int Notify before expiration Days D_DeleteExpired Bool Delete Expired domains O Options Variable Name Type Description D_IPAddress String D_Hostname String Hostname D_Folderpath String Folder path D_AVScan Bool Access mode AV D_AntiSpam Bool Access mode Antispam lt BAC998XY gt quarantine THIS WAS CHALLENGE RESPONSE D_IM Bool Access mode IM D_Calendar Bool Access mode GW D_SyncML Bool Access mode SyncML D_SIP Bool Access mode SIP D_ChallengeResponse Bool Access mode Challenge Response D_Backup String Structure backup D_RulesContentXML String 51 52 API Reference Accounts Accounts Shared Variable Name Type Description U Type Int Account type O User 1 Mailing list 2 Executable 3 Notification 4 Static Route 5 Catalog 6 List server 7 User group U_Alias String Account s alias U_Name String Account s full name description U_Backup String Structure backup U_NonUserAS Bool Non user account antispam access U_NonUserQA Bool Non user account quarantine access User Account Read only Variables Variable Name Type Description U_QuarantineSupport Bool Read only variable to check if the user has quarantine enabled U_ASSupport Bool
60. 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 nam 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 lt info gt options lt command gt lt object gt lt parameters gt where lt info gt lt user gt lt pass gt lt server port gt ssl user admin username pass admin password server port remote server and port Tool exe 43 Using Filters Usage tool filter f lt conditions gt o
61. nction 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 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
62. ndwidth Int Max transfer bandwidth kB s O C System Services Control MonitorData Int Monitor increased traffic C System Services Control MonitorConn Int Monitor number of increased connections FTP Service Variable Name Type Description C System Services FTP Port Int FTP service port 21 C System Services FTP SSLPort Int FTP service SSL port 990 C System Services FTP Traffic Bool Enable FTP traffic logs 1 C System Services FTP IPList String List of Granted Denied IPs C System Services FTP AccessMode Bool Service access mode 0 Deny 1 Grant C System Services FTP ThreadCache Int Service thread cache 40 C System Services FTP MaxlnConn Int Max number of Incoming connections 256 C System Services FTP MaxOutConn Int Max number of Outgoing connections 256 C System Services FTP Bandwidth Int Max transfer bandwidth kB s O C System Services FTP MonitorData Int Monitor increased traffic C System Services FTP MonitorConn Int Monitor number of increased connections GroupWare Service Variable Name Type Description C System Services GW Port Int GW service port 5229 C System Services GW Traffic Bool Enable GW traffic logs 1 C System Services GW IPList String List of Denied Granted IPs C System Services GW AccessMode Bool Service access mode 0 Deny 1 Grant 72 API Reference C System Services GW ThreadCache Int GW service Thread cache 40 C System Services GW MaxlnConn Int Max number of Incoming connections
63. nformation 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 gt 0 ERROR lt 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 lt InstallDirectory gt to your PATH variable as it contains some libraries that will be required API COM Object API COM Object In This Chapter IntrodUCtiOn sit 3 IceWarpServer APIObject IceWarpServer DomainObject re 11 IceWarpServer AccountObject am 14 IceWarpServer RemoteAccountObject ee 18 IceWarpServer ScheduleObject oooooooWoooo maan 21 IceWarpServer StatisticsObject oooooo ooooman 23 IceWarpServer TokenObject ooooooooo o Wo Womanaaaan 25 IcoWarpCOM Mailer ocio nein vai ieaia cece eae 26 IceWarpCOM IMMessage ooooco WoW Wo mna 27 IceWarpCOM IDP occ 28 IceWarpCOM IceWarpLicense o ooo oWooo WoW mom 29 IceWarpCOM GTOUPWAre ooccccccnononocononinononennnononenananononnncnnnannnnncnnneranananane 29 IceWarpCOM ChallengeResponse oooooWoWoo Wooo 30 A NO 30 COM Usage Under PAP sinus anne 32 Introduction Maintaining the IceWarp Email Server has
64. nt Originator 0 Empty 1 Sender 2 Owner T_AVScan Bool Access mode Antivirus 1 T_AS Bool Access mode Antispam T_QA Bool Access mode Quarantine Rules Variable Name Type Description T_BlackWhiteFilter Bool Use B amp W list O Global Settings API Variables Accounts Variable Name Type Description C_Accounts_Global_Accounts_Maint Bool Maintenance log enanceLog Domains Variable Name Type Description C_Accounts_Global_Domains_UseDiskQuota Bool Use Domain disk quota O C_Accounts_Global_Domains_UseDomainLimits Bool Use Domain limits O C_Accounts_Global_Domains_UseUserLimits Bool Use Domain user limits O C_Accounts_Global_Domains_UseExpiration Bool Use Domain expiration O C_Accounts_Global_Domains_OverrideGlobal Bool Override global limits O C_Accounts_Global_Domains_DomainKeys Bool Enable DomainKeys support O C_Accounts_Global_Domains_Literals Bool Enable Domain literals O C_Accounts_Global_Domains_Hostname Bool Use domain hostnames for outgoing msgs O C Accounts Global Domains IPAddress Bool Use domain IP address for outgoing msgs 0 C Accounts Global Domains WelcomeMsgs Bool Use Welcome messages O C_Accounts_Global_Domains_WarnMailboxUsage Int Warn when mailbox size exceeds C_Accounts_Global_Domains_WarnDomainSize Int Warn when domain size exceeds C_Accounts_Global_ActiveDirectorySyncinterval Int Minutes inter
65. o group members Rules Variable Name Type Description G_BlackWhiteFilter Bool Use B amp W list O Mailing List Account Mailing List Variable Name Type Description M_Alias String Alias M_Name String Description M_OwnerAddress String Owner address M SendAllLists Int Members source O List file 1 All current domain users 57 58 API Reference 2 All system users 3 All domain administrators 4 All system administrators 5 Members from ODBC M ListFile String Path to list file M ODBC String ODBC connection DSN user pwd server type M SOL String SOL statement Message Variable Name Type Description M SetSender Int Set From or Reply to headers to sender 0 Off 1 Set From to sender 2 Set Reply To to sender M_SetValue Int Set From or Reply to headers to value 0 Off 1 Set From to value 2 Set Reply To to value M_ValueMode Bool Order of header value mode O From header set to value 1 Reply To header set to value M_HeaderValue String From or Reply to headers value FromValue ReplyToValue M_SeparateTo Bool Set Recipients to To header 1 M_AddToSubject String Add to Subject value M_AddToHeader String Add headers value M_ListSender Int Originator O Blank 1 Sender 2 Owner M_HeaderFile String Header file M_FooterFile String Footer file API Variables
66. obalSchedule Schedule Global schedule System Advanced Variable Name Type Description C_System_Adv_Protocols_SessionTimeOut Int Session timeout 300 C_System_Adv_Protocols_ResponseDelay Int Protocol response delay O C_System_Adv_Protocols_MaxBadCommands Int Max number of bad commands 8 C_System_Adv_Protocols_BackLog Int Listen back logs 5 C System Adv Protocols DNSTimeout Int DNS Timeout 5 C System Adv Protocols DNSCache Bool Use DNS smart cache 1 C System Adv Protocols DNSRetry Int DNS retries 1 C System Adv Protocols DNSCacheLimit Int DNS cache items limit 128 C System Adv Protocols IMAPTimeout Int IMAP timeout C System Adv Ext DisableSSLTLS Bool Disable SSL TLS 1 C System Adv Ext EnablelPv6 Bool Enable IPv6 Protocol 0 C_System_Adv_Ext_ChangePassServer Bool Enable Change password server O C_System_Adv_Ext_DaytimeServer Bool Enable Daytime server O C_System_Adv_Ext_DayTimePort Int Daytime port C_System_Adv_Ext_DisableMultiCPU Bool Disable Multiple CPU 1 80 API Reference C_System_Adv_Ext_SNMPServer Bool Enable SNMP server C_System_Adv_Ext_SNMPPort Int SNMP port C_System_Adv_Ext_SocksServer Bool Enable Socks server C_System_Adv_Ext_SocksPort Int Socks port C_System_Adv_Ext_SSLServerMethod Default smSSLv2_method smSSLv23_method smSSLv3_method smTLSv1_method C_System_Adv_Ext_SSLClientMethod Default smSSLv2_method smSSLv23_method smSSLv3_method smTLSv1_method System Active Directory
67. operty s_weekdays_sa true Sschedule gt SetProperty s_scheduletype 0 Every x minutes type Sschedule gt SetProperty s_every 1200 Sets 20 minutes Sschedule gt SetProperty s_wholeday true Do not use day interval but rather the whole day API COM Object Sra gt SetSchedule ra_schedule Sschedule Sets the changed schedule structure back to the remote account Sra gt Save Save the changed remote account IceWarpServer StatisticsObject 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 SMTP POP3 IMAP IM GW FTP Control SIP LDAP 23 24 API Reference IsRunning function IsRunning const Service WideString WordBool
68. ordBool The Delete function lets you delete the currently open remote account The Deletelndex 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 Sra gt SetProperty ra_name Remote Name Sra gt SetProperty ra_domainstring domain com Sra gt SetProperty ra_pop3server server isphost com Sra gt SetProperty ra_username userlogin Sra gt SetProperty ra_password password Sra gt SetProperty ra_forwardto john domain com Sra gt Save API COM Object 21 IceWarpServer ScheduleObject IScheduleObjectDisp dispinterface 3411CE71 91A5 42D1 93F3 AO0A38EF541D0 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 possibl
69. ound 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 API COM Object 11 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 Challenge Response functions function ChallengeResponseList const Recipient WideString const Flags WideString WideString function ChallengeResponseA
70. ount 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 lAccountObjectDisp dispinterface FO816647 788E 4520 8685 BCDDAEBECCEF property LastErr Integer readonly dispid 201 API COM Object 15 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 P
71. ounts Policies SuperUserPassword String C Accounts Policies Login AuthWISIDDisable Bool Password Policy Variable Name Type Description C Accounts Policies Pass Enable Bool Enable Password policy O C Accounts Policies Pass UserAlias Bool Check password against username alias O C Accounts Policies Pass Encrypt Bool Password database encryption O C Accounts Policies Pass MinLength Int Min password length API Variables 69 System C_Accounts_Policies_Pass_Digits Int Number of numeric chars in password C Accounts Policies Pass NonAlphaNum Int Number of non alphanumeric characters C Accounts Policies Pass Alpha Int Number of alpha characters C Accounts Policies Pass Expiration Bool Enable password expiration O C Accounts Policies Pass ExpireAfter Int Expire after Days C Accounts Policies Pass DenyExport Bool Passwords cannot be read or exported 0 C Accounts Policies Pass AllowAdminPass Bool Allow Admin s password to be exported 0 System Services SMTP Service Variable Name Type Description C System Services SMTP Port Int SMTP service port 25 C System Services SMTP SSLPort Int SMTP service SSL port 465 C System Services SMTP AltPort Int SMTP service alternative port 366 C System Services SMTP Traffic Bool Enable SMTP traffic logs 1 C System Services SMTP IPList String List of Denied Granted IPs C System Services SMTP AccessMode Bool Se
72. perty c_name mail domain com Scom gt 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 IceWarpAPl 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 10 API Reference The NewDomain lets you add a new domain Example domain Scom gt NewDomain test com GetDomainIndex function GetDomainIndex const Domain WideString Integer Returns the position of the domain in the list If not f
73. pinterface 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 29 IceWarpCOM IceWarpLicense AN NOTE This API object is obsolete and no longer returns correct values due to change in
74. ptions lt command gt lt object gt lt params gt lt conditions are specified using an SQL like syntax filter lt variable gt like lt pattern gt AND lt variable gt lt value gt Example tool filter U Name like Johns OR U Name like GeorgeS AND U_AccountDisabled lt gt 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 XInstallDirectory 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 APlconst pas file in the lt InstallDirectory gt 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 period
75. roxy Bool C System Services SIP SDPRemoteAccessHost String C System Services SIP Mode Int C System Services SIP RTPProxy Int C System Services SIP RTPStart Int C System Services SIP RTPMax Int C System Services SIP MaxCalls Int C System Services SIP DNSEnabled Bool C System Services SIP AccessGroup String C System Services SIP SSLPort Int C System Services SIP List String C System Services SIP Grant Bool C System Services SIP DisableRTPProxy Bool C System Services SIP ContactExpires Int 91 92 API Reference Statistics Variable Name Type Description ST Time Int Unix time ST ServerOut Int kB ST Serverin Int kB ST ClientOut Int kB ST ClientIn Int kB ST Server Int ST ServerPeak Int ST Client Int ST ClientPeak Int ST ServerConns Int ST PeakWorkingSetSize Int ST PageFileUsage Int ST WorkingSetSize Int ST RunningTime Int ST SMTP MessageOut Int ST SMTP Messageln Int ST SMTP MessagefFailed Int ST SMTP FailedGL Int ST SMTP FailedVirus Int ST SMTP FailedCF Int ST SMTP FailedStaticFilter Int ST SMTP FailedFilter Int ST SMTP FailedRBL Int ST SMTP FailedTarpit Int ST SMTP FailedSpam Int ST SMTP FailedSpamOuarantine Int ST SMTP FailedSpamRefused Int ST SIP Packetsin Int ST SIP PacketsOut Int ST SIP RTPPacketsIn Int ST SIP RTPPacketsOut Int Schedule API Variables Variable Name
76. rvice access mode 0 Deny 1 Grant C_System_Services_SMTP_ThreadCache Int SMTP service Thread cache 40 C_System_Services_SMTP_MonitorData Int Monitor increased traffic C_System_Services_SMTP_MonitorConn Int Monitor number of increased connections C_System_Services_SMTP_MaxInConn Int Max number of Incoming connections 256 C_System_Services_SMTP_MaxOutConn Int Max number of Outgoing connections 256 C_System_Services_SMTP_Bandwidth Int Max transfer bandwidth kB s 0 POP3 Service Variable Name Type Description C_System_Services_POP3_ Port Int POP3 service port 110 C_System_Services_POP3_SSLPort Int POP3 service SSL port 995 70 API Reference C_System_Services_POP3_Traffic Bool Enable SMTP traffic logs 1 C_System_Services_POP3_IPList String List of Denied Granted IPs C_System_Services_POP3_Accessmode Bool Service access mode O O Deny 1 Grant C_System_Services_POP3_ThreadCache Int POP3 service thread cache 40 C_System_Services_POP3_MaxInConn Int Max number of Incoming connections 256 C_System_Services_POP3_MaxOutConn Int Max number of Outgoing connections 1 C System Services POP3 Bandwidth Int Max transfer bandwidth kb s O C System Services POP3 MonitorData Int Monitor increased traffic C System Services POP3 MonitorConn Int Monitor number of increased connections IMAP Service Variable Name Type Description C System Services
77. s B NOTE Command line tool does not support multi line you can encounter this e g using the autoresponder variable CREATE 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 DELETE Deletes an object It is followed by a type domain or account and a unique name of object you want to delete MODIFY 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 DISPLAY 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 EXPORT 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 FILE Calls file functions It is followed by USERSTATISTICS and all its parameters see below Command Line Tool 45 BATCH batchfile 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 USERSTATISTICS Saves userstatistics between fromdate and todate to specified output file for all users that fulfill fromdate todate the condition of
78. seRemoteAddress Bool Mailbox local remote 0 Local mailbox 53 54 API Reference 1 Remote address U_RemoteAddress String Remote address U_NULL Bool Null account O U_DeleteOlder Bool Enable Delete messages older than O U_DeleteOlderDays Int Delete messages older than Days U_ForwardOlder Bool Enable Forward messages older than O U_ForwardOlderDays Int Forward messages older than Days U_ForwardOlderTo String Forward messages older then x to address U_Mailln String Copy incoming email address U_MailOut String Copy outgoing email address U_AlternateEmail String Alternate email Limits Variable Name Type Description U_MaxBox Bool Enable mailbox size limit O U_MaxBoxSize Int Mailbox size limit kB U_MaxMessageSize Int User max message size kB U_MegabyteSendLimit Int Send out data limit MB day U_NumberSendLimit Int Send out messages limit day U_AccountDisabled Int Account state O Enabled 1 Disabled Login 2 Disabled Login Receive 3 Disabled Tarpitting U_InactiveFor Int Expires if inactive for Days U_AccountValid Bool Enable Expires on O U_AccountValidTill Int Expires on Date U_ValidityReport Bool Enable Notify before exiration 0 U_ValidityReportDays Int Notify before expiration Days U_DeleteExpire Bool Delete account when expired O U_ValidReport String Notification file API Variables
79. sibisiovsed shm anna Global Setting Sienen O ERE eens Policia E E T A E A System SMTP Service AntiSpam Anti Virus Services wes iii tie Statistics cria enam amen A O Vada O dins Mailing NN ieser ea e aeaa na AREE SE a EE ORES SOMVICES EE A ane ETS EESE E T AO EE Atomic Clock Syasi atada adn Noti a ace Function Result Codes Variable Name Type Description S_OK Function Successful E_FAILURE Function failure E_LICENSE Insufficient license E_PARAMS Size of parameters too short E_PATH E_CONFIG Configuration not found E_PASSWORD Password policy E_CONFLICT Item already exists E_INVALID Item already exists API Variables Configuration Version License Variable Name Type Description C_Version String Server version C_Date String Server release date C_Backup String Cc OS Bool Server OS version 0 Windows 1 Linux C_TimeZone Int Time zone in seconds C_SuiteType Int IceWarp Email Server license type 1 Pro 2 Standard 3 Lite NOTE Deprecated C InstallPath String IceWarp Email Server installation path C ConfigPath String Path to Config folder C WebPath String C SpamPath String C CalendarPath String C PathServicelD String C GUI ReguireAuth Bool Reguire authentification to access Admin console C GUI SafeConfirm Bool Use Safe confirmation C License XMLFile String XML license C License String
80. t 0 C_IM_ProcessingMode Int 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 String C_IM_EmailTransportNode String C_IM_SocksServerlP String Archive History Variable Name Type Description C_IM_Archive_Enable Bool Enable IM archive C_IM_Archive_DeleteAfter Int Delete IM archive after Days C_IM_Presence_History Bool C_IM_Presence_HistoryDelete Int SIP Service Variable Name Type Description C_System_Services_SIP_Enable Bool C_System_Services_SIP_Port Int API Variables C System Services SIP DebugFile String C System Services SIP NoRecordRoute Bool C System Services SIP LocalNet String C System Services SIP RemoteAccessHost String C System Services SIP LocalAccessHost String C System Services SIP OtherProxy String C System Services SIP UseOtherProxy Bool C System Services SIP DisableAnonymousAccess Bool C System Services SIP DisableRegistrar Bool C System Services SIP DisableSymmetricResponseRouting Bool C System Services SIP Calls Bool C System Services SIP CallsFile String C System Services SIP UserCalls Bool C System Services SIP AwayPrefix String C System Services SIP ResetPrefix String C System Services SIP RedialPrefix String C System Services SIP ENUM Bool C System Services SIP SDPP
81. t Responder period Days U_RespondWith String Responder file U_ReplyFrom String Reply from U_RespondBetweenFrom String Responder active from Date U_RespondBetweenTo String Responder active till Date U RespondOnlyifToMe Bool Reply only if to me O U ResponderContent String Auto responder content B amp W List Variable Name Type Description U_BlackWhiteFilter Bool Use B amp W list O U_RulesContentXML String Rules content xml U_IMAPMailbox String IMAP mailbox settings U_PasswordExpired Bool U_MailboxQuota Int U_MailboxSize Int Group Account Group Variable Name Type Description G_Name String Folder name G_Description String Description G_GroupwareShared Bool GroupWare shared G_GroupwareDefaultRights String GroupWare default rights G_GroupwareMailDelivery Bool GroupWare mail delivery G_GroupwareMembers Bool GroupWare members address book Members API Variables Variable Name Type Description G_ListFile String List file Options Variable Name Type Description G_Moderated Int Moderated mode 0 None 1 Client moderated 2 Server moderated G ModeratedPassword String Password G_AVScan Bool Access mode AntiVirus 1 G_AS Bool Access mode Antispam G_QA Bool Access mode Quarantine U_GW_DailyAgenda Bool Sending of daily agenda to group members U_GW_Reminders Bool Sending of reminders t
82. tNow Index Integer dispid 236 procedure RemoteAccountNow Index Integer dispid 237 procedure FTPSyncNow Item Integer dispid 238 procedure ETRNNow Index Integer dispid 239 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 GetLocallPs 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 disp
83. tor_ReportAddress String Disk monitor report address C_System_Tools_Monitor_FreeMem Int Alert if free memory drops below kB O C_System_Tools_Monitor_DiskSize Int Alert if free disk space drops below MB O C_System_Tools_Monitor_CPUUsagePerc Int CPU utilization threshold O C_System_Tools_Monitor_CPUUsagePeriod Int Alert if CPU usage exceeds threshold for Min O Remote Server Watchdog Tool Variable Name Type Description C_System_Tools_RemoteServer_Enable Bool Enable Remote server watchdog O C_System_Tools_RemoteServer_MoreThan Int Server is down if unreachable for Min O C_System_Tools_RemoteServer_Email String Report Email address C_System_Tools_RemoteServer_Schedule Schedule Remote Server Watchdog Schedule C_System_Tools_RemoteServer_NotifyAgain Bool Notify when server is back online O TCP IP Tunnel Tool API Variables 77 Variable Name Type Description C_System_Tools_Tunnel_Enable Bool Enable TCP IP tunnel 0 Server Migration Tool Variable Name Type Description C_System_Tools_Migration_Active Bool Enable Migration 0 C_System_Tools_Migration_Server String Migration source host C_System_Tools_Migration_MigrateService Int Migration service 0 Both 1 POP3 2 IMAP C_System_Tools_Migration_InfoAccount String Migration account C System Tools Migration LogFile String Path to log file C System Tools Migration MessageProcessType Int Acc
84. tring Password C_System_Tools_AutoArchive_Backup_Domains Bool Archive specified domains C_System_Tools_AutoArchive_IMAPArchiveSent String Archive subfolders rename C_System_Tools_AutoArchive_IMAPArchivelnbox String Archive subfolders rename C_System_Tools_AutoArchive_UnknownUsers Bool 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 API Variables AntiSpam Variable Name Type Description C_Mail_ETRN_Count Int Number of ETRN connections O C_Mail_ETRN_Config Int Pointer to ETRN conn configuration C_Mail_ETRN_Schedule Schedule ETRN Schedule AS General Variable Name Type Description C_AS_General_Enable Bool Enable Spam Engine 1 C_AS_General_ProcessingMode Int AS access mode bit 0 All messages 1 All except selected 3 Group 5 Selected domains only 9 Selected accounts only C AS General ProcessingGroup String Access mode group C AS Info UpdateDate String Update date C AS Info UpdateVersion String Update version C AS Info EngineVersion String Engine version C AS Info UpdateSize Int C AS Info BayesWords Int C AS Info BayesSpamMessages Int C AS Info BayesGenuineMessages Int AS Quarantine Variable Name Type Description C AS Challenge ProcessingMode Int CR access mode bit 0 All messages 1 All except selected 85
85. unction Deletelndex 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 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 19 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 Deletelndex function Delete WordBool function Deletelndex Index Integer W
86. val Advanced Variable Name Type Description C_Accounts_Global_LDAP_Synchronize Bool LDAP user synchronization O C_Accounts_Global_LDAP_Host String C_Accounts_Global_LDAP_Base String C_Accounts_Global_LDAP_User String C_Accounts_Global_LDAP_Pass String C_Accounts_Global_Console_ShowAccounts Int Number of shown accounts in a domain 67 68 API Reference Policies 1000 C Accounts Global Console AccountsPosition Int Database account display start position O C Accounts Global Console DomainDescription Int Domain list display mode 0 Domain 1 Description Domain 2 Domain Description Login Policy Variable Name Type Description C Accounts Policies Login Enable Bool Enable Login policy O C Accounts Policies Login Attempts Int Number of failed logins C Accounts Policies Login BlockPeriod Int Block user login for Min C Accounts Policies Login Block Bool 0 Do not block but delay authentication 1 Block account for specified time C Accounts Policies Login LoginSettings Bool Login settings mode 0 login with username 1 login with full email address C_Accounts_Policies_Login_ConvertChars Bool Convert chars to in username 0 C Accounts Policies Login IPRestriction Bool Enables account IP restriction C Accounts Policies Login RevealPasswords Bool C Accounts Policies Login DisableDomainIPLogin Bool C Accounts Policies SuperUser Bool C Acc
87. ystem_Services_LDAP_Bandwidth Int Max transfer bandwidth kB s 0 System Logging API Variables General Variable Name Type Description C System Logging General AppendFiles Bool Append logs to files 1 C System Logging General DeleteOlder Int Delete logs after Days 7 C System Logging General Archive Bool C System Logging General ArchiveTo String C System Logging General LogCache Int Logging cache B 0 C System Logging General LogRotation Int Size of the log file kB O C System Logging General SystemLogFunction Bool Send logs to system log function O C System Logging Syslog Active Bool Send logs to server 0 C System Logging Syslog Server String Syslog server name C System Logging General EnableODBCLog Bool Enable ODBC logging C System Logging General ODBCLogConn String ODBC logging connection C System Logging General LogTimeFormat Int Log time format O sitfTime 1 sitfScientific 2 sitfRFC822 C System Sessions DisableHistory Bool Disable session history Services Variable Name Type Description C System Log Services SMTP Int SMTP service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C System Log Services POP3 Int POP3 service logging level 0 None 1 Debug 2 Summary 3 Debug amp Summary C System Log Services IMAP Int IMAP service logging level 0 None 74 API Reference 1 Debug 2 Summary 3

Download Pdf Manuals

Related Search

Related Contents

CJ Series EtherNet/IP and FH Vision Systems Connection  取付説明書  Sencor SCA BA01 V2 alcohol tester  | Manual Engate Automático  AEG Lavamat 74640 Front Load Washer  MPR 010 Mobile Phase Recycler  EA - Electric Elelevation  MANUEL D`INSTRUCTIONS ET D`ENTRETIEN  Emerson MITX-430 Computer Hardware User Manual  optimis ide  

Copyright © All rights reserved. Failed to retrieve file