PSCS Wiki
https://wiki.pscs.co.uk/
2026-05-06T11:56:12+00:00PSCS Wiki
https://wiki.pscs.co.uk/
https://wiki.pscs.co.uk/_media/wiki:dokuwiki.svgtext/html2026-02-24T15:49:48+00:00Anonymous (anonymous@undisclosed.example.com)Lua SMTP MX Control
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/html2025-08-14T09:24:55+00:00Anonymous (anonymous@undisclosed.example.com)Lua SMTP Relay Control
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: ZipContentsFull
https://wiki.pscs.co.uk/reference:spamrules_statement_zipcontentsfull?rev=1542192349&do=diff
Spam Filter Rules: ZipContentsFull
Statement ZipContentsFull Version 6.7+ Purpose Enables the script to obtain the list of files contained in a ZIP attachment
The ZipContentsFull statement requires a message section number and bag name, in the formattext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Autoresponder Commands
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Database -> Restore Tab
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 thetext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Mail tab
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)SMTP Reputation Stats
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/html2023-01-18T15:57:13+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules
https://wiki.pscs.co.uk/reference:spam_filter_rules?rev=1674057433&do=diff
Spam Filter Rules
VPOP3 Versions 2.1.7 and later have a built-in spam filter system which supports a simple script language optimised for content- and spam-filtering of email messages.
This reference contains a definition of the spam filtering script language supported by VPOP3. Note that as later versions of VPOP3 are released, more language features may be added, so this reference indicates in which version of VPOP3 a particular feature was added.text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: AddHeader
https://wiki.pscs.co.uk/reference:spamrules_statement_addheader?rev=1542192349&do=diff
Spam Filter Rules: AddHeader
Statement AddHeader Version 2.1.7+ Purpose Allows you to add, replace or remove the specified header line in the message headers
The AddHeader statement requires the full header line in one continuous string, in the formattext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Webmail Tabs
https://wiki.pscs.co.uk/reference:webmail_tabs?rev=1542192349&do=diff
Webmail Tabs
From version 4 onwards, VPOP3 webmail has a tabbed structure, which enables you to move between various screens with minimal effort.
By using tabs, the entire webmail can be loaded in one go - so there is no need to waste time and bandwidth by downloading the same key components each time you switch between the various parts of the webmail.text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)What's new in version 5 webmail?
https://wiki.pscs.co.uk/reference:whats_new_in_version_5_webmail?rev=1542192349&do=diff
What's new in version 5 webmail?
This is a list of some of the most noticeable changes to VPOP3's webmail interface for version 5. For a more detailed list of changes, view our bugtracker.
[VPOP3 Version 5 - mobile compatible webmail]
Mobile compatible webmail
If you access version 5 webmail from a mobile device, you will probably be redirected to the mobile compatible version. It is a cut-down version of Webmail, which retains the key features, but doesn't utilise the extra features which w…text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)About
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 informationtext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Message Archive -> General
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 thetext/html2023-03-25T23:33:31+00:00Anonymous (anonymous@undisclosed.example.com)Archive Script
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Delete list member from all lists
https://wiki.pscs.co.uk/reference:delete_list_member_from_all_lists?rev=1542192349&do=diff
Delete list member from all lists
You can delete an email address from all VPOP3 distribution & mailing lists.
Go to Settings → Database → Query
Alternatively, at a command prompt in the VPOP3 directory run
psql
(The password is 'vpop3pass')text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Settings -> Diagnostics
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 atext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Import Users From File
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/html2025-05-08T08:23:35+00:00Anonymous (anonymous@undisclosed.example.com)SMTP Server Lua Scripting
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Offline Archive Error Messages
https://wiki.pscs.co.uk/reference:offline_archive_error_messages?rev=1542192349&do=diff
Offline Archive Error Messages
* (2) ZIP file structure invalid (eg disk corruption)
* (3) Out of memory
* (4) Internal logic error in ZIP compressor
* (8) ZIP file invalid or insufficient memory
* (10) Temporary File failure
* (11) Input file read failure (eg virus scanner blocking access to archived files)text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)POP3 Mail Collection
https://wiki.pscs.co.uk/reference:pop3_collection?rev=1542192349&do=diff
POP3 Mail Collection
POP3 Mail Collection is when VPOP3 will collect mail from an external POP3 mailbox - for instance, from an Internet Provider.
POP3 General
This page tells VPOP3 how to collect mail.
* POP3 Server Address - this is the name (or IP address) of the POP3 server from which you want VPOP3 to collect mailtext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Quarantine tab
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Mail Sender Advanced Settings
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 ruletext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)SMTP Direct Sender Settings
https://wiki.pscs.co.uk/reference:sender_direct_settings?rev=1542192349&do=diff
SMTP Direct Sender Settings
Mail Connectors -> Mail Senders -> SMTP Direct Sender -> Settings tab
The SMTP Direct Settings tab lets you set how VPOP3 will send mail using SMTP Direct
DNS Servers to Use
This setting tells VPOP3 the IP addresses of the DNS servers it should use to find the recipients' mail servers. Separate multiple addresses with commas.text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Mail Connectors -> Mail Senders -> SMTP Direct
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: GetAddressType
https://wiki.pscs.co.uk/reference:spamrules_statement_getaddresstype?rev=1542192349&do=diff
Spam Filter Rules: GetAddressType
Statement GetAddressType Version 2.4.6+ Purpose Analyses a specified email address and reports what 'type' of address it is
The GetAddressType statement requires an email address and variable name, in the formattext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: GetDecodedSection
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 GetDecodedSectiontext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: StartDNS
https://wiki.pscs.co.uk/reference:spamrules_statement_startdns?rev=1542192349&do=diff
Spam Filter Rules: StartDNS
Statement StartDNS Version 2.2.1+ Purpose Begins an asynchronous DNS lookup in advance of the result being required in a subsequent DNS statement
The StartDNS statement requires a type and hostname, in the format
StartDNS <type> <hostname>text/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: StartDNSBL
https://wiki.pscs.co.uk/reference:spamrules_statement_startdnsbl?rev=1542192349&do=diff
Spam Filter Rules: StartDNSBL
Statement StartDNSBL Version 2.2.1+ Purpose Begins an asynchronous DNS blacklist lookup in advance of the result being required in a subsequent DNSBL statement
The StartDNSBL statement requires a hostname and DNSBL zone, in the formattext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: StartSURBL
https://wiki.pscs.co.uk/reference:spamrules_statement_startsurbl?rev=1542192349&do=diff
Spam Filter Rules: StartSURBL
Statement StartSURBL Version 2.2.1+ Purpose Begins an asynchronous SURBL lookup in advance of the result being required in a subsequent SURBL statement
The StartSURBL statement requires a hostname and SURBL zone, in the formattext/html2023-08-14T16:01:01+00:00Anonymous (anonymous@undisclosed.example.com)Spam Filter Rules: Variables
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Autoresponder
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/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)VPOP3.SaveAttachment
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 savetext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Webmail Menu bar
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 menutext/html2018-11-14T10:45:49+00:00Anonymous (anonymous@undisclosed.example.com)Spamfilter White/Blacklists
https://wiki.pscs.co.uk/reference:white_black_lists?rev=1542192349&do=diff
Spamfilter White/Blacklists
This lets you set whitelists & blacklists for the spam filter.
There are four lists you can manage. The Whitelist Addresses & Blacklist Addresses lists let you specify sender email addresses to check. With the default rule weights, if a sender's address is on the Whitelist, it will be allowed through the spam filter, and if it is on the Blacklist it will be blocked. If an address is on both the Whitelist and the Blacklist, they will cancel each other out, and the me…