https://wiki.pscs.co.uk/ 2026-05-06T10:17:33+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/reference:spamrules_statement_dbqueryone?rev=1542192349&do=diff Spam Filter Rules: DBQueryOne Statement DBQueryOne Version 6.16+ Purpose Queries the spam filter database for a single record/aggregate The DBQueryOne statement performs a query on the spam filter database and returns a single value which is either the value of a record or an aggregate of several records. text/html 2022-11-24T09:29:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:attachment_processing_script?rev=1669282143&do=diff Attachment Processing Script (Added in v7.6) This script has functions to allow message attachments to be altered: * NeedsRecode * NeedsRewrite * GetRename * GetContentDispositionLine (added in v7.8) * IsLockNeeded * RewriteAttachment text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_assignments?rev=1542192349&do=diff Spam Filter Rules: Assignments You can assign values to variables using the syntax ${variable} = value | ${variable} Assignment operators The spam filter rules support the following assignment operators: = Specify the value of the variable to equal the value after the assignment operator 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 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 2023-03-25T23:33:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_script?rev=1679787211&do=diff Archive Script (from VPOP3 v6 onwards) Archive scripting lets you indicate whether full message content should be stored in the message archive. This could be used, for instance, for filtering out messages containing credit card details. The message headers will still be archived, along with the explanation text returned by the script. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:listserver_commands?rev=1542192349&do=diff ListServer Commands The ListServer is an automated process in VPOP3 which manages mailing lists. People can send commands to the ListServer to perform various functions remotely. Whether these commands are allowed, and exactly how they work depends on the particular mailing list's settings. text/html 2026-02-24T15:50:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_mx_server_rules?rev=1771948203&do=diff Lua SMTP MX Server Rules Every time VPOP3 checks for remote MX server for sending messages using direct MX sending, it runs a script called mxserverrules.lua which can be created/edited in Settings -> Scripts (or in the VPOP3 directory in VPOP3 v6.6 or earlier). 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 2023-08-14T16:01:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_variables?rev=1692028861&do=diff Spam Filter Rules: Variables The VPOP3 spam filter script language supports simple variables. In most places these are specified as ${<variable name>}, but in some places they are just specified as <variable name> - for instance where a statement always puts its result into a variable. 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 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 2023-11-12T09:51:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:dmarc_reporter_script?rev=1699782700&do=diff DMARC Reporter Script (from VPOP3 v8.6 onwards) This script lets you customise how VPOP3 sends DMARC reports to the sending domain. This can be useful in case the sending domain's DMARC configuration is incorrect as that can cause errors sending the reports or cause messages to be 'stuck' in VPOP3's Outqueue. These problems won't cause any lasting damage, but may be inconvenient or annoying, so you can alter the behaviour using Lua scripting 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 2024-10-29T16:07:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.unbase64?rev=1730218035&do=diff VPOP3.UnBase64 Added in VPOP3 8.7 This function Decodes a Base64 string into the original data VPOP3.UnBase64(base64-text) It returns a table containing the decoded data bytes - one byte per table entry. If there was an error, it returns a Nil value text/html 2024-10-29T16:09:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.unhexstring?rev=1730218177&do=diff VPOP3.UnHexString Added in VPOP3 8.7 This function Decodes a Hex string into the original data VPOP3.UnHexString(hex-text) The input hex-text should have no extra spaces or punctuation, and be two hex digits per result byte. Any pairs of characters which are not valid hex will be processed as a 'zero' byte. 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: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: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: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: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 2025-08-18T15:28:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:configure_srs?rev=1755530891&do=diff Configure SRS In VPOP3 8.8 and later, you can use Lua scripting to implement 'SRS' (Sender Rewriting Scheme') in VPOP3 This involves adding a couple of functions to rewrite outgoing return paths in 'relayout.lua' or 'mxout.lua' as appropriate and a couple of functions to redirect rewritten bounce message recipients in 'smtpsvr.lua' 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: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: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: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: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 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:copy_smtp_rules?rev=1542192349&do=diff Copy SMTP Rules - Database Query This is an advanced Database action. There is no simple query that will perform the required operation, so we have to create a custom PostgreSQL function to copy the data. At a command prompt in the VPOP3 directory run 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 2025-06-23T10:51:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:imap4_server_script?rev=1750675906&do=diff IMAP4 Server Scripting (Added in V6.12) DoCapability function When the IMAP4 CAPABILITY command is received, VPOP3 generates a capability string based on settings, then calls DoCapability(ipaddr, capabilities) * ipaddr = IP address of the client computer text/html 2025-08-20T16:08:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lan_forwarding_script?rev=1755706120&do=diff LAN Forwarding Scripting (Added in V8.7) This is stored in the 'LanForwarding.lua' script in Settings -> Scripts Pre-send These functions are called before the message is placed in the LAN Forwarding queue There are two global variables set: * 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/reference:os.timedexecute?rev=1542192349&do=diff os.timedexecute The Lua function 'os.timedexecute' runs an external program with a time limit It takes three parameters: * The program/command line to execute * The time to wait for completion (in seconds). If this time expires, the program is terminated text/html 2024-03-21T10:49:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:outgoing_message_script?rev=1711018194&do=diff Outgoing Message Scripting Every time VPOP3 adds a message to the Outgoing mail queue, it runs a script called outmessage.lua. Scripts are stored as files in the VPOP3 directory in VPOP3 v6.6 and earlier, or managed through the Settings -> Scripts page in VPOP3 v6.7 and later. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:quarantine_tab?rev=1542192349&do=diff Quarantine tab The Quarantine tab within VPOP3 webmail is where you view and manage messages that have been quarantined by VPOP3's spam filter. As you can see from the screenshot, unlike many of the other webmail tabs, it is not divided into multiple sections: text/html 2020-10-23T16:07:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dnsbl?rev=1603469269&do=diff Spam Filter Rules: DNSBL Statement DNSBL Version 2.1.7+ Purpose Allows the script to perform a DNS blacklist lookup, returning the result into a specified variable The DNSBL statement requires a hostname, DNSBL zone and variable name, 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_getdecodedsection?rev=1542192349&do=diff Spam Filter Rules: GetDecodedSection Statement GetDecodedSection Version 2.1.11+ Purpose Returns a specified MIME section of a message into a variable, after processing any Base64 or Quoted-Printable encoding of the raw message data The GetDecodedSection text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getmd5?rev=1542192349&do=diff Spam Filter Rules: GetMD5 Statement GetMD5 Version 2.3.6+ Purpose Performs an MD5 hash on a string, and returns the result into the specified variable in hex encoded form The GetMD5 statement requires a string and variable name, in the format GetMD5 <string> <variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getsectionencoding?rev=1542192349&do=diff Spam Filter Rules: GetSectionEncoding Statement GetSectionEncoding Version 2.3.9+ Purpose Retrieves the MIME encoding method for the specified MIME section number, and returns the result into the specified variable The GetSectionEncoding statement requires a message section number and variable name, 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_getsectionmd5?rev=1542192349&do=diff Spam Filter Rules: GetSectionMD5 Statement GetSectionMD5 Version 2.3.6+ Purpose Performs an MD5 hash on a specified MIME section of the message, and returns the result into the specified variable in hex encoded form The GetSectionMD5 statement requires a message section number and variable name, 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_getusergroup?rev=1542192349&do=diff Spam Filter Rules: GetUserGroup Statement GetUserGroup Version 2.4.5+ Purpose Checks if the specified user is assigned to a VPOP3 group, and returns the group name The GetUserGroup statement requires a username and variable name, in the format GetUserGroup <username> <variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_surbl?rev=1542192349&do=diff Spam Filter Rules: SURBL Statement SURBL Version 2.1.7+ Purpose Allows a SURBL lookup on the specified hostname or IP address in the specified SURBL zone, and returns the result into the specified variable The SURBL statement requires a hostname, SURBL zone and variable name, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:virus_scan_filter_script?rev=1542192349&do=diff Virus Scan Filter Scripting (Added in V6.17) The VIRUSSCAN.LUA script has a single function FilterResult This function is called for every virus that a VPOP3-integrated (eg VPOP3 AV or Sophos SAV Interface) detects. The function has the opportunity to 'filter' the virus detection so that VPOP3 will act as if the virus was not detected. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getfolders?rev=1542192349&do=diff VPOP3.GetFolders Lua function The Lua management function 'VPOP3.GetFolders' retrieves a table containing all the mail folders for a specified user. VPOP3.GetFolders(username); It returns a table where the key is the folder name (in IMAP4 UTF-7 encoded format - see 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-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/reference:vpop3.getmessages?rev=1542192349&do=diff VPOP3.GetMessages Lua function The Lua management function 'VPOP3.GetMessages' retrieves a table containing all the mail messages in a specified folder. VPOP3.GetFolders(username, folder); * username is the username from VPOP3.GetUsers * folder is the folder from VPOP3.GetFolders It returns a table where the key is the message UID and the value is a table of: 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getusers?rev=1542192349&do=diff VPOP3.GetUsers Lua function The Lua management function 'VPOP3.GetUsers' retrieves a table containing all the users defined in VPOP3, it takes no parameters and returns a table indexed from 1 to N where the values are the user names. text/html 2024-10-29T16:03:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.hmac?rev=1730217799&do=diff VPOP3.HMAC Added in VPOP3 8.7 This function performs a HMAC (Hash-based Message Authentication Code) algorithm on supplied text using the supplied key VPOP3.HMAC(hash algorithm, string, key) The function takes three parameters: * Hash algorithm - text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.messagereset?rev=1542192349&do=diff VPOP3.MessageReset The Lua function 'VPOP3.MessageReset' resets an internal read pointer to the start of the message being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes no parameters The function returns no value 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.saveattachment?rev=1542192349&do=diff VPOP3.SaveAttachment The Lua function 'VPOP3.SaveAttachment' saves an attachment from the message being processed to a file This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes two parameters: * number - attachment number to save text/html 2021-08-09T10:58:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.sendmessage?rev=1628506726&do=diff VPOP3.SendMessage The Lua function 'VPOP3.SendMessage' sends a text email message It takes four parameters: * The email address of the sender * The email address of the recipient * The subject line * The message body The function returns one value: 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