https://wiki.pscs.co.uk/ 2026-05-06T07:48:50+00:00 https://wiki.pscs.co.uk/ https://wiki.pscs.co.uk/_media/wiki:dokuwiki.svg text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientblocks?rev=1542192349&do=diff SMTPClientBlocks Replacement Use: ~smtpclientblocks~ <format string> ~end~ The format string can have the replacements * address - IP address (returned as host address or CIDR address as appropriate) * date - the date/time the address was added to the database in YYYYMMDDHHMMSS format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleconditions?rev=1542192349&do=diff UserRuleConditions Replacement Use: ~userruleconditions~ <format string> ~end~ Required parameter: Account, RuleId This returns the message rule conditions for the specified rule The format string can have the replacements * id - numeric ID of the condition text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientallowadd?rev=1542192349&do=diff SMTPClientAllowAdd Action (VPOP3 Enterprise Only) This adds an entry to the SMTP Client Allow list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientallowremove?rev=1542192349&do=diff SMTPClientAllowRemove Action (VPOP3 Enterprise Only) This removes an entry to the SMTP Client Allow list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientallows?rev=1542192349&do=diff SMTPClientAllows Replacement Use: ~smtpclientallows~ <format string> ~end~ The format string can have the replacements * address - IP address (returned as host address or CIDR address as appropriate) * date - the date/time the address was added to the database in YYYYMMDDHHMMSS format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientblockadd?rev=1542192349&do=diff SMTPClientBlockAdd Action (VPOP3 Enterprise Only) This adds an entry to the SMTP Client Block list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientblockremove?rev=1542192349&do=diff SMTPClientBlockRemove Action (VPOP3 Enterprise Only) This removes an entry to the SMTP Client Block list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpspfwhitelist?rev=1542192349&do=diff SMTPSPFWhitelist Replacement Use: ~smtpspfwhitelist~ <format string> ~end~ If you specify the parameter serverid then this will just return white list entries which match all servers or this server. The format string can have the replacements * id - the whitelist entry ID text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userqueuemessage?rev=1542192349&do=diff UserQueueMessage Replacement Use: ~userqueuemessage~ Required parameter: Account, Msgid Optional parameter: Folder ('Inbox' is used if not specified) You can also use the :<max size> modifier to set the maximum size of the response. If none is specified then a maximum size of 1000 characters is used. (e.g. use **~userqueuemessage:10000~) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleactions?rev=1542192349&do=diff UserRuleActions Replacement Use: ~userruleactions~ <format string> ~end~ Required parameter: Account, RuleId This returns the message rule actions for the specified rule The format string can have the replacements * id - numeric ID of the action * type - action type text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userrulelist?rev=1542192349&do=diff UserRuleList Replacement Use: ~userrulelist~ <format string> ~end~ Required parameter: Account This returns the message rule list (in order) for the specified user The format string can have the replacements * id - numeric ID of the rule * order - numeric order number (1-n) of the rule