https://wiki.pscs.co.uk/ 2026-04-08T03:55:45+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/mailapi:actions?rev=1542192349&do=diff Webmail POST Actions * SpellCheckAddWord * SpellCheckDelWord text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:autoresponderconditionlist?rev=1542192349&do=diff AutoresponderConditionList Replacement Use: ~autoresponderconditionlist~ Required parameter: responderid - the ID of the autoresponder This returns a JSON structure containing an array of the rules associated with the specified autoresponder. The return structure is an array of objects containing: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:autoresponderinfo?rev=1542192349&do=diff AutoresponderInfo Replacement Use: ~autoresponderinfo~ Required parameter: responderid - the ID of the autoresponder This returns a JSON structure containing the details of the specified autoresponder. The return structure is an object containing: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:autoresponderlist?rev=1542192349&do=diff AutoresponderList and AutoresponderGlobalList Replacements Use: ~autoresponderlist~ or ~autorespondergloballist~ Required parameter: None This returns a JSON structure listing all the autoresponder details available. autoresponderlist returns the personal autoresponder details. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:messageview4?rev=1542192349&do=diff MessageView4 Replacement Use: ~messageview4~ Parameters: * “headers” (optional - “y” means show full headers, otherwise show condensed headers) * “msgformat” (optional - specifies format of 'message' in result. “text” means UTF8 text, otherwise UTF8 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:minpasswordlength?rev=1542192349&do=diff MinPasswordLength Replacement Use: ~minpasswordlength~ Required parameter: None This returns the minimum password length specified in the VPOP3 Settings -> Security settings text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:replacement_names?rev=1542192349&do=diff Webmail Replacement Names * AutoresponderConditionList * AutoresponderInfo * AutoresponderGlobalList * AutoresponderList * MessageView4 * MinPasswordLength * UserId * UserNumber * UserRuleList * UserRuleActions * UserRuleConditions * UserRuleReorder * UserRuleUpdate * UserRuleActionUpdate * UserRuleConditionUpdate text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:spellcheckaddword?rev=1542192349&do=diff SpellCheckAddWord This adds an entry to the user's custom spell check dictionary The data specified is: * Formaction - SpellCheckAddWord * Word - word to add * Action - ignore (don't mark the word as incorrect) or exclude (always mark the word as incorrect) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:spellcheckdelword?rev=1542192349&do=diff SpellCheckDelWord This removes an entry from the user's custom spell check dictionary The data specified is: * Formaction - SpellCheckDelWord * Word - word to remove If you POST to the 'response.html' file, then the response comes back as {action: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi: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/mailapi: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/mailapi:userruleactions?rev=1542192349&do=diff UserRuleActions Replacement Use: ~userruleactions~ <format string> ~end~ Required parameter: 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/mailapi:userruleactionupdate?rev=1542192349&do=diff UserRuleActionUpdate Replacement Use: ~userruleactionupdate~ Required parameter: * 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/mailapi:userruleconditions?rev=1542192349&do=diff UserRuleConditions Replacement Use: ~userruleconditions~ <format string> ~end~ Required parameter: RuleId This returns the message rule conditions for the specified rule The format string can have the replacements * id - numeric ID of the condition * field - field/data to test text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleconditionupdate?rev=1542192349&do=diff UserRuleConditionUpdate Replacement Use: ~userruleconditionupdate~ Required parameter: * RuleID * gr_id - condition ID * !nativeeditor_status - inserted/deleted/updated * matchi (1/0) * matchn (1/0) * match * field * data This inserts/updates/deletes the specified message condition text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userrulelist?rev=1542192349&do=diff UserRuleList Replacement Use: ~userrulelist~ <format string> ~end~ Required parameter: None This returns the message rule list (in order) for the current 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/mailapi:userruleupdate?rev=1542192349&do=diff UserRuleUpdate Replacement Use: ~userruleupdate~ Required parameter: * 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/mailapi:version_5_webmail_api?rev=1542192349&do=diff Version 5 Web Mail API This section is only relevant for people who may want to access the WebMail features from their own scripts, or want to customise the standard Webmail 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.