https://wiki.pscs.co.uk/ 2026-06-22T15:40:22+00:00 https://wiki.pscs.co.uk/ https://wiki.pscs.co.uk/_media/wiki:dokuwiki.svg text/html 2026-05-29T10:39:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_server_script?rev=1780051175&do=diff End() End() This function is called by VPOP3 when the SMTP service session ends 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 2023-08-16T07:48:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_pop3_client_script?rev=1692172081&do=diff POP3 Client Lua Scripting The POP3 Client Lua Script is called POP3CLT.LUA and is edited in Settings -> Scripts. This script is called whenever VPOP3 runs a POP3 session to download messages from a remote POP3 server. VPOP3 will call the following Lua functions in the script at the following times: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_delivery_script?rev=1542192349&do=diff User Delivery Script (VPOP3 v6.5 or later) If there is a <username>/delivery.lua script, this Lua script can override VPOP3's message delivery options. You can edit this in the Settings -> Scripts page in the settings. This script affects how VPOP3 will handle how messages being delivered to this user are handled. 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 2026-05-22T21:08:32+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:attachment_processing_script?rev=1779484112&do=diff Attachment Processing Script (Added in v7.6) This is the AttachmentProcess.lua script which can be edited in Settings -> Scripts. This script has functions to allow message attachments to be altered: * NeedsRecode * NeedsRewrite * GetRename text/html 2021-08-09T10:55:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:scheduler_script?rev=1628506507&do=diff Scheduled Task Script Note that this functionality is only available in VPOP3 Enterprise VPOP3 Enterprise can run Lua script periodically to do custom background tasks. It can run a function every minute, 5 minutes, hourly or daily. The Lua script is stored in a file called text/html 2026-03-26T11:41:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_rules_script?rev=1774525319&do=diff Lua SMTP Rules Scripts When VPOP3 is processing SMTP Rules for messages received by SMTP, it runs a script called smtprules_(x).lua, where (x) is replaced by the numeric ID of the SMTP service VPOP3 processes SMTP Rules at least three times for each message - once when MAIL FROM has been received, once for each RCPT TO, and once when the whole message data has been received. 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-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 2026-01-05T09:25:39+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:password_strength_checking_script?rev=1767605139&do=diff Password Strength Checking Script You can tell VPOP3 to enforce password strength checks by using a Lua script which performs the checks for you. The Lua script can be edited in Settings -> Scripts and is called passwordcheck.lua (in older versions of VPOP3 it is stored in a file called text/html 2026-05-26T12:55:21+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:quarantine_mailer_script?rev=1779800121&do=diff Quarantine Report Mailer Scripting (Added in v9.1) This script is called when VPOP3 is mailing out (or considering mailing out) spamfilter quarantine reports. It allows customisation of the emailed reports and whether they're generated AreMailsNeeded text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:scheduling_management_scripts?rev=1542192349&do=diff Scheduling Management Scripts VPOP3 runs a script called scheduler.lua in the background, it will periodically call functions in this script at approximately 1 minute, 5 minute, 1 hour and 1 day intervals. These times are only approximate so should not be relied upon for timing. text/html 2026-05-29T13:47:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_manager_script?rev=1780062421&do=diff User Manager Script If you want people to be able to log in using a different username than their VPOP3 username (eg if you want them to be able to log in using an email address), then you can use the UserManager Lua script The Lua script is managed through the Settings → Scripts page in VPOP3 v8.0 and later and is called 'UserManager.LUA' 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: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:imap4_advanced?rev=1542192349&do=diff IMAP4 -> Advanced tab This page is reached from Services -> IMAP4 Server, then the Advanced tab. Here are some advanced options for the IMAP4 service in VPOP3 Fake access to inaccessible mailboxes In the IMAP4 service you may have folders which do not exist. For instance, if you are accessing a shared Inbox folder from a user called 'Karen', then their folder will be called text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:import_users_from_file?rev=1542192349&do=diff Import Users From File VPOP3 supports the importation and exportation of users, via a CSV file (see for a specification of the CSV file format). NOTE: This process is not designed to provide a complete backup of user data, nor is it intended to facilitate moving VPOP3 to a new computer. Instead, see the following relevant pages: text/html 2019-08-27T16:13:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_monitor_script?rev=1566922420&do=diff Monitor Scripting (Added in V6.15) This script has three functions: * MonitorIncoming * MonitorInternal * MonitorOut The functions are similar, except they are called when different messages are to be monitored (incoming, internal and outgoing messages respectively). 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:schedule?rev=1542192349&do=diff Mail Connectors -> Connector Schedule The Connector Schedule tells VPOP3 when to connect to send mail using Mail Senders and collect mail using Mail Collectors. It does not affect incoming SMTP over a permanent connection, or LAN Forwarding. The connection schedule also tells VPOP3 when to check for updates to the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:signature_script?rev=1542192349&do=diff Signature Script If you want more complex signatures on outgoing emails, rather than the static text/HTML you can define within VPOP3, then you can use a simple Lua script to define the signature. The Lua script is stored in a file called signature.lua text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_definerule?rev=1542192349&do=diff Spam Filter Rules: DefineRule Statement DefineRule Version 2.1.9+ Purpose Defines a rule name, default weighting and description. See Rule names and weights The DefineRule statement requires a name, default weight and description, in the format DefineRule "<name>" <default weights> "<description>" text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:summary_log_file_format?rev=1542192349&do=diff Summary Log File Format VPOP3 creates a file called SUMMARY.LOG in the VPOP3 directory which contains summary information which is compiled daily into a daily summary reports sent to the administrator. VPOP3 can keep these summary logs in a subdirectory called text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_offline?rev=1542192349&do=diff Message Archive -> Offline Tab Settings -> Message Archive -> Offline Tab. The Offline tab lets you tell VPOP3 to move old archived messages to an alternative store, such as CD/DVD or external drive etc. VPOP3 will create a ZIP file containing the old messages. The archive index will still remember the messages, and the name of the ZIP file they are contained in, so you will still be able to search for messages on date, sender, subject, etc, but not on the message content. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:attachment_extraction_script?rev=1542192349&do=diff Attachment Extraction Scripting This is the 'extraction.lua' script. (Added in V6.17) This script has one functions: * Extract This functions is called if the attachment extraction is enabled in Settings -> Attachment Processing -> Extraction. 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 2025-05-28T09:24:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:autoresponder_script?rev=1748424278&do=diff Autoresponder scripting For scripting to alter the whole autoresponder definition and set in the VPOP3 settings rather than embedded in an autoresponder itself, see Autoresponder Global Scripting In an autoresponder, you can create a Lua script by surrounding it with <lua> & </lua> tags, eg text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_restore?rev=1542192349&do=diff Database -> Restore Tab This tab is only in VPOP3 Enterprise (v5 and later), and is for performing a partial (mailbox/mail folder) restore of the database. To do a full restore of the database, or for VPOP3 Basic/Standard, see the “Restore a Backup of VPOP3” topic Using 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 2023-11-20T10:18:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:error_handling_script?rev=1700475481&do=diff Error Handling Scripting For most error messages that VPOP3 generates, it allows control of error messages, eg to limit the frequency of error messages if they would be generated repeatedly. These limits are set in Settings -> Admin Settings -> Message Control. However, if you want more granular control, you can use Lua scripting for more fine-grained control text/html 2026-05-26T16:46:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:imap4_server_script?rev=1779813984&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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lists?rev=1542192349&do=diff Lists The Lists section in VPOP3 lets you view and manage the various types of 'List' which VPOP3 supports * Distribution Lists * Mailing Lists * Forwardings * ODBC Mailing Lists * Groups Using a list A list will contain zero or more 'members' (usually email addresses) which can be messaged all at once. To send a message to all the members of a list, you will usually send an email to the listname at a valid domain. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:logging?rev=1542192349&do=diff Logging Activity Summary Reports You can tell VPOP3 to send you a daily summary report each day. To do this check the box to say Send daily summary logs to, and choose the appropriate user (or “Main Administrator” if you want the reports to be sent to the 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:management_scripting?rev=1542192349&do=diff Management Scripting In VPOP3 Enterprise, from version 6.17 there is the facility to run Lua scripts manually or according to a schedule. These scripts can do things like access mail folders & messages and perform some maintenance on them. Creating a new script text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:mappings?rev=1542192349&do=diff Mappings In VPOP3, Mappings are a way of explicitly linking an email address to a user or list. They can also be used to indicate that an email address is remote, even though it would otherwise appear to be a local email address. In other email servers, a similar feature may be called 'aliases' text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:misc_external_fax?rev=1542192349&do=diff Misc -> External Fax Tab Settings -> Misc Settings -> External Fax The External Fax tab is for use with some external fax server applications which work by collecting mail from a POP3 mailbox. If a Fax Server Mailbox is selected, then VPOP3 will automatically send any locally sent mail to that mailbox if the recipient is local, but doesn't match another local address (a user, list, mapping etc), 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:smtp_spam_reduction?rev=1542192349&do=diff SMTP Server -> Spam Reduction The Spam Reduction tab lets you configure various ways VPOP3 can reduce spam and email address spoofing Domainkeys “Domainkeys” is a way of signing a message to show that it comes from the person it claims to come from. The system is too complex to go into here, but it essentially takes key parts of the message header, as well as the message body and creates a PKI digital signature on it, using a 'private key' on your system. The receiving end will find the same… text/html 2020-10-05T16:14:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_header?rev=1601914452&do=diff Increase the spam score for header marker This script is for the case where your ISP adds a header eg 'X-Spam: Yes' to the message header, and you want the VPOP3 spamfilter to quarantine messages with that marker. Add the following to the spamrules_userchecks.txt file. This script file only gets processed on incoming messages (the spamrules_localmail.txt script ends the processing of locally sent messages) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dns?rev=1542192349&do=diff Spam Filter Rules: DNS Statement DNS Version 2.1.11+ Purpose Allows the script to perform an arbitrary DNS lookup, returning the result into a specified variable The DNS statement requires a type, hostname and variable name, in the format DNS <type> <hostname> <variable name> 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_escape?rev=1542192349&do=diff Spam Filter Rules: Escape Statement Escape Version 2.3.6+ Purpose 'Escapes' the specified variable ready to pass as a regular expression The Escape statement should be called immediately before the variable, in the format Escape <variable name> Example ${myvar} = "This costs $10.00" Escape myvar # ${myvar} is now "This costs \$10\.00" 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: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:status_monitor?rev=1542192349&do=diff VPOP3 Status Monitor The VPOP3 status monitor allows users to see what VPOP3 is doing, and also, optionally, to send/receive simple 'instant messages' between local users. Different users can have different permissions for the status monitor. They can be set for all administrators or non-administrators on text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_permissions?rev=1542192349&do=diff Permissions This section lets you configure the permissions that a particular user has. Allowed Protocols The Allowed Protocols section lets you specify which services this user has access to. Note that these settings affect access to the whole service. If you want users to be able to access a service from some IP addresses, but not from others, then use the 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.