https://wiki.pscs.co.uk/ 2026-04-09T10:32:24+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:actions?rev=1542192349&do=diff Admin POST Actions * SMTPClientBlockAdd * SMTPClientBlockRemove * SMTPClientAllowAdd * SMTPClientAllowRemove text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgauth?rev=1542192349&do=diff OutMsgAuth Replacement Use: ~outmsgauth~ Required parameter: MsgID This returns the authenticated sender (if any) of the specified message in the VPOP3 out queue. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsghold?rev=1542192349&do=diff OutMsgHold Replacement Use: ~outmsghold~ Required parameter: MsgID This returns whether the specified message in the VPOP3 out queue is held or not (1 or 0 respectively) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgip?rev=1542192349&do=diff OutMsgIP Replacement Use: ~outmsgip~ Required parameter: MsgID This returns the sender IP address of the specified message in the VPOP3 out queue. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgrecipients?rev=1542192349&do=diff OutMsgRecipients Replacement Use: [~outmsgrecipients~] Required parameter: MsgID This returns a JSON array containing details on the recipients for the specified message in the VPOP3 out queue. There is one object returned per recipient, and the object is: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgretpath?rev=1542192349&do=diff OutMsgRetPath Replacement Use: ~outmsgretpath~ Required parameter: MsgID This returns the return path of the specified message in the VPOP3 out queue text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:replacement_names?rev=1542192349&do=diff Admin Replacement Names * OutMsgIP * OutMsgHold * OutMsgAuth * OutMsgRecipients * OutMsgRetPath * SMTPClientAllows * SMTPClientBlocks * SMTPIDSEvents * SMTPSPFWhitelist * UserId * UserNumber * UserQueueMessage * UserRuleList * UserRuleActions * UserRuleConditions * UserRuleUpdate * UserRuleActionUpdate * UserRuleConditionUpdate 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: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:smtpidsevents?rev=1542192349&do=diff SMTPIDSEvents Replacement Use: ~smtpidsevents~ This returns the latest entries from the SMTP client logging database. It will return 100 entries unless the count parameter is specified in the URL, in which case that will specify the maximum number of entries to return. 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:userid?rev=1542192349&do=diff UserId Replacement Use: ~userid~ Required parameter: None This returns the userid/name of the currently logged in user text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:usernumber?rev=1542192349&do=diff UserNumber Replacement Use: ~usernumber~ Required parameter: None This returns the numeric ID of the currently logged in user 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:userruleactionupdate?rev=1542192349&do=diff UserRuleActionUpdate Replacement Use: ~userruleactionupdate~ Required parameter: * Account * RuleId * gr_id - action ID * !nativeeditor_status - inserted/deleted/updated * type * data This inserts/updates/deletes the specified message rule action 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:userruleconditionupdate?rev=1542192349&do=diff UserRuleConditionUpdate Replacement Use: ~userruleconditionupdate~ Required parameter: * Account * RuleID * gr_id - condition ID * !nativeeditor_status - inserted/deleted/updated * matchi (1/0) * matchn (1/0) * match * field * data 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleupdate?rev=1542192349&do=diff UserRuleUpdate Replacement Use: ~userruleupdate~ Required parameter: * Account * gr_id - rule ID * !nativeeditor_status - inserted/deleted/updated * name * all * type This inserts/updates/deletes the specified message rule The return value is an XML tag: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:version_5_webadmin_api?rev=1542192349&do=diff Version 5 Web Admin API This section is only relevant for people who may want to access the Administration features from their own scripts, or want to customise the standard administration pages. Note that no free support is available for this. This is not a full list of features, but it will be updated from time to time.