IceWarp provides several application programming interfaces for developers and system integrators. IceWarp HTTP API referenced here allows to quickly build web applications and manage services, domains, accounts, folders and many other advanced settings.
IceWarp API serves for purposes of IceWarp HTTP applications like new WebAdmin, but can be also used to build your own application or webservices. See getting started section
IceWarp API requires installed IceWarp server with control service running. API can be accessed in two ways. First is to use web socket connection and the second is via php script.
If you want to connetct via AJAX, you can use for example jquery
Example HTML
<html>
<head>
<script type="text/javascript" src="jquery.js"></script>
<script LANGUAGE="javascript1.2">
function sendQuery()
{
$.ajax(
{
type: "PUT",
url: 'http://localhost/icewarpapi/',
data: $('#input').val(),
success: function(data){
$('#response').html(data);
console.log(data,responsebox);
},
dataType:'text'
}
);
}
// JavaScript Document
</script>
</head>
<body>
<form onsubmit="sendQuery();">
Input: <textarea id="input" cols="50" rows="20"><iq> <query xmlns="admin:iq:rpc"> <commandname>getauthchallenge</commandname> <commandparams> <authtype>1</authtype> </commandparams> </query> </iq>
</textarea>
Response: <textarea id="response" cols="50" rows="20"></textarea>
<button type="button" onclick="sendQuery();return false;">Send</button>
</form>
</body>
</html>
If you want to connetct via websockets , your webserver has to be running with IceWarp PHP extension enabled ( icewarpphp.dll ).
Then you can put php script in your web directory and execute the call.
Example PHP
<?php
$request = '<iq> <query xmlns="admin:iq:rpc"> <commandname>getauthchallenge</commandname> <commandparams> <authtype>1</authtype> </commandparams> </query> </iq>';
$response = icewarp_apitunnel($request);
echo 'Request:'. htmlspecialchars($request).'<br/>';
echo 'Response:'. htmlspecialchars($response);
?>For now you are able to authenticate with IceWarp account that has Administrator or Domain administrator rights. By default, administrators are able to edit everything on server in all domains and all accounts. Domain administrators can edit only their own domain and only some domain properties. You can change this by creating or editing domain permissions file in account's mailbox directory ( {installpath}/mail/{domain}/{account}/ by default ).
All communication (request <-> response ) is logged into {installpath}/logs/api/{serverID}{date}.log if API logs are enabled (System ~ Logging ~ Debug ~ API logs )
They are used for authentication with administrator or domain administrator account. If you want to authenticate using plain text, you can simply use authenticate(0,Email,Password). If you want to log in using RSA, you have to first retreive RSA public key modulus (hash) with method GetAuthChallenge, so you will be able to encrypt the password properly. This hash is valid for 5 minutes, after that you have to get new hash. Important is to store session id value ( returned in sid="" attribute of IQ tag when result is true ). Note that this session id should be stored securely. If you want to destroy your session ,use Logout method.
Get the challenge string for RSA authentication type
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getauthchallenge</commandname>
<commandparams>
<authtype>enumval</authtype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<classname>tauthchallenge</classname>
<hashid>stringval</hashid>
<timestamp>intval</timestamp>
</result>
</query>
</iq>
Authenticates and returns authentication token that can be used for both webadmin and webclient
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getauthtoken</commandname>
<commandparams>
<authtype>enumval</authtype>
<email>stringval</email>
<password>stringval</password>
<digest>stringval</digest>
<persistentlogin>enumval</persistentlogin>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<email>stringval</email>
<name>
<classname>taccountname</classname>
<name>stringval</name>
<surname>stringval</surname>
</name>
<avatartoken>stringval</avatartoken>
<authtoken>stringval</authtoken>
</result>
</query>
</iq>
Authenticates user in IceWarp server and creates his session
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>authenticate</commandname>
<commandparams>
<authtype>enumval</authtype>
<email>stringval</email>
<password>stringval</password>
<digest>stringval</digest>
<persistentlogin>enumval</persistentlogin>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Authenticates gateway account ( account that does not exist on current server , but hash some quarantine here )
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>authenticategateway</commandname>
<commandparams>
<hash>stringval</hash>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Authenticates using weblclient session id
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>authenticatewebclient</commandname>
<commandparams>
<webclientsessionid>stringval</webclientsessionid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Authenticates using authentication token
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>authenticatetoken</commandname>
<commandparams>
<token>stringval</token>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Sends the authentication link ( with Hash ) to the email
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>sendgatewayauthentication</commandname>
<commandparams>
<email>stringval</email>
<captcharequest>
<uid>stringval</uid>
<value>stringval</value>
</captcharequest>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Logs the user out and destroy his session
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>logout</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Info about active session , see TAPISessionInfo for more details
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getsessioninfo</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<email>stringval</email>
<domain>stringval</domain>
<admintype>enumval</admintype>
<isgateway>enumval</isgateway>
<name>
<classname>taccountname</classname>
<name>stringval</name>
<surname>stringval</surname>
</name>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
<avatartoken>stringval</avatartoken>
</result>
</query>
</iq>
These methods are used to work with server variables. It allows you to get or set server properties according to session permissions.It also allows you to browser Server API Console and get the complete list of API variables used for translation of API console comments
Gets the rights for server properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getmyserverrights</commandname>
<commandparams>
<serverpropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</serverpropertylist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Gets the values of server properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getserverproperties</commandname>
<commandparams>
<serverpropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</serverpropertylist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Sets the values of server properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setserverproperties</commandname>
<commandparams>
<propertyvaluelist>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tdomainoutlookpolicies</classname>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountrespondermessage</classname>
<from>stringval</from>
<subject>stringval</subject>
<text>stringval</text>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</propertyvaluelist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the list of server api variables, its values, data types and rights
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getserverapiconsole</commandname>
<commandparams>
<filter>
<mask>stringval</mask>
<groups>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</groups>
<clear>enumval</clear>
</filter>
<offset>intval</offset>
<count>intval</count>
<comments>enumval</comments>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tdomainoutlookpolicies</classname>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tdomainoutlookpolicies</classname>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
</result>
</query>
</iq>
Gets the list of all api variables and its comments
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getallapivariables</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<name>stringval</name>
<comment>stringval</comment>
</item>
<item>
<name>stringval</name>
<comment>stringval</comment>
</item>
</result>
</query>
</iq>
These methods allows you to work with domains.There is a possibility to create or rename domain, set or get its properties, get the rights, get the list of domains or access domain API console
Get the informations about domains available in current session
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getdomainsinfolist</commandname>
<commandparams>
<filter>
<namemask>stringval</namemask>
<typemask>stringval</typemask>
</filter>
<offset>intval</offset>
<count>intval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<name>stringval</name>
<desc>stringval</desc>
<domaintype>intval</domaintype>
<accountcount>intval</accountcount>
</item>
<item>
<name>stringval</name>
<desc>stringval</desc>
<domaintype>intval</domaintype>
<accountcount>intval</accountcount>
</item>
</result>
</query>
</iq>
Deletes the domain on IceWarp server
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deletedomain</commandname>
<commandparams>
<domainstr>stringval</domainstr>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Renames the domain on IceWarp server
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>renamedomain</commandname>
<commandparams>
<oldname>stringval</oldname>
<newname>stringval</newname>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Creates the domain on IceWarp server
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>createdomain</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<domainproperties>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystring</classname>
<val>stringval</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</domainproperties>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Makes the primary domain from one of the domains on IceWarp server
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>makedomainprimary</commandname>
<commandparams>
<domainstr>stringval</domainstr>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the rights for domain properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getmydomainrigths</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<domainpropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</domainpropertylist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Gets the values of domain properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getdomainproperties</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<domainpropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</domainpropertylist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountcard</classname>
<body>stringval</body>
<anniversary>stringval</anniversary>
<birthday>stringval</birthday>
<assistantname>stringval</assistantname>
<companyname>stringval</companyname>
<department>stringval</department>
<fileas>stringval</fileas>
<firstname>stringval</firstname>
<jobtitle>stringval</jobtitle>
<lastname>stringval</lastname>
<managername>stringval</managername>
<middlename>stringval</middlename>
<nickname>stringval</nickname>
<officelocation>stringval</officelocation>
<spouse>stringval</spouse>
<suffix>stringval</suffix>
<title>stringval</title>
<webpage>stringval</webpage>
<certificate>stringval</certificate>
<freebusyurl>stringval</freebusyurl>
<profession>stringval</profession>
<sensitivity>stringval</sensitivity>
<gender>stringval</gender>
<businessaddresscity>stringval</businessaddresscity>
<businessaddresscountry>stringval</businessaddresscountry>
<businessaddresspostalcode>stringval</businessaddresspostalcode>
<businessaddressstate>stringval</businessaddressstate>
<businessaddressstreet>stringval</businessaddressstreet>
<businessaddresspostofficebox>stringval</businessaddresspostofficebox>
<homeaddresscity>stringval</homeaddresscity>
<homeaddresscountry>stringval</homeaddresscountry>
<homeaddresspostalcode>stringval</homeaddresspostalcode>
<homeaddressstate>stringval</homeaddressstate>
<homeaddressstreet>stringval</homeaddressstreet>
<homeaddresspostofficebox>stringval</homeaddresspostofficebox>
<email1address>stringval</email1address>
<email2address>stringval</email2address>
<email3address>stringval</email3address>
<imaddress>stringval</imaddress>
<homepage>stringval</homepage>
<homepage2>stringval</homepage2>
<assistnametelephonenumber>stringval</assistnametelephonenumber>
<businessfaxnumber>stringval</businessfaxnumber>
<businesstelephonenumber>stringval</businesstelephonenumber>
<business2telephonenumber>stringval</business2telephonenumber>
<cartelephonenumber>stringval</cartelephonenumber>
<companymaintelephonenumber>stringval</companymaintelephonenumber>
<homefaxnumber>stringval</homefaxnumber>
<hometelephonenumber>stringval</hometelephonenumber>
<home2telephonenumber>stringval</home2telephonenumber>
<mobiletelephonenumber>stringval</mobiletelephonenumber>
<pagernumber>stringval</pagernumber>
<radiotelephonenumber>stringval</radiotelephonenumber>
<callbacktelephonenumber>stringval</callbacktelephonenumber>
<isdnnumber>stringval</isdnnumber>
<otherfaxnumber>stringval</otherfaxnumber>
<primarytelephonenumber>stringval</primarytelephonenumber>
<telexnumber>stringval</telexnumber>
<hearingnumber>stringval</hearingnumber>
<othernumber>stringval</othernumber>
<categories>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</categories>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountcard</classname>
<body>stringval</body>
<anniversary>stringval</anniversary>
<birthday>stringval</birthday>
<assistantname>stringval</assistantname>
<companyname>stringval</companyname>
<department>stringval</department>
<fileas>stringval</fileas>
<firstname>stringval</firstname>
<jobtitle>stringval</jobtitle>
<lastname>stringval</lastname>
<managername>stringval</managername>
<middlename>stringval</middlename>
<nickname>stringval</nickname>
<officelocation>stringval</officelocation>
<spouse>stringval</spouse>
<suffix>stringval</suffix>
<title>stringval</title>
<webpage>stringval</webpage>
<certificate>stringval</certificate>
<freebusyurl>stringval</freebusyurl>
<profession>stringval</profession>
<sensitivity>stringval</sensitivity>
<gender>stringval</gender>
<businessaddresscity>stringval</businessaddresscity>
<businessaddresscountry>stringval</businessaddresscountry>
<businessaddresspostalcode>stringval</businessaddresspostalcode>
<businessaddressstate>stringval</businessaddressstate>
<businessaddressstreet>stringval</businessaddressstreet>
<businessaddresspostofficebox>stringval</businessaddresspostofficebox>
<homeaddresscity>stringval</homeaddresscity>
<homeaddresscountry>stringval</homeaddresscountry>
<homeaddresspostalcode>stringval</homeaddresspostalcode>
<homeaddressstate>stringval</homeaddressstate>
<homeaddressstreet>stringval</homeaddressstreet>
<homeaddresspostofficebox>stringval</homeaddresspostofficebox>
<email1address>stringval</email1address>
<email2address>stringval</email2address>
<email3address>stringval</email3address>
<imaddress>stringval</imaddress>
<homepage>stringval</homepage>
<homepage2>stringval</homepage2>
<assistnametelephonenumber>stringval</assistnametelephonenumber>
<businessfaxnumber>stringval</businessfaxnumber>
<businesstelephonenumber>stringval</businesstelephonenumber>
<business2telephonenumber>stringval</business2telephonenumber>
<cartelephonenumber>stringval</cartelephonenumber>
<companymaintelephonenumber>stringval</companymaintelephonenumber>
<homefaxnumber>stringval</homefaxnumber>
<hometelephonenumber>stringval</hometelephonenumber>
<home2telephonenumber>stringval</home2telephonenumber>
<mobiletelephonenumber>stringval</mobiletelephonenumber>
<pagernumber>stringval</pagernumber>
<radiotelephonenumber>stringval</radiotelephonenumber>
<callbacktelephonenumber>stringval</callbacktelephonenumber>
<isdnnumber>stringval</isdnnumber>
<otherfaxnumber>stringval</otherfaxnumber>
<primarytelephonenumber>stringval</primarytelephonenumber>
<telexnumber>stringval</telexnumber>
<hearingnumber>stringval</hearingnumber>
<othernumber>stringval</othernumber>
<categories>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</categories>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Sets the values of domain properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setdomainproperties</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<propertyvaluelist>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</propertyvaluelist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the list of domain api variables, its values, data types and rights
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getdomainapiconsole</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<filter>
<mask>stringval</mask>
<groups>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</groups>
<clear>enumval</clear>
</filter>
<offset>intval</offset>
<count>intval</count>
<comments>enumval</comments>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountcard</classname>
<body>stringval</body>
<anniversary>stringval</anniversary>
<birthday>stringval</birthday>
<assistantname>stringval</assistantname>
<companyname>stringval</companyname>
<department>stringval</department>
<fileas>stringval</fileas>
<firstname>stringval</firstname>
<jobtitle>stringval</jobtitle>
<lastname>stringval</lastname>
<managername>stringval</managername>
<middlename>stringval</middlename>
<nickname>stringval</nickname>
<officelocation>stringval</officelocation>
<spouse>stringval</spouse>
<suffix>stringval</suffix>
<title>stringval</title>
<webpage>stringval</webpage>
<certificate>stringval</certificate>
<freebusyurl>stringval</freebusyurl>
<profession>stringval</profession>
<sensitivity>stringval</sensitivity>
<gender>stringval</gender>
<businessaddresscity>stringval</businessaddresscity>
<businessaddresscountry>stringval</businessaddresscountry>
<businessaddresspostalcode>stringval</businessaddresspostalcode>
<businessaddressstate>stringval</businessaddressstate>
<businessaddressstreet>stringval</businessaddressstreet>
<businessaddresspostofficebox>stringval</businessaddresspostofficebox>
<homeaddresscity>stringval</homeaddresscity>
<homeaddresscountry>stringval</homeaddresscountry>
<homeaddresspostalcode>stringval</homeaddresspostalcode>
<homeaddressstate>stringval</homeaddressstate>
<homeaddressstreet>stringval</homeaddressstreet>
<homeaddresspostofficebox>stringval</homeaddresspostofficebox>
<email1address>stringval</email1address>
<email2address>stringval</email2address>
<email3address>stringval</email3address>
<imaddress>stringval</imaddress>
<homepage>stringval</homepage>
<homepage2>stringval</homepage2>
<assistnametelephonenumber>stringval</assistnametelephonenumber>
<businessfaxnumber>stringval</businessfaxnumber>
<businesstelephonenumber>stringval</businesstelephonenumber>
<business2telephonenumber>stringval</business2telephonenumber>
<cartelephonenumber>stringval</cartelephonenumber>
<companymaintelephonenumber>stringval</companymaintelephonenumber>
<homefaxnumber>stringval</homefaxnumber>
<hometelephonenumber>stringval</hometelephonenumber>
<home2telephonenumber>stringval</home2telephonenumber>
<mobiletelephonenumber>stringval</mobiletelephonenumber>
<pagernumber>stringval</pagernumber>
<radiotelephonenumber>stringval</radiotelephonenumber>
<callbacktelephonenumber>stringval</callbacktelephonenumber>
<isdnnumber>stringval</isdnnumber>
<otherfaxnumber>stringval</otherfaxnumber>
<primarytelephonenumber>stringval</primarytelephonenumber>
<telexnumber>stringval</telexnumber>
<hearingnumber>stringval</hearingnumber>
<othernumber>stringval</othernumber>
<categories>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</categories>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
</result>
</query>
</iq>
Gets the domain informations ( currently used for DNS valiadation only )
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getdomaininformations</commandname>
<commandparams>
<domainstr>stringval</domainstr>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<general>
<name>stringval</name>
<defaultalias>stringval</defaultalias>
<email>stringval</email>
<usercount>intval</usercount>
<userlimit>intval</userlimit>
<ipaddress>stringval</ipaddress>
<hostname>stringval</hostname>
<domaintype>enumval</domaintype>
<expireson>stringval</expireson>
</general>
<dns>
<records>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
</records>
</dns>
</result>
</query>
</iq>
These methods allows you to work with accounts.There is a possibility to create ,edit and delete accounts, set or get account properties, get and set the account folders permissions. There are methods for managing passwords ( expire, modify, generate ), activation keys, account members and as well methods for accessing account API console
Get the list of informations about accounts in sepcified IceWarp domain
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getaccountsinfolist</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<filter>
<namemask>stringval</namemask>
<typemask>stringval</typemask>
</filter>
<offset>intval</offset>
<count>intval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<name>stringval</name>
<email>stringval</email>
<displayemail>stringval</displayemail>
<accounttype>intval</accounttype>
<admintype>enumval</admintype>
<quota>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</quota>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
</item>
<item>
<name>stringval</name>
<email>stringval</email>
<displayemail>stringval</displayemail>
<accounttype>intval</accounttype>
<admintype>enumval</admintype>
<quota>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</quota>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
</item>
</result>
</query>
</iq>
Creates an account in sepcified IceWarp domain
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>createaccount</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<accountproperties>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountoutlookpolicies</classname>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountstate</classname>
<state>enumval</state>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</accountproperties>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes the list of accounts in sepcified IceWarp domain
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deleteaccounts</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<accountlist>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</accountlist>
<leavedata>enumval</leavedata>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes all accounts that matches current filter in sepcified IceWarp domain
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deleteallaccounts</commandname>
<commandparams>
<domainstr>stringval</domainstr>
<filter>
<namemask>stringval</namemask>
<typemask>stringval</typemask>
</filter>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the properties of the existing IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getaccountproperties</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<accountpropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</accountpropertylist>
<accountpropertyset>enumval</accountpropertyset>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Sets the properties of the existing IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setaccountproperties</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<propertyvaluelist>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountrespondermessage</classname>
<from>stringval</from>
<subject>stringval</subject>
<text>stringval</text>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</propertyvaluelist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the list of IMAP and GroupWare folders in specified IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getaccountfolderlist</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<onlydefault>enumval</onlydefault>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
</subfolders>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
</subfolders>
</item>
</subfolders>
</result>
</query>
</iq>
Gets the permission list for the folder specified by account email and folderid
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getaccountfolderpermissions</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<folderid>stringval</folderid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<account>stringval</account>
<permissions>stringval</permissions>
</item>
<item>
<account>stringval</account>
<permissions>stringval</permissions>
</item>
</result>
</query>
</iq>
Sets the list of permissions for specified folder in existing IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setaccountfolderpermissions</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<folderid>stringval</folderid>
<permissions>
<item>
<account>stringval</account>
<permissions>stringval</permissions>
</item>
<item>
<account>stringval</account>
<permissions>stringval</permissions>
</item>
</permissions>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Inherits the permissions of specified folder from higher level
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>inheritaccountfolderpermissions</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<folderid>stringval</folderid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Inherits the permissions of specified folder from higher level
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getaccountadministrativepermissions</commandname>
<commandparams>
<accountemail>stringval</accountemail>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<domainspermissions>
<item>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</item>
<item>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</item>
</domainspermissions>
<globalpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</globalpermissions>
</result>
</query>
</iq>
Changes the password of existing IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setaccountpassword</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<authtype>enumval</authtype>
<password>stringval</password>
<digest>stringval</digest>
<ignorepolicy>enumval</ignorepolicy>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Generates the password of existing IceWarp account according to current Password policy
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>generateaccountpassword</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
Expires the current password of existing IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>expireaccountpassword</commandname>
<commandparams>
<accountemail>stringval</accountemail>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Generates activation key for IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>generateaccountactivationkey</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<keytype>enumval</keytype>
<description>stringval</description>
<count>stringval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
Sends the activation key for IceWarp account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>sendaccountactivationkey</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<keytype>enumval</keytype>
<description>stringval</description>
<count>stringval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Adds the members to the specified IceWarp account. Available for groups and mailing lists
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>addaccountmembers</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<members>
<classname>tpropertymembers</classname>
<val>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
</val>
</members>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Adds the members to the specified IceWarp account. Members are specified by IceWarp domain name and current account filter. Available for groups and mailing lists
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>addallaccountmembers</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<domainstr>stringval</domainstr>
<filter>
<namemask>stringval</namemask>
<typemask>stringval</typemask>
</filter>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes the members from the specified IceWarp account. Available for groups and mailing lists
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deleteaccountmembers</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<members>
<classname>tpropertymembers</classname>
<val>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
</val>
</members>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes all members from the IceWarp account. Available for groups and mailing lists
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deleteallaccountmembers</commandname>
<commandparams>
<accountemail>stringval</accountemail>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the list of account api variables, its values, data types and rights
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getaccountapiconsole</commandname>
<commandparams>
<accountemail>stringval</accountemail>
<filter>
<mask>stringval</mask>
<groups>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</groups>
<clear>enumval</clear>
</filter>
<offset>intval</offset>
<count>intval</count>
<comments>enumval</comments>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystring</classname>
<val>stringval</val>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tdomainoutlookpolicies</classname>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
</result>
</query>
</iq>
These methods allows you to work with accounts.There is a possibility to create ,edit and delete accounts, set or get account properties, get and set the account folders permissions. There are methods for managing passwords ( expire, modify, generate ), activation keys, account members and as well methods for accessing account API console
Get the info list of server, domain or account rules
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getrulesinfolist</commandname>
<commandparams>
<who>stringval</who>
<filter>
<namemask>stringval</namemask>
</filter>
<offset>intval</offset>
<count>intval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<ruleid>stringval</ruleid>
<title>stringval</title>
<active>enumval</active>
<actiontype>enumval</actiontype>
<condition>
<classname>trulesmtpauthcondition</classname>
</condition>
</item>
<item>
<ruleid>stringval</ruleid>
<title>stringval</title>
<active>enumval</active>
<actiontype>enumval</actiontype>
<condition>
<classname>trulesmtpauthcondition</classname>
</condition>
</item>
</result>
</query>
</iq>
Returns detailed information about rule specified by Who and RuleID
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getrule</commandname>
<commandparams>
<who>stringval</who>
<ruleid>stringval</ruleid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<conditions>
<item>
<classname>truleisspamcondition</classname>
</item>
<item>
<classname>trulesmtpauthcondition</classname>
</item>
</conditions>
<actions>
<item>
<classname>trulesetflagsaction</classname>
<flagged>enumval</flagged>
<seen>enumval</seen>
<junk>enumval</junk>
<notjunk>enumval</notjunk>
<label1>enumval</label1>
<label2>enumval</label2>
<label3>enumval</label3>
<label4>enumval</label4>
<label5>enumval</label5>
<label6>enumval</label6>
</item>
<item>
<classname>trulestopaction</classname>
</item>
</actions>
<title>stringval</title>
<active>enumval</active>
<ruleid>intval</ruleid>
</result>
</query>
</iq>
Creates new rule from RuleSettings
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>addrule</commandname>
<commandparams>
<who>stringval</who>
<rulesettings>
<conditions>
<item>
<classname>truletrustedsessioncondition</classname>
</item>
<item>
<classname>truleprioritycondition</classname>
<priority>enumval</priority>
</item>
</conditions>
<actions>
<item>
<classname>trulesendmessageaction</classname>
<messagefrom>stringval</messagefrom>
<messageto>stringval</messageto>
<messagesubject>stringval</messagesubject>
<messagetext>stringval</messagetext>
</item>
<item>
<classname>trulestopaction</classname>
</item>
</actions>
<title>stringval</title>
<active>enumval</active>
<ruleid>intval</ruleid>
</rulesettings>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Edits RuleSettings of existing rule specified by Id
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>editrule</commandname>
<commandparams>
<who>stringval</who>
<rulesettings>
<conditions>
<item>
<classname>trulednsblcondition</classname>
<server>stringval</server>
<regex>stringval</regex>
</item>
<item>
<classname>trulesomewordscondition</classname>
<matchfunction>enumval</matchfunction>
<matchvalue>stringval</matchvalue>
<matchcase>enumval</matchcase>
<matchwholewordsonly>enumval</matchwholewordsonly>
<notmatch>enumval</notmatch>
<multipleitemsmatch>enumval</multipleitemsmatch>
<parsexml>enumval</parsexml>
</item>
</conditions>
<actions>
<item>
<classname>truleforwardtoemailaction</classname>
<email>stringval</email>
</item>
<item>
<classname>trulecopytofolderaction</classname>
<folder>stringval</folder>
</item>
</actions>
<title>stringval</title>
<active>enumval</active>
<ruleid>intval</ruleid>
</rulesettings>
<ruleid>stringval</ruleid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes existing rule specified by Id
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deleterule</commandname>
<commandparams>
<who>stringval</who>
<ruleid>stringval</ruleid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Move specified Rule up or down
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>moverule</commandname>
<commandparams>
<who>stringval</who>
<ruleid>stringval</ruleid>
<movetype>enumval</movetype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
These methods allows you to work with accounts.There is a possibility to create ,edit and delete accounts, set or get account properties, get and set the account folders permissions. There are methods for managing passwords ( expire, modify, generate ), activation keys, account members and as well methods for accessing account API console
Get the info list of server, domain or account mobile devices
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getdevicesinfolist</commandname>
<commandparams>
<who>stringval</who>
<filter>
<namemask>stringval</namemask>
<status>enumval</status>
<lastsync>intval</lastsync>
</filter>
<offset>intval</offset>
<count>intval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<deviceid>stringval</deviceid>
<id>stringval</id>
<account>stringval</account>
<name>stringval</name>
<devicetype>stringval</devicetype>
<model>stringval</model>
<os>stringval</os>
<protocolversion>stringval</protocolversion>
<registered>stringval</registered>
<lastsync>stringval</lastsync>
<remotewipe>enumval</remotewipe>
<status>enumval</status>
</item>
<item>
<deviceid>stringval</deviceid>
<id>stringval</id>
<account>stringval</account>
<name>stringval</name>
<devicetype>stringval</devicetype>
<model>stringval</model>
<os>stringval</os>
<protocolversion>stringval</protocolversion>
<registered>stringval</registered>
<lastsync>stringval</lastsync>
<remotewipe>enumval</remotewipe>
<status>enumval</status>
</item>
</result>
</query>
</iq>
Gets mobile device properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getdeviceproperties</commandname>
<commandparams>
<deviceid>stringval</deviceid>
<devicepropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</devicepropertylist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountcard</classname>
<body>stringval</body>
<anniversary>stringval</anniversary>
<birthday>stringval</birthday>
<assistantname>stringval</assistantname>
<companyname>stringval</companyname>
<department>stringval</department>
<fileas>stringval</fileas>
<firstname>stringval</firstname>
<jobtitle>stringval</jobtitle>
<lastname>stringval</lastname>
<managername>stringval</managername>
<middlename>stringval</middlename>
<nickname>stringval</nickname>
<officelocation>stringval</officelocation>
<spouse>stringval</spouse>
<suffix>stringval</suffix>
<title>stringval</title>
<webpage>stringval</webpage>
<certificate>stringval</certificate>
<freebusyurl>stringval</freebusyurl>
<profession>stringval</profession>
<sensitivity>stringval</sensitivity>
<gender>stringval</gender>
<businessaddresscity>stringval</businessaddresscity>
<businessaddresscountry>stringval</businessaddresscountry>
<businessaddresspostalcode>stringval</businessaddresspostalcode>
<businessaddressstate>stringval</businessaddressstate>
<businessaddressstreet>stringval</businessaddressstreet>
<businessaddresspostofficebox>stringval</businessaddresspostofficebox>
<homeaddresscity>stringval</homeaddresscity>
<homeaddresscountry>stringval</homeaddresscountry>
<homeaddresspostalcode>stringval</homeaddresspostalcode>
<homeaddressstate>stringval</homeaddressstate>
<homeaddressstreet>stringval</homeaddressstreet>
<homeaddresspostofficebox>stringval</homeaddresspostofficebox>
<email1address>stringval</email1address>
<email2address>stringval</email2address>
<email3address>stringval</email3address>
<imaddress>stringval</imaddress>
<homepage>stringval</homepage>
<homepage2>stringval</homepage2>
<assistnametelephonenumber>stringval</assistnametelephonenumber>
<businessfaxnumber>stringval</businessfaxnumber>
<businesstelephonenumber>stringval</businesstelephonenumber>
<business2telephonenumber>stringval</business2telephonenumber>
<cartelephonenumber>stringval</cartelephonenumber>
<companymaintelephonenumber>stringval</companymaintelephonenumber>
<homefaxnumber>stringval</homefaxnumber>
<hometelephonenumber>stringval</hometelephonenumber>
<home2telephonenumber>stringval</home2telephonenumber>
<mobiletelephonenumber>stringval</mobiletelephonenumber>
<pagernumber>stringval</pagernumber>
<radiotelephonenumber>stringval</radiotelephonenumber>
<callbacktelephonenumber>stringval</callbacktelephonenumber>
<isdnnumber>stringval</isdnnumber>
<otherfaxnumber>stringval</otherfaxnumber>
<primarytelephonenumber>stringval</primarytelephonenumber>
<telexnumber>stringval</telexnumber>
<hearingnumber>stringval</hearingnumber>
<othernumber>stringval</othernumber>
<categories>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</categories>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertymembers</classname>
<val>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Sets mobile device properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setdeviceproperties</commandname>
<commandparams>
<deviceid>stringval</deviceid>
<propertyvaluelist>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tauthchallenge</classname>
<hashid>stringval</hashid>
<timestamp>intval</timestamp>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</propertyvaluelist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes mobile device(s)
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deletedevices</commandname>
<commandparams>
<deviceslist>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</deviceslist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Marks selected mobile device for remote wipe
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setdevicewipe</commandname>
<commandparams>
<deviceid>stringval</deviceid>
<wipetype>enumval</wipetype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Sets the specified mobile device status
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setdevicestatus</commandname>
<commandparams>
<deviceid>stringval</deviceid>
<statustype>enumval</statustype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes the mobile devices that matches current Who and Filter
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deletealldevices</commandname>
<commandparams>
<who>stringval</who>
<filter>
<namemask>stringval</namemask>
<status>enumval</status>
<lastsync>intval</lastsync>
</filter>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Sets the status of all mobile devices that mathces current Who and Filter
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setalldevicesstatus</commandname>
<commandparams>
<who>stringval</who>
<filter>
<namemask>stringval</namemask>
<status>enumval</status>
<lastsync>intval</lastsync>
</filter>
<statustype>enumval</statustype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
These methods allows you to work with accounts.There is a possibility to create ,edit and delete accounts, set or get account properties, get and set the account folders permissions. There are methods for managing passwords ( expire, modify, generate ), activation keys, account members and as well methods for accessing account API console
Gets webclient setting properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getwebmailresource</commandname>
<commandparams>
<resource>stringval</resource>
<level>enumval</level>
<selector>stringval</selector>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</result>
</query>
</iq>
Gets webclient setting properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getwebmailresources</commandname>
<commandparams>
<resources>
<item>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</item>
<item>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</item>
</resources>
<level>enumval</level>
<selector>stringval</selector>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<list>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
</list>
</result>
</query>
</iq>
Sets webclient settings resources
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setwebmailresources</commandname>
<commandparams>
<resources>
<list>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
</list>
</resources>
<level>enumval</level>
<selector>stringval</selector>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets admin setting properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getadminresources</commandname>
<commandparams>
<resources>
<item>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</item>
<item>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</item>
</resources>
<level>enumval</level>
<selector>stringval</selector>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<list>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
</list>
</result>
</query>
</iq>
Sets admin settings resources
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setadminresources</commandname>
<commandparams>
<resources>
<list>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
</list>
</resources>
<level>enumval</level>
<selector>stringval</selector>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
These methods allows you to work with accounts.There is a possibility to create ,edit and delete accounts, set or get account properties, get and set the account folders permissions. There are methods for managing passwords ( expire, modify, generate ), activation keys, account members and as well methods for accessing account API console
Gets server statistic properties
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getstatisticsproperties</commandname>
<commandparams>
<statisticspropertylist>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</statisticspropertylist>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertymembers</classname>
<val>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</result>
</query>
</iq>
Gets the info list of IceWarp services
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getservicesinfolist</commandname>
<commandparams>
<filter>
<mask>stringval</mask>
</filter>
<offset>intval</offset>
<count>intval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<servicetype>enumval</servicetype>
<uptime>intval</uptime>
<connections>intval</connections>
<maxconnections>intval</maxconnections>
<data>intval</data>
<isrunning>enumval</isrunning>
</item>
<item>
<servicetype>enumval</servicetype>
<uptime>intval</uptime>
<connections>intval</connections>
<maxconnections>intval</maxconnections>
<data>intval</data>
<isrunning>enumval</isrunning>
</item>
</result>
</query>
</iq>
Get the statistics for specified IceWarp service
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getservicestatistics</commandname>
<commandparams>
<stype>enumval</stype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<classname>tservicevoipstatistics</classname>
<packetsreceived>intval</packetsreceived>
<packetssent>intval</packetssent>
<rtppacketsreceived>intval</rtppacketsreceived>
<rtppacketssent>intval</rtppacketssent>
<callcount>intval</callcount>
<callpeak>intval</callpeak>
<calltotal>intval</calltotal>
</result>
</query>
</iq>
Check if specified IceWarp service is running or not
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>isservicerunning</commandname>
<commandparams>
<service>enumval</service>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Starts the specified IceWarp service
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>startservice</commandname>
<commandparams>
<service>enumval</service>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Stops the specified IceWarp service
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>stopservice</commandname>
<commandparams>
<service>enumval</service>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Restarts the specified IceWarp service
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>restartservice</commandname>
<commandparams>
<service>enumval</service>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Gets the traffic chart data for specified IceWarp service
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>gettrafficcharts</commandname>
<commandparams>
<stype>enumval</stype>
<charttype>enumval</charttype>
<count>intval</count>
<period>enumval</period>
<ffrom>stringval</ffrom>
<fto>stringval</fto>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<list>
<item>
<v>realval</v>
<d>stringval</d>
</item>
<item>
<v>realval</v>
<d>stringval</d>
</item>
</list>
</result>
</query>
</iq>
These methods allows you to work with spam queues.
Gets the spam queue list
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getspamqueueinfolist</commandname>
<commandparams>
<queuetype>enumval</queuetype>
<filter>
<mask>stringval</mask>
<sender>stringval</sender>
<owner>stringval</owner>
<domain>stringval</domain>
</filter>
<offset>intval</offset>
<count>intval</count>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<itemid>stringval</itemid>
<sender>stringval</sender>
<date>stringval</date>
<owner>stringval</owner>
<domain>stringval</domain>
<subject>stringval</subject>
<queuetype>enumval</queuetype>
<folder>stringval</folder>
</item>
<item>
<itemid>stringval</itemid>
<sender>stringval</sender>
<date>stringval</date>
<owner>stringval</owner>
<domain>stringval</domain>
<subject>stringval</subject>
<queuetype>enumval</queuetype>
<folder>stringval</folder>
</item>
</result>
</query>
</iq>
Adds the item to the Spam Queues ( whitelist / blacklist )
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>addspamqueueitem</commandname>
<commandparams>
<info>
<itemid>stringval</itemid>
<sender>stringval</sender>
<date>stringval</date>
<owner>stringval</owner>
<domain>stringval</domain>
<subject>stringval</subject>
<queuetype>enumval</queuetype>
<folder>stringval</folder>
</info>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes the item from Spam Queues
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deletespamqueueitem</commandname>
<commandparams>
<itemid>stringval</itemid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Delivers the item in Spam Queue ( quarantine )
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deliverspamqueueitem</commandname>
<commandparams>
<itemid>stringval</itemid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Blacklist the item in Spam Queue
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>blacklistspamqueueitem</commandname>
<commandparams>
<itemid>stringval</itemid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Whitelist the item in Spam Queue
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>whitelistspamqueueitem</commandname>
<commandparams>
<itemid>stringval</itemid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Returns the body of Spam Queue item
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getspamqueueitembody</commandname>
<commandparams>
<itemid>stringval</itemid>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
These methods allows you to work with server certificates.It allows to create new server certificate. It also allows to create,edit,delete and set as default any existing certificate on server.
Rertrieves the list of server certificates
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getservercertificatelist</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<item>
<id>stringval</id>
<bits>intval</bits>
<cn>stringval</cn>
<expiration>stringval</expiration>
<fingerprint>stringval</fingerprint>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<hostname>
<item>item 1</item>
<item>item2</item>
</hostname>
<issuer>stringval</issuer>
<subject>stringval</subject>
<isdefault>enumval</isdefault>
<iscsr>enumval</iscsr>
<certtype>enumval</certtype>
<automaticengine>enumval</automaticengine>
<verify>enumval</verify>
<status>enumval</status>
<subjectinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</subjectinfo>
<issuerinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</issuerinfo>
<error>
<lastattempt>intval</lastattempt>
<lasterror>intval</lasterror>
<faileddomains>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</faileddomains>
</error>
</item>
<item>
<id>stringval</id>
<bits>intval</bits>
<cn>stringval</cn>
<expiration>stringval</expiration>
<fingerprint>stringval</fingerprint>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<hostname>
<item>item 1</item>
<item>item2</item>
</hostname>
<issuer>stringval</issuer>
<subject>stringval</subject>
<isdefault>enumval</isdefault>
<iscsr>enumval</iscsr>
<certtype>enumval</certtype>
<automaticengine>enumval</automaticengine>
<verify>enumval</verify>
<status>enumval</status>
<subjectinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</subjectinfo>
<issuerinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</issuerinfo>
<error>
<lastattempt>intval</lastattempt>
<lasterror>intval</lasterror>
<faileddomains>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</faileddomains>
</error>
</item>
</result>
</query>
</iq>
Add new server certificate (uploaded)
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>addservercertificate</commandname>
<commandparams>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<certificate>stringval</certificate>
<setasdefault>enumval</setasdefault>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
Create new CSR / Server certificate
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>createservercertificate</commandname>
<commandparams>
<certificate>
<bits>intval</bits>
<validfordays>intval</validfordays>
<country>stringval</country>
<state>stringval</state>
<city>stringval</city>
<organization>stringval</organization>
<organizationunit>stringval</organizationunit>
<email>stringval</email>
<fcommonnames>
<item>item 1</item>
<item>item2</item>
</fcommonnames>
<createcsr>enumval</createcsr>
<doletsencrypt>enumval</doletsencrypt>
</certificate>
<setasdefault>enumval</setasdefault>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
Edits existing server certificate
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>editservercertificate</commandname>
<commandparams>
<id>stringval</id>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<certificate>stringval</certificate>
<setasdefault>enumval</setasdefault>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Deletes existing server certificate
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>deleteservercertificate</commandname>
<commandparams>
<id>stringval</id>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Sets the existing server certificate as default
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setdefaultservercertificate</commandname>
<commandparams>
<id>stringval</id>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Reissues existing server certificate
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>reissueservercertificate</commandname>
<commandparams>
<id>stringval</id>
<certificate>
<bits>intval</bits>
<validfordays>intval</validfordays>
<country>stringval</country>
<state>stringval</state>
<city>stringval</city>
<organization>stringval</organization>
<organizationunit>stringval</organizationunit>
<email>stringval</email>
<fcommonnames>
<item>item 1</item>
<item>item2</item>
</fcommonnames>
<createcsr>enumval</createcsr>
<doletsencrypt>enumval</doletsencrypt>
</certificate>
<reuse>enumval</reuse>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
Exports existing server certificate
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>exportservercertificate</commandname>
<commandparams>
<id>stringval</id>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>stringval</result>
</query>
</iq>
These methods allows you to work with smart discover.
Sets new domain(host) value to all smartdiscover variables
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>setsmartdiscoverhostname</commandname>
<commandparams>
<hostname>stringval</hostname>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
These methods allows you to work with license.
Returns license informations
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getlicenseinfo</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<country>stringval</country>
<state>stringval</state>
<locality>stringval</locality>
<organization>stringval</organization>
<email>stringval</email>
<cn>stringval</cn>
</result>
</query>
</iq>
These methods allows you to work with login page features.
Creates a new account on IceWarp server , Captcha protected
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>signupaccount</commandname>
<commandparams>
<domain>stringval</domain>
<username>stringval</username>
<password>stringval</password>
<fullname>stringval</fullname>
<alternativeemail>stringval</alternativeemail>
<authtype>enumval</authtype>
<captcharequest>
<uid>stringval</uid>
<value>stringval</value>
</captcharequest>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Sends the reset password email that contains the link to reset the password, captcha protected
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>resetpasswordemail</commandname>
<commandparams>
<email>stringval</email>
<langid>stringval</langid>
<captcharequest>
<uid>stringval</uid>
<value>stringval</value>
</captcharequest>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>intval</result>
</query>
</iq>
Resets the password for account specified by email
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>resetpassword</commandname>
<commandparams>
<email>stringval</email>
<newpassword>stringval</newpassword>
<resethash>stringval</resethash>
<authtype>enumval</authtype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Changes the password for account specified by email
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>changepassword</commandname>
<commandparams>
<email>stringval</email>
<oldpassword>stringval</oldpassword>
<newpassword>stringval</newpassword>
<authtype>enumval</authtype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Sends the email to contact the server administrator
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>contactadministrator</commandname>
<commandparams>
<email>stringval</email>
<data>stringval</data>
<host>stringval</host>
<captcharequest>
<uid>stringval</uid>
<value>stringval</value>
</captcharequest>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Sends the guest confirmation email that contains the link to verify guest account It also sets fullname and password for guest account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>guestconfirm</commandname>
<commandparams>
<email>stringval</email>
<password>stringval</password>
<fullname>stringval</fullname>
<sender>stringval</sender>
<hash>stringval</hash>
<authtype>enumval</authtype>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Verifies the guest account
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>guestverify</commandname>
<commandparams>
<email>stringval</email>
<hash>stringval</hash>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Confirmation of personality added using WebClient
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>confirmpersonality</commandname>
<commandparams>
<email>stringval</email>
<user>stringval</user>
<hash>stringval</hash>
</commandparams>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>enumval</result>
</query>
</iq>
Returns the captcha image as HTML (divtcha)
<iq sid="sidval">
<query xmlns="admin:iq:rpc">
<commandname>getcaptcha</commandname>
<commandparams/>
</query>
</iq>
<iq sid="sidval" type="result">
<query xmlns="admin:iq:rpc">
<result>
<uid>stringval</uid>
<html>stringval</html>
<style>stringval</style>
</result>
</query>
</iq>
<custom>stringval</custom>
<custom>enumval</custom>
<custom>intval</custom>
<custom>realval</custom>
vCard data structure of IceWarp account
| Name | Type | Description |
|---|---|---|
| Body | AnsiString | Represents class property TAccountCard.Body |
| Anniversary | AnsiString | Represents class property TAccountCard.Anniversary |
| BirthDay | AnsiString | Represents class property TAccountCard.BirthDay |
| AssistantName | AnsiString | Represents class property TAccountCard.AssistantName |
| CompanyName | AnsiString | Represents class property TAccountCard.CompanyName |
| Department | AnsiString | Represents class property TAccountCard.Department |
| FileAs | AnsiString | Represents class property TAccountCard.FileAs |
| FirstName | AnsiString | Represents class property TAccountCard.FirstName |
| JobTitle | AnsiString | Represents class property TAccountCard.JobTitle |
| LastName | AnsiString | Represents class property TAccountCard.LastName |
| ManagerName | AnsiString | Represents class property TAccountCard.ManagerName |
| MiddleName | AnsiString | Represents class property TAccountCard.MiddleName |
| Nickname | AnsiString | Represents class property TAccountCard.Nickname |
| OfficeLocation | AnsiString | Represents class property TAccountCard.OfficeLocation |
| Spouse | AnsiString | Represents class property TAccountCard.Spouse |
| Suffix | AnsiString | Represents class property TAccountCard.Suffix |
| Title | AnsiString | Represents class property TAccountCard.Title |
| WebPage | AnsiString | Represents class property TAccountCard.WebPage |
| Certificate | AnsiString | Represents class property TAccountCard.Certificate |
| FreeBusyURL | AnsiString | Represents class property TAccountCard.FreeBusyURL |
| Profession | AnsiString | Represents class property TAccountCard.Profession |
| Sensitivity | AnsiString | Represents class property TAccountCard.Sensitivity |
| Gender | AnsiString | Represents class property TAccountCard.Gender |
| BusinessAddressCity | AnsiString | Represents class property TAccountCard.BusinessAddressCity |
| BusinessAddressCountry | AnsiString | Represents class property TAccountCard.BusinessAddressCountry |
| BusinessAddressPostalCode | AnsiString | Represents class property TAccountCard.BusinessAddressPostalCode |
| BusinessAddressState | AnsiString | Represents class property TAccountCard.BusinessAddressState |
| BusinessAddressStreet | AnsiString | Represents class property TAccountCard.BusinessAddressStreet |
| BusinessAddressPostOfficeBox | AnsiString | Represents class property TAccountCard.BusinessAddressPostOfficeBox |
| HomeAddressCity | AnsiString | Represents class property TAccountCard.HomeAddressCity |
| HomeAddressCountry | AnsiString | Represents class property TAccountCard.HomeAddressCountry |
| HomeAddressPostalCode | AnsiString | Represents class property TAccountCard.HomeAddressPostalCode |
| HomeAddressState | AnsiString | Represents class property TAccountCard.HomeAddressState |
| HomeAddressStreet | AnsiString | Represents class property TAccountCard.HomeAddressStreet |
| HomeAddressPostOfficeBox | AnsiString | Represents class property TAccountCard.HomeAddressPostOfficeBox |
| Email1Address | AnsiString | Represents class property TAccountCard.Email1Address |
| Email2Address | AnsiString | Represents class property TAccountCard.Email2Address |
| Email3Address | AnsiString | Represents class property TAccountCard.Email3Address |
| IMAddress | AnsiString | Represents class property TAccountCard.IMAddress |
| HomePage | AnsiString | Represents class property TAccountCard.HomePage |
| HomePage2 | AnsiString | Represents class property TAccountCard.HomePage2 |
| AssistnameTelephoneNumber | AnsiString | Represents class property TAccountCard.AssistnameTelephoneNumber |
| BusinessFaxNumber | AnsiString | Represents class property TAccountCard.BusinessFaxNumber |
| BusinessTelephoneNumber | AnsiString | Represents class property TAccountCard.BusinessTelephoneNumber |
| Business2TelephoneNumber | AnsiString | Represents class property TAccountCard.Business2TelephoneNumber |
| CarTelephoneNumber | AnsiString | Represents class property TAccountCard.CarTelephoneNumber |
| CompanyMainTelephoneNumber | AnsiString | Represents class property TAccountCard.CompanyMainTelephoneNumber |
| HomeFaxNumber | AnsiString | Represents class property TAccountCard.HomeFaxNumber |
| HomeTelephoneNumber | AnsiString | Represents class property TAccountCard.HomeTelephoneNumber |
| Home2TelephoneNumber | AnsiString | Represents class property TAccountCard.Home2TelephoneNumber |
| MobileTelephoneNumber | AnsiString | Represents class property TAccountCard.MobileTelephoneNumber |
| PagerNumber | AnsiString | Represents class property TAccountCard.PagerNumber |
| RadioTelephoneNumber | AnsiString | Represents class property TAccountCard.RadioTelephoneNumber |
| CallbackTelephoneNumber | AnsiString | Represents class property TAccountCard.CallbackTelephoneNumber |
| ISDNNumber | AnsiString | Represents class property TAccountCard.ISDNNumber |
| OtherFaxNumber | AnsiString | Represents class property TAccountCard.OtherFaxNumber |
| PrimaryTelephoneNumber | AnsiString | Represents class property TAccountCard.PrimaryTelephoneNumber |
| TelexNumber | AnsiString | Represents class property TAccountCard.TelexNumber |
| HearingNumber | AnsiString | Represents class property TAccountCard.HearingNumber |
| OtherNumber | AnsiString | Represents class property TAccountCard.OtherNumber |
| Categories | TPropertyStringList | Represents class property TAccountCard.Categories |
<custom>
<classname>taccountcard</classname>
<body>stringval</body>
<anniversary>stringval</anniversary>
<birthday>stringval</birthday>
<assistantname>stringval</assistantname>
<companyname>stringval</companyname>
<department>stringval</department>
<fileas>stringval</fileas>
<firstname>stringval</firstname>
<jobtitle>stringval</jobtitle>
<lastname>stringval</lastname>
<managername>stringval</managername>
<middlename>stringval</middlename>
<nickname>stringval</nickname>
<officelocation>stringval</officelocation>
<spouse>stringval</spouse>
<suffix>stringval</suffix>
<title>stringval</title>
<webpage>stringval</webpage>
<certificate>stringval</certificate>
<freebusyurl>stringval</freebusyurl>
<profession>stringval</profession>
<sensitivity>stringval</sensitivity>
<gender>stringval</gender>
<businessaddresscity>stringval</businessaddresscity>
<businessaddresscountry>stringval</businessaddresscountry>
<businessaddresspostalcode>stringval</businessaddresspostalcode>
<businessaddressstate>stringval</businessaddressstate>
<businessaddressstreet>stringval</businessaddressstreet>
<businessaddresspostofficebox>stringval</businessaddresspostofficebox>
<homeaddresscity>stringval</homeaddresscity>
<homeaddresscountry>stringval</homeaddresscountry>
<homeaddresspostalcode>stringval</homeaddresspostalcode>
<homeaddressstate>stringval</homeaddressstate>
<homeaddressstreet>stringval</homeaddressstreet>
<homeaddresspostofficebox>stringval</homeaddresspostofficebox>
<email1address>stringval</email1address>
<email2address>stringval</email2address>
<email3address>stringval</email3address>
<imaddress>stringval</imaddress>
<homepage>stringval</homepage>
<homepage2>stringval</homepage2>
<assistnametelephonenumber>stringval</assistnametelephonenumber>
<businessfaxnumber>stringval</businessfaxnumber>
<businesstelephonenumber>stringval</businesstelephonenumber>
<business2telephonenumber>stringval</business2telephonenumber>
<cartelephonenumber>stringval</cartelephonenumber>
<companymaintelephonenumber>stringval</companymaintelephonenumber>
<homefaxnumber>stringval</homefaxnumber>
<hometelephonenumber>stringval</hometelephonenumber>
<home2telephonenumber>stringval</home2telephonenumber>
<mobiletelephonenumber>stringval</mobiletelephonenumber>
<pagernumber>stringval</pagernumber>
<radiotelephonenumber>stringval</radiotelephonenumber>
<callbacktelephonenumber>stringval</callbacktelephonenumber>
<isdnnumber>stringval</isdnnumber>
<otherfaxnumber>stringval</otherfaxnumber>
<primarytelephonenumber>stringval</primarytelephonenumber>
<telexnumber>stringval</telexnumber>
<hearingnumber>stringval</hearingnumber>
<othernumber>stringval</othernumber>
<categories>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</categories>
</custom>
Account avatar image object which is displayed in account's vCard
| Name | Type | Description |
|---|---|---|
| Base64Data | AnsiString | Image Base64 data |
| ContentType | AnsiString | Image Content-Type |
<custom>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</custom>
Basic informations about IceWarp account object, is used in account listing
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Account full name |
| AnsiString | Account email address | |
| DisplayEmail | AnsiString | Email to be displayed |
| AccountType | NativeInt | Type of the account (0 - aaUser, 1 - aaMailingList, 2 - aaExecutable, 3 - aaNotification, 4 - aaStaticRoute, 5 - aaCatalog, 6 - aaListServer, 7 - aaGroup, 8 - aaResource) |
| AdminType | TAdminType | Type of account permissions |
| Quota | TAccountQuota | Account disk quota |
| Image | TAccountImage | Account vCard image |
<custom>
<name>stringval</name>
<email>stringval</email>
<displayemail>stringval</displayemail>
<accounttype>intval</accounttype>
<admintype>enumval</admintype>
<quota>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</quota>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
</custom>
Used to filter the list of accounts in IceWarp server
| Name | Type | Description |
|---|---|---|
| NameMask | AnsiString | Mask that is used agains account name and alias |
| TypeMask | AnsiString | Mask that is used agains account type |
<custom>
<namemask>stringval</namemask>
<typemask>stringval</typemask>
</custom>
Full name of IceWarp account
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Account name |
| Surname | AnsiString | Account surname |
<custom>
<classname>taccountname</classname>
<name>stringval</name>
<surname>stringval</surname>
</custom>
Outlook policies related to IceWarp account
| Name | Type | Description |
|---|---|---|
| SyncFolderStructure | Boolean | Sync folder structure |
| SyncFolderStructureAfter | AnsiString | Sync folder structure after N minutes |
| SyncPriorityFolders | Boolean | Synchronize priority folders |
| SyncPriorityFoldersAfter | AnsiString | Synchronize priority folders after N minutes |
| SyncStandardFolders | Boolean | Synchronize standard folders |
| SyncStandardFoldersAfter | AnsiString | Synchronize standard folders after N minutes |
| SyncFoldersImmediately | Boolean | Synchronize folder immediately after change is detected |
| SyncFoldersImmediatelyValue | AnsiString | Synchronize folder immediately after change is detected value |
| SyncGAL | Boolean | Sync Global address list |
| SyncGALValue | AnsiString | Sync Global adress list value |
| FolderSyncThreshold | Boolean | Folder synchronization threshold |
| FolderSyncThresholdMessages | AnsiString | Folder synchronization threshold value ( messages in folder ) |
| DownloadThreshold | Boolean | Download threshold |
| DownloadThresholdMB | AnsiString | Download threshold value in MB |
| DownloadFilesFully | Boolean | Download files fully |
| DownloadFilesType | AnsiString | Download files type (custom, headers, full) |
| AuthenticationMethod | Boolean | Authentication method |
| AuthenticationMethodValue | AnsiString | Authentication method value (CRAM MD5, Plain) |
| LineSecurity | Boolean | Line Security |
| LineSecurityValue | AnsiString | Line Security value (plain, starttls, ssl) |
| LoginPort | Boolean | Login port |
| LoginPortValue | AnsiString | Login port value |
| DisplayABNames | Boolean | Display Adreess book names |
| DisplayABNamesAs | AnsiString | Display Address book value ( numbered structure, folder name only, full folder path , outlook native ) |
| SaveAsType | AnsiString | Save as type (default, force settings) |
| ResetToDefault | Boolean | Reset to default indicator |
| DoNotShowLoginErrors | Boolean | Do not show login error window |
| DoNotShowLoginErrorsValue | AnsiString | Do not show login error window value |
| SkipTrashFolderStartupCheck | Boolean | Skip trash folder startup check |
| SkipTrashFolderStartupCheckValue | AnsiString | Skip trash folder startup check value |
| DisableTnef | Boolean | Disable TNEF |
| DisableTnefValue | AnsiString | Disable TNEF value |
| AutoRevertChangesInReadOnly | Boolean | Auto revert changes in read only folders |
| AutoRevertChangesInReadOnlyValue | AnsiString | Auto revert changes in read only folders value |
| DoNotShowProgress | Boolean | Do not show progress |
| DoNotShowProgressValue | AnsiString | Do not show progress value |
| ShowDesktopNotification | Boolean | Show desktop notification |
| ShowDesktopNotificationValue | AnsiString | Show desktop notification value |
| HideNotificationAfterValue | AnsiString | Hide notification after time value |
| PlayDefaultNotificationSound | Boolean | Play default notification sound |
| PlayDefaultNotificationSoundValue | AnsiString | Play default notification sound value |
| CheckForUpdates | Boolean | Check for updates |
| CheckForUpdatesValue | AnsiString | Check for updates value |
| LogLevel | Boolean | Log level |
| LogLevelValue | AnsiString | Log level value (errors, debug) |
| DeleteLogs | Boolean | Delete logs |
| DeleteLogsValue | AnsiString | Delete logs value |
| DeleteLogsAfterValue | AnsiString | Delete logs after days value |
| DoNotShowConnectionErrors | Boolean | Disable connection warnings |
| DoNotShowConnectionErrorsValue | AnsiString | Disable connection warnings value |
<custom>
<classname>taccountoutlookpolicies</classname>
</custom>
Used to specify properties of IceWarp account ( by property name )
<custom>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</custom>
List of available property sets for IceWarp account
<custom>enumval</custom>
Account Quota
| Name | Type | Description |
|---|---|---|
| MailboxSize | NativeInt | Actual size of IceWarp account |
| MailboxQuota | NativeInt | Size limit of IceWarp account |
<custom>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</custom>
IceWarp account auto responder settings
| Name | Type | Description |
|---|---|---|
| NoRespond | TPropertyStringList | List of recipients, you do not want to auto respond |
| ResponderMessage | TAccountResponderMessage | Responder message |
| ResponderType | TResponder | Type of responder |
| RespondPeriod | NativeInt | Responder period |
| RespondBetweenFrom | AnsiString | Respond only if between from |
| RespondBetweenTo | AnsiString | Respond only if between to |
| RespondOnlyIfToMe | Boolean | Respond to messages sent only to account's email address |
<custom>
<classname>taccountresponder</classname>
<norespond>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</norespond>
<respondermessage>
<classname>taccountrespondermessage</classname>
<from>stringval</from>
<subject>stringval</subject>
<text>stringval</text>
</respondermessage>
<respondertype>enumval</respondertype>
<respondperiod>intval</respondperiod>
<respondbetweenfrom>stringval</respondbetweenfrom>
<respondbetweento>stringval</respondbetweento>
<respondonlyiftome>enumval</respondonlyiftome>
</custom>
IceWarp account auto responder message
| Name | Type | Description |
|---|---|---|
| From | AnsiString | Header from: value in responder message |
| Subject | AnsiString | Header subject: value in responder message |
| Text | AnsiString | Text content of responder message |
<custom>
<classname>taccountrespondermessage</classname>
<from>stringval</from>
<subject>stringval</subject>
<text>stringval</text>
</custom>
Represents the list of accounts
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of accounts in the list |
<custom>
<item>
<name>stringval</name>
<email>stringval</email>
<displayemail>stringval</displayemail>
<accounttype>intval</accounttype>
<admintype>enumval</admintype>
<quota>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</quota>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
</item>
<item>
<name>stringval</name>
<email>stringval</email>
<displayemail>stringval</displayemail>
<accounttype>intval</accounttype>
<admintype>enumval</admintype>
<quota>
<classname>taccountquota</classname>
<mailboxsize>intval</mailboxsize>
<mailboxquota>intval</mailboxquota>
</quota>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
</item>
</custom>
State of IceWarp account
| Name | Type | Description |
|---|---|---|
| State | TUserState | State value |
<custom>
<classname>taccountstate</classname>
<state>enumval</state>
</custom>
Activation key class
| Name | Type | Description |
|---|---|---|
| KeyType | TActivationKeyType | Type of activation key |
| Description | AnsiString | Key description ( will be in the email sent to user ) |
| Count | AnsiString | Count of avaliable activations |
| Value | AnsiString | The key string value |
<custom>
<classname>tactivationkey</classname>
<keytype>enumval</keytype>
<description>stringval</description>
<count>stringval</count>
<value>stringval</value>
</custom>
Type of activation key - outlook, desktop client
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| DomainsPermissions | TDomainsPermissionsList | |
| GlobalPermissions | TAdministrativePermissionsList |
<custom>
<domainspermissions>
<item>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</item>
<item>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</item>
</domainspermissions>
<globalpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</globalpermissions>
</custom>
List of API properties and its permissions
<custom>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</custom>
IceWarp account administration level
<custom>enumval</custom>
<custom>
<item>item 1</item>
<item>item2</item>
</custom>
IceWarp Server license information
| Name | Type | Description |
|---|---|---|
| Country | AnsiString | Country |
| State | AnsiString | State |
| Locality | AnsiString | Locality ( city ) |
| Organization | AnsiString | Organization |
| AnsiString | Email address | |
| CN | AnsiString | Common name |
<custom>
<country>stringval</country>
<state>stringval</state>
<locality>stringval</locality>
<organization>stringval</organization>
<email>stringval</email>
<cn>stringval</cn>
</custom>
Represents property of server ,domain ,account ,mobile device or statistic object
| Name | Type | Description |
|---|---|---|
| PropName | AnsiString | Property name as in apiconst |
<custom>
<propname>stringval</propname>
</custom>
Informations about current session: Email,Domain, AdminType
| Name | Type | Description |
|---|---|---|
| AnsiString | Email of current user | |
| Domain | AnsiString | Domain of current user |
| AdminType | TAdminType | Actual rights |
| IsGateway | Boolean | Specifies if session is for gateway account ( no user ) |
| Name | TAccountName | Name of current user |
| Image | TAccountImage | Image of current user |
| AvatarToken | AnsiString | Avatar token |
<custom>
<email>stringval</email>
<domain>stringval</domain>
<admintype>enumval</admintype>
<isgateway>enumval</isgateway>
<name>
<classname>taccountname</classname>
<name>stringval</name>
<surname>stringval</surname>
</name>
<image>
<classname>taccountimage</classname>
<base64data>stringval</base64data>
<contenttype>stringval</contenttype>
</image>
<avatartoken>stringval</avatartoken>
</custom>
Settings access level
<custom>enumval</custom>
Represents the item in settings resource ( each item contain list of variables )
| Name | Type | Description |
|---|---|---|
| UID | AnsiString | Item UID [Optional] |
| List | TAPISettingsVariableList | List of setting variables |
List of setting items
<custom>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</custom>
Settings user server-domain-account level
<custom>enumval</custom>
Represents the resource in settigns
| Name | Type | Description |
|---|---|---|
| List | TAPISettingsItemList | List of setting items |
| Name | AnsiString | Resource name |
| ResourceType | TAPISettingsResourceType | Type of the resource |
| Default | Boolean | Specifies if the resource is default ( inherited ) |
<custom>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</custom>
List of settings resources
<custom>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
</custom>
Represents the resources container in settigns
| Name | Type | Description |
|---|---|---|
| List | TAPISettingsResourceList | List of items in the resource |
<custom>
<list>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
<item>
<list>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
<item>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</item>
</list>
<name>stringval</name>
<resourcetype>enumval</resourcetype>
<default>enumval</default>
</item>
</list>
</custom>
Resource type
<custom>enumval</custom>
Represents the item in web client settings resource
| Name | Type | Description |
|---|---|---|
| DomainAdminAccessLevel | TAPISettingsAccessLevel | Access level for domain administrator accounts |
| UserAccessLevel | TAPISettingsAccessLevel | Access level for user accounts |
| AccessLevel | TAPISettingsAccessLevel | Access level for currently logged account |
| Name | AnsiString | Item name in selected resource |
| Value | AnsiString | Item value in selected resource |
| SetDefault | Boolean | [Set only] Removes current variable from settings |
<custom>
<domainadminaccesslevel>enumval</domainadminaccesslevel>
<useraccesslevel>enumval</useraccesslevel>
<accesslevel>enumval</accesslevel>
<name>stringval</name>
<value>stringval</value>
<setdefault>enumval</setdefault>
</custom>
Represents class TAPISettingsVariableList
<custom>
<item>
<domainadminaccesslevel>enumval</domainadminaccesslevel>
<useraccesslevel>enumval</useraccesslevel>
<accesslevel>enumval</accesslevel>
<name>stringval</name>
<value>stringval</value>
<setdefault>enumval</setdefault>
</item>
<item>
<domainadminaccesslevel>enumval</domainadminaccesslevel>
<useraccesslevel>enumval</useraccesslevel>
<accesslevel>enumval</accesslevel>
<name>stringval</name>
<value>stringval</value>
<setdefault>enumval</setdefault>
</item>
</custom>
Returns basic informations about just authenticated account
| Name | Type | Description |
|---|---|---|
| AnsiString | Email of current user | |
| Name | TAccountName | Name of current user |
| AvatarToken | AnsiString | Avatar token |
| AuthToken | AnsiString | Auth token |
<custom>
<email>stringval</email>
<name>
<classname>taccountname</classname>
<name>stringval</name>
<surname>stringval</surname>
</name>
<avatartoken>stringval</avatartoken>
<authtoken>stringval</authtoken>
</custom>
Returns current hash(RSA public modulus) and timestamp used in authorization
| Name | Type | Description |
|---|---|---|
| HashId | AnsiString | Hash ( public RSA key modulus ) |
| TimeStamp | NativeInt | Time of the hash creation ( unixtime ) |
<custom>
<classname>tauthchallenge</classname>
<hashid>stringval</hashid>
<timestamp>intval</timestamp>
</custom>
Type of authorization - currently PLAIN and RSA are supported
<custom>enumval</custom>
Class that is used to confirm humanity check
| Name | Type | Description |
|---|---|---|
| UID | AnsiString | Captcha identifier |
| Value | AnsiString | Captcha value ( alphanumeric value ) |
<custom>
<uid>stringval</uid>
<value>stringval</value>
</custom>
Humanity check definition
| Name | Type | Description |
|---|---|---|
| UID | AnsiString | Captcha identifier |
| HTML | AnsiString | Captcha HTML |
| Style | AnsiString | Captcha CSS |
<custom>
<uid>stringval</uid>
<html>stringval</html>
<style>stringval</style>
</custom>
<custom>enumval</custom>
<custom>enumval</custom>
<custom>enumval</custom>
Used to specify properties of IceWarp mobile device ( by property name )
<custom>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</custom>
Informations about Domain DNS
| Name | Type | Description |
|---|---|---|
| Records | TDomainDNSRecords | Domain DNS records |
<custom>
<records>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
</records>
</custom>
Domain DNS record informations
| Name | Type | Description |
|---|---|---|
| Host | AnsiString | Host name |
| RecordType | TDomainDNSRecordType | DNS record type |
| RecordService | TDomainDNSRecordService | DNS record service |
| Value | TPropertyStringList | Values ( list of strings ) |
<custom>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</custom>
List of Domain DNS Record
<custom>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
</custom>
Represents enumeration TDomainDNSRecordService
<custom>enumval</custom>
Represents enumeration TDomainDNSRecordType
<custom>enumval</custom>
General info about domain
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Domain name |
| DefaultAlias | AnsiString | Default alias of the domain |
| AnsiString | Administrator email address | |
| UserCount | NativeInt | Count of users in domain |
| UserLimit | NativeInt | Max number of users in domain |
| IPAddress | AnsiString | Domain IP address |
| HostName | AnsiString | Domain host name |
| DomainType | TDomainType | Domain type |
| ExpiresOn | AnsiString | Domain expiration date |
<custom>
<name>stringval</name>
<defaultalias>stringval</defaultalias>
<email>stringval</email>
<usercount>intval</usercount>
<userlimit>intval</userlimit>
<ipaddress>stringval</ipaddress>
<hostname>stringval</hostname>
<domaintype>enumval</domaintype>
<expireson>stringval</expireson>
</custom>
Basic informations about IceWarp domain object, is used in domain listing
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Domain name |
| Desc | AnsiString | Domain description |
| DomainType | NativeInt | Domain type ( TDomainType = (0 - dtStandard, 1 - dtETRNQue, 2 - dtAlias, 3 - dtBackup, 4 - dtDistributed) ) |
| AccountCount | NativeInt | Number of accounts |
<custom>
<name>stringval</name>
<desc>stringval</desc>
<domaintype>intval</domaintype>
<accountcount>intval</accountcount>
</custom>
Domain infromations
| Name | Type | Description |
|---|---|---|
| General | TDomainGeneralInfo | Domain general info |
| DNS | TDomainDNSInfo | Domain DNS info |
<custom>
<general>
<name>stringval</name>
<defaultalias>stringval</defaultalias>
<email>stringval</email>
<usercount>intval</usercount>
<userlimit>intval</userlimit>
<ipaddress>stringval</ipaddress>
<hostname>stringval</hostname>
<domaintype>enumval</domaintype>
<expireson>stringval</expireson>
</general>
<dns>
<records>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
<item>
<host>stringval</host>
<recordtype>enumval</recordtype>
<recordservice>enumval</recordservice>
<value>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</value>
</item>
</records>
</dns>
</custom>
Used to filter the list of domains in IceWarp server
| Name | Type | Description |
|---|---|---|
| NameMask | AnsiString | Used against domain name & description |
| TypeMask | AnsiString | Used against domain type |
<custom>
<namemask>stringval</namemask>
<typemask>stringval</typemask>
</custom>
Outlook policies related to IceWarp domain
| Name | Type | Description |
|---|---|---|
| SyncFolderStructure | Boolean | Sync folder structure |
| SyncFolderStructureAfter | AnsiString | Sync folder structure after N minutes |
| SyncPriorityFolders | Boolean | Synchronize priority folders |
| SyncPriorityFoldersAfter | AnsiString | Synchronize priority folders after N minutes |
| SyncStandardFolders | Boolean | Synchronize standard folders |
| SyncStandardFoldersAfter | AnsiString | Synchronize standard folders after N minutes |
| SyncFoldersImmediately | Boolean | Synchronize folder immediately after change is detected |
| SyncFoldersImmediatelyValue | AnsiString | Synchronize folder immediately after change is detected value |
| SyncGAL | Boolean | Sync Global address list |
| SyncGALValue | AnsiString | Sync Global adress list value |
| FolderSyncThreshold | Boolean | Folder synchronization threshold |
| FolderSyncThresholdMessages | AnsiString | Folder synchronization threshold value ( messages in folder ) |
| DownloadThreshold | Boolean | Download threshold |
| DownloadThresholdMB | AnsiString | Download threshold value in MB |
| DownloadFilesFully | Boolean | Download files fully |
| DownloadFilesType | AnsiString | Download files type (custom, headers, full) |
| AuthenticationMethod | Boolean | Authentication method |
| AuthenticationMethodValue | AnsiString | Authentication method value (CRAM MD5, Plain) |
| LineSecurity | Boolean | Line Security |
| LineSecurityValue | AnsiString | Line Security value (plain, starttls, ssl) |
| LoginPort | Boolean | Login port |
| LoginPortValue | AnsiString | Login port value |
| DisplayABNames | Boolean | Display Adreess book names |
| DisplayABNamesAs | AnsiString | Display Address book value ( numbered structure, folder name only, full folder path , outlook native ) |
| SaveAsType | AnsiString | Save as type (default, force settings) |
| ResetToDefault | Boolean | Reset to default indicator |
| DoNotShowLoginErrors | Boolean | Do not show login error window |
| DoNotShowLoginErrorsValue | AnsiString | Do not show login error window value |
| SkipTrashFolderStartupCheck | Boolean | Skip trash folder startup check |
| SkipTrashFolderStartupCheckValue | AnsiString | Skip trash folder startup check value |
| DisableTnef | Boolean | Disable TNEF |
| DisableTnefValue | AnsiString | Disable TNEF value |
| AutoRevertChangesInReadOnly | Boolean | Auto revert changes in read only folders |
| AutoRevertChangesInReadOnlyValue | AnsiString | Auto revert changes in read only folders value |
| DoNotShowProgress | Boolean | Do not show progress |
| DoNotShowProgressValue | AnsiString | Do not show progress value |
| ShowDesktopNotification | Boolean | Show desktop notification |
| ShowDesktopNotificationValue | AnsiString | Show desktop notification value |
| HideNotificationAfterValue | AnsiString | Hide notification after time value |
| PlayDefaultNotificationSound | Boolean | Play default notification sound |
| PlayDefaultNotificationSoundValue | AnsiString | Play default notification sound value |
| CheckForUpdates | Boolean | Check for updates |
| CheckForUpdatesValue | AnsiString | Check for updates value |
| LogLevel | Boolean | Log level |
| LogLevelValue | AnsiString | Log level value (errors, debug) |
| DeleteLogs | Boolean | Delete logs |
| DeleteLogsValue | AnsiString | Delete logs value |
| DeleteLogsAfterValue | AnsiString | Delete logs after days value |
| DoNotShowConnectionErrors | Boolean | Disable connection warnings |
| DoNotShowConnectionErrorsValue | AnsiString | Disable connection warnings value |
<custom>
<classname>tdomainoutlookpolicies</classname>
</custom>
Used to specify properties of IceWarp domain ( by property name );
<custom>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</custom>
| Name | Type | Description |
|---|---|---|
| AccountsRelatedPermissions | TAdministrativePermissionsList | |
| DomainRelatedPermissions | TAdministrativePermissionsList |
<custom>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</custom>
| Name | Type | Description |
|---|---|---|
| DomainsSet | TDomainsSet | |
| DomainsAdministrativePermissions | TDomainsAdministrativePermissions |
<custom>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</custom>
Represents the list of domains returned to client
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of domains in the list |
<custom>
<item>
<name>stringval</name>
<desc>stringval</desc>
<domaintype>intval</domaintype>
<accountcount>intval</accountcount>
</item>
<item>
<name>stringval</name>
<desc>stringval</desc>
<domaintype>intval</domaintype>
<accountcount>intval</accountcount>
</item>
</custom>
This class represents a domain, or domain pattern using wildcards
| Name | Type | Description |
|---|---|---|
| Mask | AnsiString | Domain name or pattern |
| Negate | Boolean | Negates the Mask |
<custom>
<mask>stringval</mask>
<negate>enumval</negate>
</custom>
<custom>
<item>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</item>
<item>
<domainsset>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</domainsset>
<domainsadministrativepermissions>
<accountsrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</accountsrelatedpermissions>
<domainrelatedpermissions>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
<item>
<prop>intval</prop>
<perm>enumval</perm>
</item>
</domainrelatedpermissions>
</domainsadministrativepermissions>
</item>
</custom>
<custom>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
<item>
<mask>stringval</mask>
<negate>enumval</negate>
</item>
</custom>
<custom>enumval</custom>
Basic informations about IceWarp folder object, is used in folder listing
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Folder name |
| ID | AnsiString | Folder ID |
| FolderType | AnsiString | Folder type |
| DefaultType | AnsiString | Folder default type |
| SubFolders | TFolderInfoList | List of subfolders in current folder |
<custom>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
</subfolders>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders/>
</item>
</subfolders>
</item>
</subfolders>
</custom>
Represents the list of folders in IceWarp account
<custom>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
</subfolders>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
</subfolders>
</item>
</subfolders>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
</subfolders>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
<subfolders>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
<item>
<name>stringval</name>
<id>stringval</id>
<foldertype>stringval</foldertype>
<defaulttype>stringval</defaulttype>
</item>
</subfolders>
</item>
</subfolders>
</item>
</custom>
List of permissions related to specific folder in IceWarp account
| Name | Type | Description |
|---|---|---|
| IsInherited | Boolean | Inherited rights from higher level |
<custom>
<item>
<account>stringval</account>
<permissions>stringval</permissions>
</item>
<item>
<account>stringval</account>
<permissions>stringval</permissions>
</item>
</custom>
Folder permission item
| Name | Type | Description |
|---|---|---|
| Account | AnsiString | IceWarp account email address |
| Permissions | AnsiString | Permissions for Account |
<custom>
<account>stringval</account>
<permissions>stringval</permissions>
</custom>
API Property representing Instant messaging roster list
| Name | Type | Description |
|---|---|---|
| Val | TIMRosterList | Instant messaging roster list |
<custom>
<classname>timroster</classname>
<val>
<item>
<val>stringval</val>
<grouptitle>stringval</grouptitle>
</item>
<item>
<val>stringval</val>
<grouptitle>stringval</grouptitle>
</item>
</val>
</custom>
Instant messaging roster item
| Name | Type | Description |
|---|---|---|
| Val | AnsiString | Item name |
| GroupTitle | AnsiString | Item group title |
<custom>
<val>stringval</val>
<grouptitle>stringval</grouptitle>
</custom>
Instant messaging roster list
<custom>
<item>
<val>stringval</val>
<grouptitle>stringval</grouptitle>
</item>
<item>
<val>stringval</val>
<grouptitle>stringval</grouptitle>
</item>
</custom>
Basic informations about IceWarp mobile device object, is used in mobile device listing
| Name | Type | Description |
|---|---|---|
| DeviceID | AnsiString | Combined device ID : Base64(AccountID+|+DeviceID) |
| ID | AnsiString | DeviceID |
| Account | AnsiString | AccountID |
| Name | AnsiString | Device name |
| DeviceType | AnsiString | Device type |
| Model | AnsiString | Device model |
| OS | AnsiString | Device OS |
| ProtocolVersion | AnsiString | Device protocol version |
| Registered | AnsiString | Device registration information |
| LastSync | AnsiString | Date of the last device synchronization |
| RemoteWipe | TMobileDeviceRemoteWipe | Device remote wipe type |
| Status | TMobileDeviceStatus | Device status |
<custom>
<deviceid>stringval</deviceid>
<id>stringval</id>
<account>stringval</account>
<name>stringval</name>
<devicetype>stringval</devicetype>
<model>stringval</model>
<os>stringval</os>
<protocolversion>stringval</protocolversion>
<registered>stringval</registered>
<lastsync>stringval</lastsync>
<remotewipe>enumval</remotewipe>
<status>enumval</status>
</custom>
Used to filter the list of mobile devices in IceWarp server
| Name | Type | Description |
|---|---|---|
| NameMask | AnsiString | Used agains mobile device name |
| Status | TMobileDeviceStatus | Used against mobile device status |
| LastSync | NativeInt | Synced during last N days |
<custom>
<namemask>stringval</namemask>
<status>enumval</status>
<lastsync>intval</lastsync>
</custom>
Represents enumeration TMobileDeviceRemoteWipe
<custom>enumval</custom>
Represents enumeration TMobileDeviceRemoteWipeSet
<custom>enumval</custom>
Represents the list of mobile devices
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of mobile devices in the list |
<custom>
<item>
<deviceid>stringval</deviceid>
<id>stringval</id>
<account>stringval</account>
<name>stringval</name>
<devicetype>stringval</devicetype>
<model>stringval</model>
<os>stringval</os>
<protocolversion>stringval</protocolversion>
<registered>stringval</registered>
<lastsync>stringval</lastsync>
<remotewipe>enumval</remotewipe>
<status>enumval</status>
</item>
<item>
<deviceid>stringval</deviceid>
<id>stringval</id>
<account>stringval</account>
<name>stringval</name>
<devicetype>stringval</devicetype>
<model>stringval</model>
<os>stringval</os>
<protocolversion>stringval</protocolversion>
<registered>stringval</registered>
<lastsync>stringval</lastsync>
<remotewipe>enumval</remotewipe>
<status>enumval</status>
</item>
</custom>
Represents enumeration TMobileDeviceStatus
<custom>enumval</custom>
Represents enumeration TMobileDeviceStatusSet
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| O | AnsiString | |
| OU | AnsiString | |
| C | AnsiString | |
| CN | AnsiString | |
| SubjectAltName | AnsiString | |
| Locality | AnsiString | |
| State | AnsiString | |
| AnsiString |
<custom>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</custom>
Represents class TOutlookPolicies
| Name | Type | Description |
|---|---|---|
| SyncFolderStructure | Boolean | Sync folder structure |
| SyncFolderStructureAfter | AnsiString | Sync folder structure after N minutes |
| SyncPriorityFolders | Boolean | Synchronize priority folders |
| SyncPriorityFoldersAfter | AnsiString | Synchronize priority folders after N minutes |
| SyncStandardFolders | Boolean | Synchronize standard folders |
| SyncStandardFoldersAfter | AnsiString | Synchronize standard folders after N minutes |
| SyncFoldersImmediately | Boolean | Synchronize folder immediately after change is detected |
| SyncFoldersImmediatelyValue | AnsiString | Synchronize folder immediately after change is detected value |
| SyncGAL | Boolean | Sync Global address list |
| SyncGALValue | AnsiString | Sync Global adress list value |
| FolderSyncThreshold | Boolean | Folder synchronization threshold |
| FolderSyncThresholdMessages | AnsiString | Folder synchronization threshold value ( messages in folder ) |
| DownloadThreshold | Boolean | Download threshold |
| DownloadThresholdMB | AnsiString | Download threshold value in MB |
| DownloadFilesFully | Boolean | Download files fully |
| DownloadFilesType | AnsiString | Download files type (custom, headers, full) |
| AuthenticationMethod | Boolean | Authentication method |
| AuthenticationMethodValue | AnsiString | Authentication method value (CRAM MD5, Plain) |
| LineSecurity | Boolean | Line Security |
| LineSecurityValue | AnsiString | Line Security value (plain, starttls, ssl) |
| LoginPort | Boolean | Login port |
| LoginPortValue | AnsiString | Login port value |
| DisplayABNames | Boolean | Display Adreess book names |
| DisplayABNamesAs | AnsiString | Display Address book value ( numbered structure, folder name only, full folder path , outlook native ) |
| SaveAsType | AnsiString | Save as type (default, force settings) |
| ResetToDefault | Boolean | Reset to default indicator |
| DoNotShowLoginErrors | Boolean | Do not show login error window |
| DoNotShowLoginErrorsValue | AnsiString | Do not show login error window value |
| SkipTrashFolderStartupCheck | Boolean | Skip trash folder startup check |
| SkipTrashFolderStartupCheckValue | AnsiString | Skip trash folder startup check value |
| DisableTnef | Boolean | Disable TNEF |
| DisableTnefValue | AnsiString | Disable TNEF value |
| AutoRevertChangesInReadOnly | Boolean | Auto revert changes in read only folders |
| AutoRevertChangesInReadOnlyValue | AnsiString | Auto revert changes in read only folders value |
| DoNotShowProgress | Boolean | Do not show progress |
| DoNotShowProgressValue | AnsiString | Do not show progress value |
| ShowDesktopNotification | Boolean | Show desktop notification |
| ShowDesktopNotificationValue | AnsiString | Show desktop notification value |
| HideNotificationAfterValue | AnsiString | Hide notification after time value |
| PlayDefaultNotificationSound | Boolean | Play default notification sound |
| PlayDefaultNotificationSoundValue | AnsiString | Play default notification sound value |
| CheckForUpdates | Boolean | Check for updates |
| CheckForUpdatesValue | AnsiString | Check for updates value |
| LogLevel | Boolean | Log level |
| LogLevelValue | AnsiString | Log level value (errors, debug) |
| DeleteLogs | Boolean | Delete logs |
| DeleteLogsValue | AnsiString | Delete logs value |
| DeleteLogsAfterValue | AnsiString | Delete logs after days value |
| DoNotShowConnectionErrors | Boolean | Disable connection warnings |
| DoNotShowConnectionErrorsValue | AnsiString | Disable connection warnings value |
<custom>enumval</custom>
Describes value of property enumeration
| Name | Type | Description |
|---|---|---|
| Value | AnsiString | Enumeration value |
| Name | AnsiString | Enumeration name |
<custom>
<value>stringval</value>
<name>stringval</name>
</custom>
List of property enumeration values
<custom>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</custom>
Brief information about API property on IceWarp server
| Name | Type | Description |
|---|---|---|
| APIProperty | TAPIProperty | API Proprety object |
| PropertyVal | TPropertyVal | Value of current API property |
| PropertyRight | TPermission | Rights for the current session |
| PropertyEnumValues | TPropertyEnumValues | Enumeration values & comments if the property is enumeration |
| PropertyComment | AnsiString | Comment ( description ) for current API Property |
| PropertyGroup | AnsiString | Specifies the group in which the API property is organized |
| PropertyValueType | TPropertyValueType | Type of the property value |
<custom>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountrespondermessage</classname>
<from>stringval</from>
<subject>stringval</subject>
<text>stringval</text>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</custom>
Represents the list of properties returned in API Console
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of properties in the list |
<custom>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</propertyval>
<propertyright>enumval</propertyright>
<propertyenumvalues>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
<item>
<value>stringval</value>
<name>stringval</name>
</item>
</propertyenumvalues>
<propertycomment>stringval</propertycomment>
<propertygroup>stringval</propertygroup>
<propertyvaluetype>enumval</propertyvaluetype>
</item>
</custom>
Used to filter the list of properties in server / domain / account API console
| Name | Type | Description |
|---|---|---|
| Mask | AnsiString | Supports wildcards, used agains property name , value and comment |
| Groups | TPropertyStringList | If the group list is specified, only properties in the group list is returned |
| Clear | Boolean | Specifies if the cached property list should be cleared or not |
<custom>
<mask>stringval</mask>
<groups>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</groups>
<clear>enumval</clear>
</custom>
Represents the account member mailing list, group
| Name | Type | Description |
|---|---|---|
| Val | AnsiString | Name of the member |
| Default | Boolean | Member will have default rights as defined within the Mailing List - Security tab of mailing list settings. |
| Recieve | Boolean | Member will receive all messages sent to the list and cannot post messages to the list. |
| Post | Boolean | Member can post message to the mailing list. |
| Digest | Boolean | Member will receive all messages sent to the list, in a single "digest" message, and cannot post messages to the list. |
<custom>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</custom>
Represents the account member list ( mailing list, group )
<custom>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
</custom>
Represents the API property with account members ( mailing list, group )
| Name | Type | Description |
|---|---|---|
| Val | TPropertyMemberList | List of members |
<custom>
<classname>tpropertymembers</classname>
<val>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
<item>
<classname>tpropertymember</classname>
<val>stringval</val>
<default>enumval</default>
<recieve>enumval</recieve>
<post>enumval</post>
<digest>enumval</digest>
</item>
</val>
</custom>
Represents property that has no value or there are missing read permissions
<custom>
<classname>tpropertynovalue</classname>
</custom>
Defines a permissions for API property
| Name | Type | Description |
|---|---|---|
| Prop | NativeInt | Property ID |
| Perm | TPermission | Property Permission |
<custom>
<prop>intval</prop>
<perm>enumval</perm>
</custom>
Pair API property - right
| Name | Type | Description |
|---|---|---|
| APIProperty | TAPIProperty | API Property object |
| PropertyRight | TPermission | Property right |
<custom>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</custom>
List Of TPropertyRight
<custom>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyright>enumval</propertyright>
</item>
</custom>
Represents api property of type string
| Name | Type | Description |
|---|---|---|
| Val | AnsiString | String value |
<custom>
<classname>tpropertystring</classname>
<val>stringval</val>
</custom>
Represents api property of type string list
| Name | Type | Description |
|---|---|---|
| Val | TAnsiStringList | List of strings |
<custom>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</custom>
Pair of API Property and its comment ( used to create translation XML )
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Represents class property TPropertyTranslateInfo.Name |
| Comment | AnsiString | Represents class property TPropertyTranslateInfo.Comment |
<custom>
<name>stringval</name>
<comment>stringval</comment>
</custom>
Represents class TPropertyTranslateList
<custom>
<item>
<name>stringval</name>
<comment>stringval</comment>
</item>
<item>
<name>stringval</name>
<comment>stringval</comment>
</item>
</custom>
Fully abstract class , parent of all properties returned in getproperty and similar
Represents the value of any API property
| Name | Type | Description |
|---|---|---|
| APIProperty | TAPIProperty | API Property object |
| PropertyVal | TPropertyVal | API Property value |
| PropertyRight | TPermission | API Property right |
<custom>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tpropertynovalue</classname>
</propertyval>
<propertyright>enumval</propertyright>
</custom>
Represents class TPropertyValueList
<custom>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>taccountrespondermessage</classname>
<from>stringval</from>
<subject>stringval</subject>
<text>stringval</text>
</propertyval>
<propertyright>enumval</propertyright>
</item>
<item>
<apiproperty>
<propname>stringval</propname>
</apiproperty>
<propertyval>
<classname>tauthchallenge</classname>
<hashid>stringval</hashid>
<timestamp>intval</timestamp>
</propertyval>
<propertyright>enumval</propertyright>
</item>
</custom>
Specifies the value type of API property
<custom>enumval</custom>
<custom>enumval</custom>
Abstract class that represents action defined in rule
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<item>
<classname>trulesendmessageaction</classname>
<messagefrom>stringval</messagefrom>
<messageto>stringval</messageto>
<messagesubject>stringval</messagesubject>
<messagetext>stringval</messagetext>
</item>
<item>
<classname>trulesetflagsaction</classname>
<flagged>enumval</flagged>
<seen>enumval</seen>
<junk>enumval</junk>
<notjunk>enumval</notjunk>
<label1>enumval</label1>
<label2>enumval</label2>
<label3>enumval</label3>
<label4>enumval</label4>
<label5>enumval</label5>
<label6>enumval</label6>
</item>
</custom>
Represents enumeration TRuleActionType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>truleallcondition</classname>
</custom>
Represents enumeration TRuleCompareType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<item>
<classname>truleprioritycondition</classname>
<priority>enumval</priority>
</item>
<item>
<classname>truleallcondition</classname>
</item>
</custom>
Conditions
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| Folder | AnsiString |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulecopytofolderaction</classname>
<folder>stringval</folder>
</custom>
| Name | Type | Description |
|---|---|---|
| Server | AnsiString | |
| Regex | AnsiString |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulednsblcondition</classname>
<server>stringval</server>
<regex>stringval</regex>
</custom>
| Name | Type | Description |
|---|---|---|
| Headers | TRuleEditHeaderList |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>truleeditheaderaction</classname>
<headers>
<item>
<editheadertype>enumval</editheadertype>
<header>stringval</header>
<hasregex>enumval</hasregex>
<regex>stringval</regex>
<value>stringval</value>
</item>
<item>
<editheadertype>enumval</editheadertype>
<header>stringval</header>
<hasregex>enumval</hasregex>
<regex>stringval</regex>
<value>stringval</value>
</item>
</headers>
</custom>
| Name | Type | Description |
|---|---|---|
| EditHeaderType | TRuleEditHeaderType | |
| Header | AnsiString | |
| HasRegex | Boolean | |
| Regex | AnsiString | |
| Value | AnsiString |
<custom>
<editheadertype>enumval</editheadertype>
<header>stringval</header>
<hasregex>enumval</hasregex>
<regex>stringval</regex>
<value>stringval</value>
</custom>
<custom>
<item>
<editheadertype>enumval</editheadertype>
<header>stringval</header>
<hasregex>enumval</hasregex>
<regex>stringval</regex>
<value>stringval</value>
</item>
<item>
<editheadertype>enumval</editheadertype>
<header>stringval</header>
<hasregex>enumval</hasregex>
<regex>stringval</regex>
<value>stringval</value>
</item>
</custom>
Represents enumeration TRuleEditHeaderType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>truleencryptaction</classname>
</custom>
| Name | Type | Description |
|---|---|---|
| AnsiString |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>truleforwardtoemailaction</classname>
<email>stringval</email>
</custom>
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulehasattachmentcondition</classname>
</custom>
Brief information about some rule in IceWarp server
| Name | Type | Description |
|---|---|---|
| RuleID | AnsiString | Identification number of the rule |
| Title | AnsiString | Rule title |
| Active | Boolean | Specifies if the rule is active or not |
| ActionType | TRuleMessageActionType | If there is some message action in rule, return such action ( used for icon ) |
| Condition | TRuleCondition | Return the first condition , so the client is able to generate title , when it is empty |
<custom>
<ruleid>stringval</ruleid>
<title>stringval</title>
<active>enumval</active>
<actiontype>enumval</actiontype>
<condition>
<classname>trulesmtpauthcondition</classname>
</condition>
</custom>
| Name | Type | Description |
|---|---|---|
| CompareType | TRuleCompareType | |
| Size | NativeInt |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>truleissizecondition</classname>
<comparetype>enumval</comparetype>
<size>intval</size>
</custom>
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>truleisspamcondition</classname>
</custom>
| Name | Type | Description |
|---|---|---|
| Weekdays | Boolean | |
| Monday | Boolean | |
| Tuesday | Boolean | |
| Wednesday | Boolean | |
| Thursday | Boolean | |
| Friday | Boolean | |
| Saturday | Boolean | |
| Sunday | Boolean | |
| BetweenTimes | Boolean | |
| FromTime | AnsiString | |
| ToTime | AnsiString | |
| BetweenDates | Boolean | |
| FromDate | AnsiString | |
| ToDate | AnsiString |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulelocaltimecondition</classname>
<weekdays>enumval</weekdays>
<monday>enumval</monday>
<tuesday>enumval</tuesday>
<wednesday>enumval</wednesday>
<thursday>enumval</thursday>
<friday>enumval</friday>
<saturday>enumval</saturday>
<sunday>enumval</sunday>
<betweentimes>enumval</betweentimes>
<fromtime>stringval</fromtime>
<totime>stringval</totime>
<betweendates>enumval</betweendates>
<fromdate>stringval</fromdate>
<todate>stringval</todate>
</custom>
| Name | Type | Description |
|---|---|---|
| MessageActionType | TRuleMessageActionType |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulemessageactionaction</classname>
<messageactiontype>enumval</messageactiontype>
</custom>
Represents enumeration TRuleMessageActionType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| Folder | AnsiString |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulemovetofolderaction</classname>
<folder>stringval</folder>
</custom>
Represents enumeration TRuleMoveType
<custom>enumval</custom>
Represents enumeration TRuleMultipleItemsMatchType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| Priority | TRulePriorityType |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulepriorityaction</classname>
<priority>enumval</priority>
</custom>
| Name | Type | Description |
|---|---|---|
| Priority | TRulePriorityType |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>truleprioritycondition</classname>
<priority>enumval</priority>
</custom>
Represents enumeration TRulePriorityType
<custom>enumval</custom>
Represents enumeration TRuleRecipientConditionType
<custom>enumval</custom>
Represents enumeration TRuleRecipientSenderType
<custom>enumval</custom>
Represents enumeration TRuleRemoteLocalType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| RecipientSender | TRuleRecipientSenderType | |
| RemoteLocal | TRuleRemoteLocalType | |
| RecipientCondition | TRuleRecipientConditionType | |
| Account | AnsiString |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulesenderrecipientcondition</classname>
<recipientsender>enumval</recipientsender>
<remotelocal>enumval</remotelocal>
<recipientcondition>enumval</recipientcondition>
<account>stringval</account>
</custom>
| Name | Type | Description |
|---|---|---|
| MessageFrom | AnsiString | |
| MessageTo | AnsiString | |
| MessageSubject | AnsiString | |
| MessageText | AnsiString |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulesendmessageaction</classname>
<messagefrom>stringval</messagefrom>
<messageto>stringval</messageto>
<messagesubject>stringval</messagesubject>
<messagetext>stringval</messagetext>
</custom>
| Name | Type | Description |
|---|---|---|
| Flagged | Boolean | |
| Seen | Boolean | |
| Junk | Boolean | |
| NotJunk | Boolean | |
| Label1 | Boolean | |
| Label2 | Boolean | |
| Label3 | Boolean | |
| Label4 | Boolean | |
| Label5 | Boolean | |
| Label6 | Boolean |
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulesetflagsaction</classname>
<flagged>enumval</flagged>
<seen>enumval</seen>
<junk>enumval</junk>
<notjunk>enumval</notjunk>
<label1>enumval</label1>
<label2>enumval</label2>
<label3>enumval</label3>
<label4>enumval</label4>
<label5>enumval</label5>
<label6>enumval</label6>
</custom>
| Name | Type | Description |
|---|---|---|
| Conditions | TRuleConditions | |
| Actions | TRuleActions | |
| Title | AnsiString | |
| Active | Boolean | |
| RuleID | NativeInt |
<custom>
<conditions>
<item>
<classname>truleallcondition</classname>
</item>
<item>
<classname>truleissizecondition</classname>
<comparetype>enumval</comparetype>
<size>intval</size>
</item>
</conditions>
<actions>
<item>
<classname>truleencryptaction</classname>
</item>
<item>
<classname>truleforwardtoemailaction</classname>
<email>stringval</email>
</item>
</actions>
<title>stringval</title>
<active>enumval</active>
<ruleid>intval</ruleid>
</custom>
Represents the list of rules
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of rules in the list |
<custom>
<item>
<ruleid>stringval</ruleid>
<title>stringval</title>
<active>enumval</active>
<actiontype>enumval</actiontype>
<condition>
<classname>trulespamscorecondition</classname>
<comparetype>enumval</comparetype>
<spamscore>stringval</spamscore>
</condition>
</item>
<item>
<ruleid>stringval</ruleid>
<title>stringval</title>
<active>enumval</active>
<actiontype>enumval</actiontype>
<condition>
<classname>trulespamscorecondition</classname>
<comparetype>enumval</comparetype>
<spamscore>stringval</spamscore>
</condition>
</item>
</custom>
Used to filter the list of rules in IceWarp server
| Name | Type | Description |
|---|---|---|
| NameMask | AnsiString | Used agains rule name |
<custom>
<namemask>stringval</namemask>
</custom>
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulesmtpauthcondition</classname>
</custom>
| Name | Type | Description |
|---|---|---|
| MatchFunction | TRuleSomeWordsFunctionType | |
| MatchValue | AnsiString | |
| MatchCase | Boolean | |
| MatchWholeWordsOnly | Boolean | |
| NotMatch | Boolean | |
| MultipleItemsMatch | TRuleMultipleItemsMatchType | |
| ParseXML | Boolean |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulesomewordscondition</classname>
<matchfunction>enumval</matchfunction>
<matchvalue>stringval</matchvalue>
<matchcase>enumval</matchcase>
<matchwholewordsonly>enumval</matchwholewordsonly>
<notmatch>enumval</notmatch>
<multipleitemsmatch>enumval</multipleitemsmatch>
<parsexml>enumval</parsexml>
</custom>
Represents enumeration TRuleSomeWordsFunctionType
<custom>enumval</custom>
| Name | Type | Description |
|---|---|---|
| CompareType | TRuleCompareType | |
| SpamScore | AnsiString |
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>trulespamscorecondition</classname>
<comparetype>enumval</comparetype>
<spamscore>stringval</spamscore>
</custom>
| Name | Type | Description |
|---|---|---|
| Actiontype | TRuleActionType | Type of the action |
<custom>
<classname>trulestopaction</classname>
</custom>
| Name | Type | Description |
|---|---|---|
| ConditionType | TRuleConditionType | |
| OperatorAnd | Boolean | |
| LogicalNot | Boolean | |
| BracketsLeft | NativeInt | |
| BracketsRight | NativeInt |
<custom>
<classname>truletrustedsessioncondition</classname>
</custom>
Traffic chart data value
| Name | Type | Description |
|---|---|---|
| V | Real | Value |
| D | AnsiString | Date |
<custom>
<v>realval</v>
<d>stringval</d>
</custom>
List of services traffic data
<custom>
<item>
<v>realval</v>
<d>stringval</d>
</item>
<item>
<v>realval</v>
<d>stringval</d>
</item>
</custom>
Represents the server certificate
| Name | Type | Description |
|---|---|---|
| ID | AnsiString | Certificate ID ( md5 hash created from filename ) |
| Bits | NativeInt | Key size in bits |
| CN | AnsiString | Common name |
| Expiration | AnsiString | Expiration |
| FingerPrint | AnsiString | Fingerprint |
| IPAddress | TAnsiStringList | IP Address |
| Hostname | TAnsiStringList | Hostname |
| Issuer | AnsiString | Issuer |
| Subject | AnsiString | Subject |
| IsDefault | Boolean | Default certificate |
| IsCSR | Boolean | Certificate sign request |
| CertType | TCertInfoType | Cert type |
| AutomaticEngine | TCertGenerationEngine | Cert renewal engine |
| Verify | Boolean | Verify |
| Status | TCertStatus | Status |
| SubjectInfo | TNameInfo | Subject Info |
| IssuerInfo | TNameInfo | Issuer info |
| Error | TServerCertificateError | Error |
<custom>
<id>stringval</id>
<bits>intval</bits>
<cn>stringval</cn>
<expiration>stringval</expiration>
<fingerprint>stringval</fingerprint>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<hostname>
<item>item 1</item>
<item>item2</item>
</hostname>
<issuer>stringval</issuer>
<subject>stringval</subject>
<isdefault>enumval</isdefault>
<iscsr>enumval</iscsr>
<certtype>enumval</certtype>
<automaticengine>enumval</automaticengine>
<verify>enumval</verify>
<status>enumval</status>
<subjectinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</subjectinfo>
<issuerinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</issuerinfo>
<error>
<lastattempt>intval</lastattempt>
<lasterror>intval</lasterror>
<faileddomains>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</faileddomains>
</error>
</custom>
Class representing the certificate errors
| Name | Type | Description |
|---|---|---|
| LastAttempt | NativeInt | Last validation attempt |
| LastError | NativeInt | Last error |
| FailedDomains | TServerCertificateFailedDomains | List of failed domain requests |
<custom>
<lastattempt>intval</lastattempt>
<lasterror>intval</lasterror>
<faileddomains>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</faileddomains>
</custom>
Information about certificate failed domain request
| Name | Type | Description |
|---|---|---|
| DomainName | AnsiString | Domain name |
| ResultCode | NativeInt | Result code |
<custom>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</custom>
List of certificate failed domain requests
<custom>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</custom>
List of TServerCertificate
<custom>
<item>
<id>stringval</id>
<bits>intval</bits>
<cn>stringval</cn>
<expiration>stringval</expiration>
<fingerprint>stringval</fingerprint>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<hostname>
<item>item 1</item>
<item>item2</item>
</hostname>
<issuer>stringval</issuer>
<subject>stringval</subject>
<isdefault>enumval</isdefault>
<iscsr>enumval</iscsr>
<certtype>enumval</certtype>
<automaticengine>enumval</automaticengine>
<verify>enumval</verify>
<status>enumval</status>
<subjectinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</subjectinfo>
<issuerinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</issuerinfo>
<error>
<lastattempt>intval</lastattempt>
<lasterror>intval</lasterror>
<faileddomains>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</faileddomains>
</error>
</item>
<item>
<id>stringval</id>
<bits>intval</bits>
<cn>stringval</cn>
<expiration>stringval</expiration>
<fingerprint>stringval</fingerprint>
<ipaddress>
<item>item 1</item>
<item>item2</item>
</ipaddress>
<hostname>
<item>item 1</item>
<item>item2</item>
</hostname>
<issuer>stringval</issuer>
<subject>stringval</subject>
<isdefault>enumval</isdefault>
<iscsr>enumval</iscsr>
<certtype>enumval</certtype>
<automaticengine>enumval</automaticengine>
<verify>enumval</verify>
<status>enumval</status>
<subjectinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</subjectinfo>
<issuerinfo>
<o>stringval</o>
<ou>stringval</ou>
<c>stringval</c>
<cn>stringval</cn>
<subjectaltname>stringval</subjectaltname>
<locality>stringval</locality>
<state>stringval</state>
<email>stringval</email>
</issuerinfo>
<error>
<lastattempt>intval</lastattempt>
<lasterror>intval</lasterror>
<faileddomains>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
<item>
<domainname>stringval</domainname>
<resultcode>intval</resultcode>
</item>
</faileddomains>
</error>
</item>
</custom>
| Name | Type | Description |
|---|---|---|
| Bits | NativeInt | |
| ValidForDays | NativeInt | |
| Country | AnsiString | |
| State | AnsiString | |
| City | AnsiString | |
| Organization | AnsiString | |
| OrganizationUnit | AnsiString | |
| AnsiString | ||
| FCommonNames | TAnsiStringList | |
| CreateCSR | Boolean | |
| DoLetsEncrypt | Boolean |
<custom>
<bits>intval</bits>
<validfordays>intval</validfordays>
<country>stringval</country>
<state>stringval</state>
<city>stringval</city>
<organization>stringval</organization>
<organizationunit>stringval</organizationunit>
<email>stringval</email>
<fcommonnames>
<item>item 1</item>
<item>item2</item>
</fcommonnames>
<createcsr>enumval</createcsr>
<doletsencrypt>enumval</doletsencrypt>
</custom>
Used to specify properties of IceWarp server ( by property name )
<custom>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</custom>
Represents class TServiceBasicStatistics
| Name | Type | Description |
|---|---|---|
| Uptime | NativeInt | Running time |
| ConnTotal | NativeInt | Total connections |
| ServerConn | NativeInt | Server connections |
| ServerConnPeak | NativeInt | Server connections peak |
| ServerDataTotal | NativeInt | Server data total |
| ServerDataIn | NativeInt | Server data in |
| ServerDataOut | NativeInt | Server data out |
| ClientConn | NativeInt | Client connections |
| ClientConnPeak | NativeInt | Client connections peak |
| ClientDataTotal | NativeInt | Client data total |
| ClientDataIn | NativeInt | Client data in |
| ClientDataOut | NativeInt | Client data out |
| MemorySize | NativeInt | Memory size |
| MemoryPeak | NativeInt | Memory peak |
<custom>
<classname>tservicebasicstatistics</classname>
</custom>
Contains services chart data
| Name | Type | Description |
|---|---|---|
| List | TSCItmList | List of services traffic data |
<custom>
<list>
<item>
<v>realval</v>
<d>stringval</d>
</item>
<item>
<v>realval</v>
<d>stringval</d>
</item>
</list>
</custom>
Represents enumeration TServiceChartPeriod
<custom>enumval</custom>
Represents enumeration TServiceChartType
<custom>enumval</custom>
Brief information about IceWarp service
| Name | Type | Description |
|---|---|---|
| ServiceType | TServiceType | Service type |
| Uptime | NativeInt | Running time |
| Connections | NativeInt | Connection count |
| MaxConnections | NativeInt | Max connections |
| Data | NativeInt | Data ( memory ) |
| IsRunning | Boolean | Specifies if the service is running or not |
<custom>
<servicetype>enumval</servicetype>
<uptime>intval</uptime>
<connections>intval</connections>
<maxconnections>intval</maxconnections>
<data>intval</data>
<isrunning>enumval</isrunning>
</custom>
Used to filter the list of services in IceWarp server
| Name | Type | Description |
|---|---|---|
| Mask | AnsiString | Not yet supported - returns all services by now |
<custom>
<mask>stringval</mask>
</custom>
Represents the list of IceWarp services
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of IceWarp services in the list |
<custom>
<item>
<servicetype>enumval</servicetype>
<uptime>intval</uptime>
<connections>intval</connections>
<maxconnections>intval</maxconnections>
<data>intval</data>
<isrunning>enumval</isrunning>
</item>
<item>
<servicetype>enumval</servicetype>
<uptime>intval</uptime>
<connections>intval</connections>
<maxconnections>intval</maxconnections>
<data>intval</data>
<isrunning>enumval</isrunning>
</item>
</custom>
Statistic object for SMTP service
| Name | Type | Description |
|---|---|---|
| MsgReceived | NativeInt | Messages received |
| MsgSent | NativeInt | Messages sent |
| MsgFailed | NativeInt | Failed messages |
| MsgVirus | NativeInt | Messages containing virus |
| MsgContentFilter | NativeInt | Messages processed with content filter |
| MsgRules | NativeInt | Messages processed with rule |
| MsgExternal | NativeInt | External filder messages |
| MsgIntrusionPrevention | NativeInt | Intrusion prevention messages |
| MsgDNS | NativeInt | DNS Messages |
| Quarantine | NativeInt | Quarantine processed messages |
| SpamAssasin | NativeInt | SpamAssasin processed messags |
| SpamMarked | NativeInt | Messages marked as spam |
| SpamLiveBulk | NativeInt | AntiSpam Live messages ( bulk ) |
| SpamLive | NativeInt | AntiSpam Live messages |
| Refused | NativeInt | Refused messages |
| Greylisting | NativeInt | Greylisted messages |
| Name | Type | Description |
|---|---|---|
| Uptime | NativeInt | Running time |
| ConnTotal | NativeInt | Total connections |
| ServerConn | NativeInt | Server connections |
| ServerConnPeak | NativeInt | Server connections peak |
| ServerDataTotal | NativeInt | Server data total |
| ServerDataIn | NativeInt | Server data in |
| ServerDataOut | NativeInt | Server data out |
| ClientConn | NativeInt | Client connections |
| ClientConnPeak | NativeInt | Client connections peak |
| ClientDataTotal | NativeInt | Client data total |
| ClientDataIn | NativeInt | Client data in |
| ClientDataOut | NativeInt | Client data out |
| MemorySize | NativeInt | Memory size |
| MemoryPeak | NativeInt | Memory peak |
<custom>
<classname>tservicesmtpstatistics</classname>
<msgreceived>intval</msgreceived>
<msgsent>intval</msgsent>
<msgfailed>intval</msgfailed>
<msgvirus>intval</msgvirus>
<msgcontentfilter>intval</msgcontentfilter>
<msgrules>intval</msgrules>
<msgexternal>intval</msgexternal>
<msgintrusionprevention>intval</msgintrusionprevention>
<msgdns>intval</msgdns>
<quarantine>intval</quarantine>
<spamassasin>intval</spamassasin>
<spammarked>intval</spammarked>
<spamlivebulk>intval</spamlivebulk>
<spamlive>intval</spamlive>
<refused>intval</refused>
<greylisting>intval</greylisting>
</custom>
Abstract class for service statistics
| Name | Type | Description |
|---|---|---|
| Uptime | NativeInt | Running time |
| ConnTotal | NativeInt | Total connections |
| ServerConn | NativeInt | Server connections |
| ServerConnPeak | NativeInt | Server connections peak |
| ServerDataTotal | NativeInt | Server data total |
| ServerDataIn | NativeInt | Server data in |
| ServerDataOut | NativeInt | Server data out |
| ClientConn | NativeInt | Client connections |
| ClientConnPeak | NativeInt | Client connections peak |
| ClientDataTotal | NativeInt | Client data total |
| ClientDataIn | NativeInt | Client data in |
| ClientDataOut | NativeInt | Client data out |
| MemorySize | NativeInt | Memory size |
| MemoryPeak | NativeInt | Memory peak |
<custom>enumval</custom>
Statistics object for VOIP service
| Name | Type | Description |
|---|---|---|
| PacketsReceived | NativeInt | Packets received |
| PacketsSent | NativeInt | Packets sent |
| RTPPacketsReceived | NativeInt | RTP packets received |
| RTPPacketsSent | NativeInt | RTP packets sent |
| CallCount | NativeInt | Calls count |
| CallPeak | NativeInt | Calls peak |
| CallTotal | NativeInt | Calls total |
| Name | Type | Description |
|---|---|---|
| Uptime | NativeInt | Running time |
| ConnTotal | NativeInt | Total connections |
| ServerConn | NativeInt | Server connections |
| ServerConnPeak | NativeInt | Server connections peak |
| ServerDataTotal | NativeInt | Server data total |
| ServerDataIn | NativeInt | Server data in |
| ServerDataOut | NativeInt | Server data out |
| ClientConn | NativeInt | Client connections |
| ClientConnPeak | NativeInt | Client connections peak |
| ClientDataTotal | NativeInt | Client data total |
| ClientDataIn | NativeInt | Client data in |
| ClientDataOut | NativeInt | Client data out |
| MemorySize | NativeInt | Memory size |
| MemoryPeak | NativeInt | Memory peak |
<custom>
<classname>tservicevoipstatistics</classname>
<packetsreceived>intval</packetsreceived>
<packetssent>intval</packetssent>
<rtppacketsreceived>intval</rtppacketsreceived>
<rtppacketssent>intval</rtppacketssent>
<callcount>intval</callcount>
<callpeak>intval</callpeak>
<calltotal>intval</calltotal>
</custom>
Resource filter
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Match against resource name |
| Items | TPropertyStringList | If not nil, get only variables with specified name |
<custom>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</custom>
Resources filter ~ List of TSettingsResourceFilter
<custom>
<item>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</item>
<item>
<name>stringval</name>
<items>
<classname>tpropertystringlist</classname>
<val>
<item>item 1</item>
<item>item2</item>
</val>
</items>
</item>
</custom>
Represents the list of spam queue itesm
| Name | Type | Description |
|---|---|---|
| Offset | NativeInt | Current offset in the list |
| OverallCount | NativeInt | Overall count of IceWarp services in the list |
<custom>
<item>
<itemid>stringval</itemid>
<sender>stringval</sender>
<date>stringval</date>
<owner>stringval</owner>
<domain>stringval</domain>
<subject>stringval</subject>
<queuetype>enumval</queuetype>
<folder>stringval</folder>
</item>
<item>
<itemid>stringval</itemid>
<sender>stringval</sender>
<date>stringval</date>
<owner>stringval</owner>
<domain>stringval</domain>
<subject>stringval</subject>
<queuetype>enumval</queuetype>
<folder>stringval</folder>
</item>
</custom>
Informations about item in Spam Queue
| Name | Type | Description |
|---|---|---|
| ItemID | AnsiString | Spam queue item ID |
| Sender | AnsiString | Sender email |
| Date | AnsiString | Date |
| Owner | AnsiString | Owner email |
| Domain | AnsiString | Owner domain |
| Subject | AnsiString | Only in Quarantine |
| QueueType | TSpamQueueType | Type of the queue ( see TSpamQueueType ) |
| Folder | AnsiString | Folder |
<custom>
<itemid>stringval</itemid>
<sender>stringval</sender>
<date>stringval</date>
<owner>stringval</owner>
<domain>stringval</domain>
<subject>stringval</subject>
<queuetype>enumval</queuetype>
<folder>stringval</folder>
</custom>
Used to filter the results of GetSpamQueueInfoList
| Name | Type | Description |
|---|---|---|
| Mask | AnsiString | Name mask |
| Sender | AnsiString | Item sender |
| Owner | AnsiString | Item owner ( recipient ) |
| Domain | AnsiString | Item domain |
<custom>
<mask>stringval</mask>
<sender>stringval</sender>
<owner>stringval</owner>
<domain>stringval</domain>
</custom>
Type of the spam queue
<custom>enumval</custom>
Used to specify properties of IceWarp statistics ( by property name )
<custom>
<item>
<propname>stringval</propname>
</item>
<item>
<propname>stringval</propname>
</item>
</custom>
<custom>enumval</custom>
Obsolete , should no longer be used
| Name | Type | Description |
|---|---|---|
| Name | AnsiString | Resource name |
| Name | Type | Description |
|---|---|---|
| UID | AnsiString | Item UID [Optional] |
| List | TAPISettingsVariableList | List of setting variables |
<custom>
<classname>twebmailsettingsresource</classname>
<name>stringval</name>
</custom>
--------------------------------------------------------------------------------
This file contains list of domains the domain administrator is eligible to maintain. It can contain rights for the domain administator as well.
Note that this file is deprecated due to new webadmin, because option list as it was defined in old webadmin can not be used in new webadmin ,so only
domainrights and domainlist are applied. For additional modifications of new webadmin see adminperm.dat
Formal Syntax:
domainfileitems = [domainrights] [optionlist] domainlist
domainrights = "RIGHTS=" domainrightlist CRLF
domainrightlist = "U" / "G" / "M" / "O" / "L" / "E" / "N" / "R" / "S" / "C" / "V" / "Q"
optionlist = *(optionitem CRLF)
optionitem = "OPTION=" optiontitle ":" optionvalue
domainlist = *([skipchar] domain CRLF)
skipchar = "!"
Example:
RIGHTS=UML
These characters stand for separate kinds of accounts or special functions that the domain administrator is allowed to change / create / delete:
U - User accounts
G - Group accounts
M - Mailing list accounts
O - Resource accounts
L - List server accounts
E - Executable accounts
R - Remote accounts
S - Static routes
N - Notification accounts
C - Catalog
V - Disable mailbox view
Q - Manage domain Quarantine
Enter additional domains on separate lines.
Example:
icewarp.com
microsoft.com
!doe.com
*
Following is deprecated in new webadmin ,but is still applied in old webadmin
Option limits let you hide any option on the object page for a specific domain admin You can set global restrictions and enable an option for one domain admin too.
Example:
OPTION=user_notification:0
OPTION=user_responder:0
The above disables user_notification and user_responder to be displayed See the html\admin\xml\ folder for all XML item definitions and their names.
Special option ALL can be used to disable/enable all options.
Example:
OPTION=ALL:0
OPTION=user_password:1
OPTION=user_confirmpassword:1
The above disables all options and then enables only user_password and user_confirmpassword.
This file contains serialized permissions object into XML. If administrator wants to modify access rights to some non default value he has to do it in this file. You can specify set of domains and the exclusive rights for such domain set. It contains two tags , <domainspermissions> and <globalpermissions>. <domainspermissions> defines the permissions for domains and accounts.Each item consists of domainsset and domainsadministrativepermissions so administrators are able to define different rights depending on domainsset. Domainsset contains list of domains that domain administrators are able to manage. Full admin sees all domains. Each item consist of domain mask and negate. In mask you can put name or some wildcard with * or ?. Negate is here to remove domains that you do not want to manange. Domains set can look like this Example:The above means that domain administrator with such settings in his adminperm.dat can work with all domains except those starting with icewarp. Domainsadministrativepermissions contains two options : <accountsrelatedpermissions> and <domainrelatedpermissions> Accountsrelatedpermissions are applied to all accounts that belongs to domains in specified domainsset, domainsrelatedpermissions are applied for to all domains in specified domainsset. Example:* 0 icewarp* 1 The above will allow editing of A_AdminType(1324) , Sets the A_Name(1337) to read only for accounts and allow to modify D_Description(0) for domains You can find numbers corresponding to variable names in {installpath}/api/delphi/apiconst.pas Specify variable (prop) : Notice that there are hexadecimal numbers which you have to convert to decimal. For example A_AdminType = $52C; , hexadecimal number is 52C which means 1324 in decimal. Specify access rights (perm) : 0 - no rights 1 - read only rights 2 - full rights ( read, write ) <globalpermissions> defines rights for global server properties. It has the same format as accountsrelatedpermissions and domainrelatedpermissions. Following example is the complete content listing of adminperm.dat1324 2 1337 1 0 2 * 0 icewarp* 1 1324 2 0 2 4096 1 4099 2 4098 2