https://wiki.pscs.co.uk/ 2026-05-06T11:55:55+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/reference:autoresponder_commands?rev=1542192349&do=diff Autoresponder Commands This article only applies to VPOP3 v4 and earlier A VPOP3 autoresponder can contain special text strings to create special behaviour, in addition to plain text as part of the response. There are three types of 'command' * 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 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 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:status?rev=1542192349&do=diff Status The VPOP3 Status screen has two tabs * Server Status * Sessions Server Status The Server Status tab is essentially a copy of the VPOP3 Status Monitor information. * Connection Status - this shows the 'online' status of VPOP3. If it says idle, it does not mean VPOP3 is not working, or not doing anything, it just means that it is not currently sending or collecting mail from the Internet. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:misc_dns?rev=1542192349&do=diff Misc -> DNS Tab Settings -> Misc Settings -> DNS The DNS tab lets you specify which DNS servers VPOP3 will use. DNS (Domain Name System) is a system which converts Internet host names (eg www.google.com) into a numeric IP address (eg 1.2.3.4), because all connections on the Internet are actually performed using numeric IP addresses, but it is easier for people to remember names. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:webmail_menu?rev=1542192349&do=diff Webmail Menu bar The Webmail Menu bar within VPOP3 webmail enables you to quickly perform relevant actions. The Menu has six main headings; of which, three have multiple options. Option Active Function V Notes Message Mail and View Message tabs Opens/closes Message menu text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:diagnostics?rev=1542192349&do=diff Settings -> Diagnostics The Diagnostics page allows you to enable, configure and disable various methods of diagnostic logging, within VPOP3. Log file overview By default, VPOP3 will keep two copies of most log files: * The current log file, with a 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 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:send_admin_message?rev=1542192349&do=diff Send Admin Message It is possible for administrator users to send a bulk email message to an entire group or list. To begin composing an email, go to the Administration Settings -> Users page, and click Send Admin Message. This should then open a window, which allows you to specify various options. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:webmail_status_bar?rev=1542192349&do=diff Webmail Status bar The Status bar within VPOP3 webmail displays important information at a glance. [VPOP3 version 5.0 Webmail Status bar] User - At the far left, is a display to let you know which user is currently logged in. Version - After the username, there is an indication of the current VPOP3 version. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:address_book_tab?rev=1542192349&do=diff Address Book tab The Address Book tab within VPOP3 webmail enables you to manage your lists of contacts and add those contacts into a new or existing message. Substantial alterations to the interface were introduced in version 5. Both interfaces are documented. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_general?rev=1542192349&do=diff Message Archive -> General Settings -> Message Archive -> General Tab Archive Messages If the Archive Messages box is checked, then VPOP3 will archive incoming and outgoing messages. Main Archive Store Directory You can set the message archive store to any directory accessible by the VPOP3 service. Enter the path in the 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: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 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: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: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 2023-03-27T10:32:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_routing_script?rev=1679913138&do=diff User Routing Script If there is a <username>/user_redirect.lua script, this Lua script can override VPOP3's message routing options. You can edit this either in the Settings -> Scripts page in the settings, or via the 'Routing' tab in the user's settings in the VPOP3 administration console. This script affects how VPOP3 will handle how messages text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:about?rev=1542192349&do=diff About The VPOP3 'About' page lets you see the version and build number of your VPOP3 installation, along with any licence details, and supplier details (if any) Licence Information The Licence Information section shows your current licence information text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_message_store?rev=1542192349&do=diff Database -> Message Store Tab This tab says how VPOP3 handles its message store Message Store The Delay while moving messages setting tells VPOP3 how quickly to import messages into the new database structure if it was upgraded from version 2.x or earlier. Usually this is OK to be left as it is, but if there is some special requirement to import the messages more quickly, you can decrease this number, but that will increase the load on the server. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:download_rules?rev=1542192349&do=diff Download Rules Download rules are a facility in VPOP3 where it can look at message summary information before downloading a message from an ISP POP3 mailbox (they do not work on incoming SMTP messages - use SMTP Rules for that) To edit download rules, go to text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:global_signature?rev=1542192349&do=diff Global Signature You can set a Global Signature in VPOP3 by going to Settings -> Global Signature The Global Signature option lets you tell VPOP3 to add a standard piece of text or HTML to the bottom of all outgoing messages. You can create just a plain text, or text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lan_forwarding_queue_status?rev=1542192349&do=diff LAN Forwarding Queue Status To view the LAN Forwarding Queue Status, go to Settings -> Local Mail -> LAN Forwarding -> Queue Status The LAN Forwarding Queue shows the messages which VPOP3 has currently got queued to be sent to another mail server on your network using SMTP. The LAN Forwarding Queue status page shows a simple list of the messages waiting to be sent. The four columns in the table show: 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:mail_tab?rev=1542192349&do=diff Mail tab The Mail tab within VPOP3 webmail enables you to manage your sent and received messages. As you can see from the screenshot, the page is divided into three main sections: Menu bar General tab bar Status bar [Mail tab - VPOP3 Version 5 Webmail] Page structure Mail toolbar The Mail toolbar contains the following buttons: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:message_monitoring?rev=1542192349&do=diff Message Monitoring Message monitoring in VPOP3 will tell VPOP3 to send a copy of all the outgoing, internal and/or incoming mail from/to specified users to be sent to another specified user. In the current versions of VPOP3, all monitored messages are sent to the same user (or list), you cannot specify different recipients for different monitored users. (This may be something that is added/enhanced in the future) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:reports?rev=1542192349&do=diff Reports The Reports tab lets you access various reports about VPOP3 or message history. For many of reports to work, you need to have previously enabled historical logging. The currently available reports are listed below. To view a report, click on its name at the left of the page text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:security_intrusion_protection?rev=1542192349&do=diff Security Settings -> Intrusion Protection Tab Settings -> Security Settings -> Intrusion Protection Tab Starting in VPOP3 v6.0, VPOP3 can monitor failed logins for all accounts across all services and block an attacker's IP address from accessing VPOP3 for a specified time text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:sender_advanced_settings?rev=1542192349&do=diff Mail Sender Advanced Settings Mail Connectors -> Mail Senders -> (name) -> Advanced Advanced Domain Filtering For VPOP3 v6.11 and later, see the Domain Filtering section of the user manual. The Domain Filtering box lets you restrict which email messages are sent via this Mail Sender. You specify each rule on a separate line, and the message will be sent if it matches any sender rule text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_direct?rev=1542192349&do=diff Mail Connectors -> Mail Senders -> SMTP Direct VPOP3 can be configured to send mail directly to the recipient's mail server (or the recipient's mail service provider). Usually this is only used if you have a high-end business class Internet connection - such as a leased line, or your mail server is co-located in a data centre. Attempts to use SMTP Direct sending on a dial-up/ADSL/Cable/FTTC/etc connection may be problematic since the receiving mail server may think you a home user who has been … text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_filtering?rev=1542192349&do=diff SMTP Service - Filtering The SMTP Server -> Filtering tab lets you set up filtering of messages going through the VPOP3 SMTP service. This may be incoming SMTP messages, or locally sent messages. SMTP Rules SMTP Rules let you create custom rules for processing messages as they go through the VPOP3 SMTP service. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_general?rev=1542192349&do=diff SMTP -> General tab This page is reached from Services -> SMTP Server, then the General tab. This page lets you set general settings for the SMTP service component of VPOP3. The SMTP service is how users send outgoing mail, and how incoming SMTP messages arrive. Service Name text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_ids_ips?rev=1542192349&do=diff SMTP Server -> IDS/IPS The IDS/IPS tab lets you set logging and automatic blocking parameters for the IDS (Intrusion Detection System) and IPS (Intrusion Prevention System) component of the SMTP server. SMTP servers are regularly attacked, both by incoming mail attacks (spam/viruses etc) and relay attacks (by spammers and other malware distributors trying to send mail through them). Because of this, there is a system in VPOP3 which will track attack attempts on the SMTP service and can automat… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_reputation_stats?rev=1542192349&do=diff SMTP Reputation Stats (Added in v6.20) If you receive email by direct incoming SMTP (not via an ISP or filtering service) then you can tell VPOP3 to report sender reputation statistics back to VPOP3. This is enabled/disabled in the Settings -> Misc Settings page. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamfilter_script_configuration?rev=1542192349&do=diff Spamfilter Script Configuration tab You reach this tab by going to Settings --> Spam Filter -> General, and then choose the General tab. The Spamfilter script has various settings that can be changed to alter the behaviour of the spamfilter. These are defined in the script, so may change with different versions of the script. The settings are currently: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addbayesham?rev=1542192349&do=diff Spam Filter Rules: AddBayesHam Statement AddBayesHam Version 2.1.7+ Purpose Adds the current message to the 'not-spam' (or 'ham') Bayesian database Example Add the message to the 'not-spam' database if score is less than 100 If ${Score} < 100 AddBayesHam EndIf text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addbayesspam?rev=1542192349&do=diff Spam Filter Rules: AddBayesSpam Statement AddBayesSpam Version 2.1.7+ Purpose Adds the current message to the 'spam' Bayesian database Example Add the message to the 'spam' database if score is 100 or more If ${Score} >= 100 AddBayesSpam EndIf text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_foreach?rev=1542192349&do=diff Spam Filter Rules: ForEach Statement ForEach Version 2.1.7+ Purpose Causes a loop to be run through for all values within specified criteria The ForEach statement requires either two or three parameters (depending on the type of loop that is being conducted), 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_include?rev=1542192349&do=diff Spam Filter Rules: Include Statement Include Version 2.1.7+ Purpose Including other files within the spam rules To include another file within the spam rules, insert a line saying ''Include <filename to include>'' There should not be any quotes around the filename to include, even if it contains spaces. Note that all files are within the same 'scope', so variables defined in one file will be visible within all subsequent included files. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_reject?rev=1542192349&do=diff Spam Filter Rules: Reject Statement Reject Version 2.4.5+ Purpose Perform an SMTP 'Reject' on the incoming message The Reject statement requires an error code/text string, in the format Reject <error string> This will reject the current SMTP message with the specified SMTP result code. Use a 4xx error code (eg 450) to reject the message temporarily, or a 5xx error code (eg 550) to reject the message permanently. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removebayesham?rev=1542192349&do=diff Spam Filter Rules: RemoveBayesHam Statement RemoveBayesHam Version 2.1.7+ Purpose Removes the current message from the 'not-spam' (or 'ham') Bayesian database Example Remove the message from the 'not-spam' database if score is 100 or more If ${Score} >= 100 RemoveBayesHam EndIf text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removebayesspam?rev=1542192349&do=diff Spam Filter Rules: RemoveBayesSpam Statement RemoveBayesSpam Version 2.1.7+ Purpose Removes the current message from the 'spam' Bayesian database Example Remove the message from the 'spam' database if score is less than 100 If ${Score} < 100 RemoveBayesSpam EndIf text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_star_stop?rev=1542192349&do=diff Spam Filter Rules: *STOP Statement *STOP Version 2.2.5+ Purpose Stops the parsing of the current spam filter script file The statements after the *STOP statement are not parsed, so will not cause syntax errors if they involve unrecognised commands. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_autoresponder?rev=1542192349&do=diff Autoresponder An autoresponder is a way of automatically replying to messages as they arrive in a user's mailbox. In VPOP3, an incoming message must arrive in a user's mailbox for the autoresponder to trigger. If you use forwards, assistants, mappings, etc to divert a message before it arrives in the mailbox, the autoresponder will never trigger. If you want to use an autoresponder, but not keep the original message, then make sure the message arrives in the mailbox (eg by using an 'Assistant'… 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: