https://wiki.pscs.co.uk/ 2026-05-06T06:50:00+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: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: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: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: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: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: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: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: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: