https://wiki.pscs.co.uk/ 2026-05-06T12:35:56+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:misc_advanced?rev=1542192349&do=diff Misc -> Advanced Tab Settings -> Misc Settings -> Advanced You will normally not need to change any settings on this page unless VPOP3 technical support have suggested it. If you do make changes, and want to go back to the original settings, the Restore Defaults button will restore the settings to their defaults. 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:groups?rev=1542192349&do=diff Groups In VPOP3 a 'group' is mainly an administrative feature. If you only wish to have a list of email addresses to send messages to under one address, you should use the 'List' feature instead. The main function of Groups is to let you set certain user attributes for a whole group of users at once. 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:new_message_tab?rev=1542192349&do=diff New message tab The New message tab within VPOP3 webmail is where you prepare, edit and send messages, including replies and forwards. As you can see from the screenshot, the page is divided into two main sections: Menu bar General tab bar Status bar [New message tab - VPOP3 Version 5 Webmail] Page structure New message toolbar 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: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: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:attachment_processing?rev=1542192349&do=diff Settings -> Attachment Processing The Attachment Processing page allows you to configure VPOP3 to perform two distinct functions on messages that contain attachments: * * Filtering The Filtering tab is divided into four main sections: Attachment Filtering 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 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: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/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: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 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:admin_settings?rev=1542192349&do=diff Settings -> Admin Settings The Admin Settings page allows you to perform three key functions: * * * Choosing a Main Administrator The Main Administrator receives notification emails, such as daily reports and errors/problems which may require manual intervention. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_search_results?rev=1542192349&do=diff Message Archive -> Results Tab Settings -> Message Archive -> Results tab The Results tab only exists if you have previously done a search operation and are viewing the results of that search. The Results page shows you a list of the messages (up to 1000 entries are available) returned by the search. You can select multiple entries by using shift+click or ctrl+click 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:calendar_events?rev=1542192349&do=diff Calendar.Events table The Calendar.Events table contains a record of all the events in calendars managed by VPOP3. An 'event' is an iCalendar event. Note that if an event is a recurring series, there will only be one 'event' in the database, not one event per instance of the recurrence. 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:database_schema_used_in_vpop3_5.x?rev=1542192349&do=diff Database schema used in VPOP3 5.x Note that all information in this section is subject to change. We do not guarantee that the database schema will remain constant, even between minor upgrade versions, so use this information at your own risk. Do not alter the database schema used by VPOP3 (including indexes, triggers & functions) or your whole VPOP3 data store may collapse. 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 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:ldap_schema_in_vpop3_4.x?rev=1542192349&do=diff LDAP Schema in VPOP3 4.x Hierarchical Structure LDAP data is stored as a hierarchical database with the 'DN' (Distinguished Name) of the object as the key. The DN is made up of the various 'Relative DNs' used to navigate to the desired object, placed in reverse order, separated by commas. text/html 2026-03-26T23:49:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_scripting?rev=1774568941&do=diff Lua Scripting Lua is a simple scripting programming language often used for embedding in other applications. VPOP3 uses it to customise behaviour in places where most people will be happy with the default behaviour, but occasionally people will want to do something more complicated. Rather than having lots of extra options to complicate things for most users, we have opted to go for a more flexible scripting facility. 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: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: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: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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) 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 mail 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 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 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:sent_message_summary?rev=1542192349&do=diff Sent message summary This will display the number of messages sent and total size over the past month. (It counts each recipient as its own message). You must have Historical Logging enabled in VPOP3 (Settings -> Logging) At a command prompt in the VPOP3 directory run text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_advanced?rev=1542192349&do=diff SMTP Service -> Advanced Tab Services -> SMTP Server -> Advanced Tab Refuse SMTP Connections from This setting should be rarely needed, and should be normally left blank. It is here for historic purposes. If you put some text in this box, then VPOP3 will refuse any SMTP connections from clients whose 'HELO'/'EHLO' command data contains the text specified here as a substring. Eg, if this setting is set to '.myisp.com', then VPOP3 would refuse SMTP connections from any client which sends the c… 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_relay?rev=1542192349&do=diff Mail Connectors -> Mail Senders -> SMTP Relay VPOP3 can be configured to send through an SMTP Relay server (sometimes known as a smarthost). This is the usual configuration for small/medium sized businesses and home users. If you have a dial-up, ADSL, Cable, FTTC etc connection, then your Internet Provider will normally give you access to their SMTP relay service. 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 2023-01-18T15:57:13+00:00 Anonymous (anonymous@undisclosed.example.com) 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/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_comments?rev=1542192349&do=diff Spam Filter Rules: Comments In the spam filter scripts, blank lines are ignored. Any line beginning with a # character is treated as a comment. Comments must be on a line of their own; there is no way to add a comment to the end of a line. Examples text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_goto?rev=1542192349&do=diff Spam Filter Rules: Goto Statement Goto Version 2.1.7+ Purpose A mechanism for directing the script towards a specified label The Goto statement requires a label name, in the format Goto <label name> Labels are single word entries that appear on a line of their own, immediately preceded by the colon (:) character. The colon character is not part of the label name. 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 2019-08-19T08:58:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:status_monitor_protocol?rev=1566205125&do=diff Status Monitor (port 5109) protocol This page documents the protocol used between VPOP3 and the Status Monitor. It's not intended for any other purpose, so it's a bit limited, but in certain cases you may find this useful Login Before the Status Monitor receives any updates or can issue commands it must log in using a user's credentials. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_advanced?rev=1542192349&do=diff User Advanced settings The Edit User → Advanced tab contains some 'advanced' settings for a VPOP3 user. Message Recycle Bin In VPOP3 Enterprise (v5 and later) the Message Recycle Bin will keep messages in the message store for a short time after the user has deleted the messages. This is to allow easier recovery from the inevitable case where a user has deleted messages by mistake, and wants them back. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_message_rules?rev=1542192349&do=diff Message Rules The Edit User -> Message Rules tab can be used to create/edit rules which are processed when messages arrive in a User's mailbox. They can be used to copy messages, mark them as read, delete them, etc VPOP3 will process Message Rules in the order they appear in the list. If you want to change the order of the rules, you can drag & drop them into the correct order. Usually when VPOP3 has processed a rule, it will go on to check further rules, but you can use the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:using_tables?rev=1542192349&do=diff Using tables/grids Many VPOP3 settings pages use grids to show you a set of data, for instance on the Users, Mappings and Lists pages. These have several standard features which are described below. * Most of the grids are 'delayed-fill'. This means that they don't fill up with data immediately when the page is loaded, this is to speed up the page load times. Only the first (visible) section of the grid is filled at first (sometimes there may be a short delay before this is filled, if the da… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) 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…