https://wiki.pscs.co.uk/ 2026-05-06T10:13:39+00:00 https://wiki.pscs.co.uk/ https://wiki.pscs.co.uk/_media/wiki:dokuwiki.svg text/html 2025-05-08T08:23:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_server_script?rev=1746692615&do=diff SMTP Server Lua Scripting The SMTP Server Lua Script is called SMTPSVR.LUA and can be edited from the Settings -> Scripts page in the VPOP3 settings. This script is called whenever an instance of the VPOP3 SMTP server is launched - ie whenever someone opens a connection to port 25 on the VPOP3 server to send it a message, whether from a local user or an incoming SMTP message. 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/reference:spamrules_statement_ifmatch?rev=1542192349&do=diff Spam Filter Rules: IfMatch Statement IfMatch Version 2.1.7+ Purpose Allows you to perform a regular or substring match on a variable or part of the message being processed IfMatch statements require a data parameter and a search value, in the format text/html 2026-03-16T16:00:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/wiki:syntax?rev=1773676810&do=diff Formatting Syntax DokuWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing 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 2026-03-16T11:12:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:group_a_user_s_folders_into_letter_groups?rev=1773659562&do=diff Group a user's folders into letter groups This is useful in VPOP3 Enterprise if you have a large folder with many subfolders and want to group the subfolders into other subfolders based on their first letter For example, if you have * Customers text/html 2026-02-24T15:49:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_mx_control?rev=1771948188&do=diff Lua SMTP MX Control Every time VPOP3 is going to send messages using direct MX sending, it runs a script called mxout.lua which can be created/edited in Settings -> Scripts (or in the VPOP3 directory in VPOP3 v6.6 or earlier). Global Variables Starting with v8.8, the following global variables are defined: text/html 2025-06-06T08:12:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_countmatches?rev=1749197557&do=diff Spam Filter Rules: CountMatches Statement CountMatches Version 2.3.13+ Purpose Counts the number of times a specific regular expression matches in a string CountMatches statements require a data parameter, a search value, and the name of the variable to place the count into, in the format text/html 2025-06-06T08:15:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_globalmatch?rev=1749197750&do=diff Spam Filter Rules: GlobalMatch Statement GlobalMatch Version 2.3.13+ Purpose Does a RegExp match on the supplied data and puts the results in a bag The GlobalMatch statement requires a data parameter, a search value, and the name of a bag to place the matches into, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_sendmessage?rev=1542192349&do=diff Spam Filter Rules: SendMessage Statement SendMessage Version 2.4.5+ Purpose Allows you to send a message The SendMessage statement requires a recipient, subject, message text and a currently unused options parameter, in the format SendMessage <recipient> <subject> <message text> <options> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getmessagepart?rev=1542192349&do=diff VPOP3.GetMessagePart The Lua function 'VPOP3.GetMessagePart' retrieves a MIME part of the message currently being processed. This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: * The MIME part 'Path' from the MimeStructure parameter to the ProcessMessage function text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getmessagepartbody?rev=1542192349&do=diff VPOP3.GetMessagePartBody The Lua function 'VPOP3.GetMessagePartBody' retrieves the content of a MIME part of the message currently being processed. This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getmessagepartheader?rev=1542192349&do=diff VPOP3.GetMessagePartHeader The Lua function 'VPOP3.GetMessagePartHeader' retrieves a MIME section header of the message currently being processed. This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: 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: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: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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:10055?rev=1542192349&do=diff Socket Error 10055 - No Buffer Space Available Error 10055 means that Windows has run out of TCP/IP socket buffers because too many connections are open at once. Things to check if this happens are: * Is there any other TCP/IP software running on the same PC as VPOP3 - eg a proxy server text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:backup_vpop3?rev=1542192349&do=diff How to Backup VPOP3 By default VPOP3 v3 and later will automatically perform a daily backup of the database into a file called DBBACK-x.DMP, where the backup file rotates on a weekly basis (DBBACK-0.DMP is Sunday's backup, DBBACK-1.DMP is Monday's backup, etc). 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: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: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. text/html 2026-03-23T15:29:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:autoresponder_global_script?rev=1774279769&do=diff Autoresponder Global Scripting For scripting to modify the autoresponder text which is embedded in the autoresponder itself, see Autoresponder Scripting The Autoresponder Global Script is executed for every autoresponse. It is stored in the 'Autoresponder.lua' script in Settings → Scripts text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:bandwidth_management_script?rev=1542192349&do=diff Bandwidth Control (VPOP3 Enterprise Only) Every time a connection is made to a VPOP3 service, or a user logs into a service, VPOP3 Enterprise runs a Lua function which can assign the connection a bandwidth pool, or assign a bandwidth limit on the connection. text/html 2024-10-29T15:59:51+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_hash_functions?rev=1730217591&do=diff Lua Hashing Functions Added in VPOP3 8.7 Four functions have been added to perform hash algorithms on a text string * VPOP3.SHA1(string) * VPOP3.SHA256(string) * VPOP3.SHA512(string) * VPOP3.MD5(string) All functions take a string parameter, and return a table of numbers containing the hash value (one byte per table entry). The length of the returned table are: text/html 2025-08-14T09:24:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_relay_control?rev=1755163495&do=diff Lua SMTP Relay Control Every time VPOP3 is going to send messages via SMTP Relay, it runs a script called relayout.lua in the VPOP3 directory. Global Variables This script may have global variables, depending on your version of VPOP3. In VPOP3 3.0.0L and later, there are two read-only global variables set at the start of the script: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:misc_general?rev=1542192349&do=diff Misc -> General Tab VPOP3 Host Name The VPOP3 Host Name is used by VPOP3 when it is telling other mail software what it is called. For instance, when it connects to another SMTP server it will send the host name as the parameter for the HELO or EHLO command, and when an SMTP client connects to VPOP3, it announces its name in the welcome banner as required by the SMTP standard. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_bulkscan?rev=1542192349&do=diff Spam Filter Rules: BulkScan Statement BulkScan Version 2.1.7+ Purpose Allows you to specify lots of search strings in one section without needing the verbose If statement The BulkScan statement requires a variable name and a limitless number of search specifiers, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_convert?rev=1542192349&do=diff Spam Filter Rules: Convert Statement Convert Version 2.4.9+ Purpose Allows you to convert data from one form to another The Convert statement requires a data parameter, conversion method and variable name, in the format Convert <data> <conversion method> <variable name> text/html 2024-10-29T16:06:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.base64?rev=1730217971&do=diff VPOP3.Base64 Added in VPOP3 8.7 This function returns a Base64 string encoding of the supplied parameter VPOP3.Base64(text) or VPOP3.Base64(byte-array) It can be passed either a text string or a table containing one byte per table-entry (eg as returned from the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getmessagelines?rev=1542192349&do=diff VPOP3.GetMessageLines The Lua function 'VPOP3.GetMessageLines' retrieves content lines from the message currently being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: * number - number of lines to retrieve text/html 2018-12-11T17:06:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getsetting?rev=1544547961&do=diff VPOP3.GetSetting The Lua function 'VPOP3.GetSetting' retrieves a general setting from VPOP3 It takes one parameter: * The name of the setting. This can either by the 'Name' field of the 'Settings.Settings' database table or the internal setting name text/html 2024-10-29T16:08:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.hexstring?rev=1730218081&do=diff VPOP3.HexString Added in VPOP3 8.7 This function returns a Hex string encoding of the supplied parameter VPOP3.HexString(text) or VPOP3.HexString(byte-array) It can be passed either a text string or a table containing one byte per table-entry (eg as returned from the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.messageseek?rev=1542192349&do=diff VPOP3.MessageSeek The Lua function 'VPOP3.MessageSeek' sets an internal read pointer to the specified location of the message being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.postgresquery?rev=1542192349&do=diff VPOP3.PostgresQuery The Lua function 'VPOP3.PostgresQuery' performs a query on the PostgreSQL database and returns the results in a table It takes a single parameter which is the SQL query to perform (Note that any relations used in the query must have the schema specified). text/html 2021-03-09T16:37:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.setsetting?rev=1615307830&do=diff VPOP3.SetSetting The Lua function 'VPOP3.SetSetting' sets a general setting forVPOP3 It takes two parameters: * The name of the setting. This can either by the 'Name' field of the 'Settings.Settings' database table or the internal setting name * The data to set (must be a string) text/html 2021-03-09T16:42:44+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3net.gethttp?rev=1615308164&do=diff VPOP3Net.GetHTTP This function takes a single parameter * the URL to retrieve. This can be http:// or https:// The function returns two values * a table containing the result of the GET * Host - the hostname * File - the filename * Headers - a table containing the response headers