PSCS Wiki

Temporary Files

Anonymous (anonymous@undisclosed.example.com) — 2026-02-19T17:56:27+00:00

Temporary Files This is for files in the VPOP3\_temp folder Most of the filename is the hexadecimal timestamp (in Windows 'FILETIME'/65536 form) with a 4 digit hex sequential number afterwards. The first letter or two (usually G-Z) can tell something about what caused the file.

Message Archive

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Message Archive The Message Archive facility is for VPOP3 to store copies of all messages sent or received. It stores the messages in a central archive store which can be searched by an administrator. The prime purpose of the archive facility is for recording messages in case of possible disputes, as you can see what was sent/received by email. It can also be used as a backup/restore facility in an emergency, but that is not its prime purpose, so it is better to have a proper

Autoresponder Commands

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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' *

SMTP Server Lua Scripting

Anonymous (anonymous@undisclosed.example.com) — 2025-05-08T08:23:35+00:00

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.

Mail Connectors -> Connector Schedule

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

SMTP Server -> IDS/IPS

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…

Mail Collectors

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Mail Collectors A Mail Collector is how you tell VPOP3 to collect incoming mail. Each Mail Collector is associated with one or more Connections. The VPOP3 Connector Schedule determines when each Connection is run. Mail Collector General Tab Each Mail Collector has a General

POP3 Mail Collection

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

What's new in version 5 webmail?

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…

Settings -> Attachment Processing

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Import Users From File

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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:

Lists

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Mappings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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'

Misc -> Advanced Tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Outgoing Message Scripting

Anonymous (anonymous@undisclosed.example.com) — 2024-03-21T10:49:54+00:00

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.

Signature Script

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: AddHeader

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 format

Spam Filter Rules: IfMatch

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: IfMatch Statement IfMatch Version 2.1.7+ Purpose Allows you to perform a regular or substring match on a variable or part of the message being processed IfMatch statements require a data parameter and a search value, in the format

Access Restrictions Internal Format

Anonymous (anonymous@undisclosed.example.com) — 2023-08-02T08:22:37+00:00

Access Restrictions Internal Format VPOP3 internally stores service IP Access Restrictions in its settings database using the following format to encode the multiple entries These are stored in the settings database as *ALLOWED*.DAT (using VPOP3SETTINGS GET *ALLOWED*.DAT will list them)

Address Book tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Autoresponder Global Scripting

Anonymous (anonymous@undisclosed.example.com) — 2026-03-23T15:29:29+00:00

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

Lua SMTP Relay Control

Anonymous (anonymous@undisclosed.example.com) — 2025-08-14T09:24:55+00:00

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:

Route incoming POP3 mail by parsing message headers

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Route incoming POP3 mail by parsing message headers This routing method is generally used if you have a catch-all or 'multi-catch' mailbox with your Internet provider. With this method, VPOP3 will look at the To/Cc and other fields in the message headers to try to work out who the message is for. If the recipient is not listed in the headers (eg for BCCd mail) it may not be able to automatically detect who the message is for.

Security Settings -> Intrusion Protection Tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

SMTP Direct Sender Settings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Spamfilter Script Configuration tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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:

LAN Forwarding Queue Status

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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:

Logging

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Message Monitoring

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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)

Quarantine tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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:

Scheduled Task Script

Anonymous (anonymous@undisclosed.example.com) — 2021-08-09T10:55:07+00:00

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

Mail Sender Advanced Settings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

SMTP Service - Filtering

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Spam Filter Rules: GetRFC822Date

Anonymous (anonymous@undisclosed.example.com) — 2023-08-14T15:53:15+00:00

Spam Filter Rules: GetRFC822Date Statement GetRFC822Date Version 2.2.1+ Purpose Converts an RFC 822 format date field into the number of days elapsed since 1st January 1601 The GetRFC822Date statement requires a date in RFC 822 format and a variable name, in the format

Autoresponder

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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'…

Webmail Status bar

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Spamfilter White/Blacklists

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…

Autoresponder scripting

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T09:24:38+00:00

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 & tags, eg

Calendar.Events table

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Connections

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Connections In VPOP3 a Connection tells VPOP3 how to 'connect' to the Internet. VPOP3 supports up to 10 Connections, which can be either network connections or Dial-Up connections (using a modem) A Connection is linked to one Mail Sender and zero or more Mail Collectors.

DMARC Reporter Script

Anonymous (anonymous@undisclosed.example.com) — 2023-11-12T09:51:40+00:00

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

Global Signature

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Groups

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

POP3 Client Lua Scripting

Anonymous (anonymous@undisclosed.example.com) — 2023-08-16T07:48:01+00:00

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:

Lua SMTP MX Control

Anonymous (anonymous@undisclosed.example.com) — 2026-02-24T15:49:48+00:00

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:

Mail Connectors -> Mail Senders

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Mail Connectors -> Mail Senders The Mail Sender tells VPOP3 how to send mail out to the Internet. If you want to send mail for specific users to another specific mail server (e.g. a local Microsoft Exchange Server or another VPOP3 server) then use the

Mail tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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:

Management Scripting

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

msgaudit Database table

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

msgaudit Database table This can (optionally) contain data showing how messages have been handled (eg deleted, moved, etc) * id - incrementing ID of msgaudit entry * datetime - the date & time the event occurred * component - which VPOP3 component performed the event

Mail Connectors -> Mail Senders -> SMTP Direct

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 …

Spam Filter Rules: BulkScan

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: BulkScan Statement BulkScan Version 2.1.7+ Purpose Allows you to specify lots of search strings in one section without needing the verbose If statement The BulkScan statement requires a variable name and a limitless number of search specifiers, in the format

Spam Filter Rules: CountMatches

Anonymous (anonymous@undisclosed.example.com) — 2025-06-06T08:12:37+00:00

Spam Filter Rules: CountMatches Statement CountMatches Version 2.3.13+ Purpose Counts the number of times a specific regular expression matches in a string CountMatches statements require a data parameter, a search value, and the name of the variable to place the count into, in the format

Spam Filter Rules: GetDecodedSection

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: ZipContents

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: ZipContents Statement ZipContents Version 6.7+ Purpose Enables the script to obtain the list of files contained in a ZIP attachment The ZipContents statement requires a message section number and bag name, in the format ZipContent

Spam Filter Rules: ZipContentsFull

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 format

Spam Filter Rules: Variables

Anonymous (anonymous@undisclosed.example.com) — 2023-08-14T16:01:01+00:00

Spam Filter Rules: Variables The VPOP3 spam filter script language supports simple variables. In most places these are specified as ${}, but in some places they are just specified as - for instance where a statement always puts its result into a variable.

Summary Log File Format

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

User Delivery Script

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

User Delivery Script (VPOP3 v6.5 or later) If there is a /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.

User Routing Script

Anonymous (anonymous@undisclosed.example.com) — 2023-03-27T10:32:18+00:00

User Routing Script If there is a /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

VPOP3.GetMessages Lua function

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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:

Database query to alter LAN Forwarding rules for one server to go to another

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to alter LAN Forwarding rules for one server to go to another If a LAN forwarding destination server fails, you may wish to change the queued messages to go to the new server. (Note that, if planning ahead, it may be easier to use DNS

Database query to alter LAN Forwarding rules for one server to go to another

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to alter LAN Forwarding rules for one server to go to another If a LAN forwarding destination server fails, you may wish to change the LAN forwarding rules to point to the new server. (Note that, if planning ahead, it may be easier to use

Message Archive -> Offline Tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Autoresponders - v3 and v4

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Autoresponders - v3 and v4 This section lets you define an autoresponder for a user. An autoresponder is a message which is sent back in response to a message which arrives in this user's mailbox. The Autoresponder Type can be set to None, Simple Autoresponder

Batch file to end a database backup

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Batch file to end a database backup VPOP3 runs pg_dump.exe to perform the regular database backups. Ending this process through Task Manager will not end the back-end database processes creating the backup data. This batch file will do it for you.

Bulk Add Users

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Bulk Add Users VPOP3 contains a feature to quickly create several users, with default settings. From the Administration Settings -> Users page, you can click Bulk Add Users to launch a new window. You can then enter up to 10 users at a time, by specifying their usernames and passwords.

Calendar database schema

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Calendar database schema The Calendar database schema contains the data for the Calendar/CalDAV component of VPOP3. Note that the actual calendar data is stored in iCalendar/.ics file format. The database just stores information for helping with selective retrieval.

Calendar.Calendars table

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Calendar.Calendars table The Calendar.Calendars table contains a list of all 'calendars' created in VPOP3. Each user account has at least one calendar Columns * calid - this is a integer sequential value which identifies the calendar uniquely in the database *

Copy SMTP Rules - Database Query

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Database -> Backups Tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database -> Backups Tab The Backups tab lets you specify how VPOP3 will make its daily backup of its database. We strongly recommend that you backup the database regularly in case of disk problems or file corruption. You can use the VPOP3 backup feature, or manually backup the PostgreSQL database using the pg_dump command, or use another program to backup the PostgreSQL database if you wish. Note that a simple disk copy will

Database schema used in VPOP3 5.x

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Delete list member from all lists

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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')

Settings -> Diagnostics

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Download Rules

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Database query to export LAN Forwarding rules

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to export LAN Forwarding rules At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type \copy (select conditions, address, server, username, password, outaddress as rewriteaddress, matchcount as matches from rules.lanforwarding order by ruleorder) to 'c:/temp/x.csv' csv header;

Find biggest messages

Anonymous (anonymous@undisclosed.example.com) — 2019-07-08T08:19:02+00:00

Find biggest messages To find the 10 biggest messages in your VPOP3 message store: Go to Settings → Database → Query Alternatively, at a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type SELECT username, folder, subject, fromaddr, PG_SIZE_PRETTY(size) FROM messages.messages INNER JOIN messages.folders f USING(folderid) INNER JOIN users.users u ON u.usernumber=f.userid ORDER BY size DESC LIMIT 10;

Database query to find forwards/assistants etc in user settings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to find forwards/assistants etc in user settings Go to Settings -> Database -> Query Alternatively, at a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type select username,dataname,datavalue from users.usersettings inner join users.users using(usernumber) where datavalue ilike '%searchname%';

Find a message

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Find a message If you know the subject of a message, you can search the entire message store for messages with this subject. Go to Settings → Database → Query Alternatively, at a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass')

Database query to get all lists and members

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to get all lists and members At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type \copy (select l.name, address from users.listmembers m inner join users.lists l on m.list=l.id) to 'c:/temp/x.csv' csv header;

Group a user's folders into letter groups

Anonymous (anonymous@undisclosed.example.com) — 2026-03-16T11:12:42+00:00

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

IMAP4 -> Advanced tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

IMAP4 Server Scripting

Anonymous (anonymous@undisclosed.example.com) — 2025-06-23T10:51:46+00:00

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

Incoming SMTP Mail

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Incoming SMTP Mail If you have an incoming SMTP mail feed, then the mail server sending mail to you will connect to your VPOP3 computer to send the mail. The mail connection is controlled by the sending computer. IMPORTANT If you have a permanent Internet connection with a static IP address, the usual way of having incoming SMTP is to configure your

Internal Data Formats

Anonymous (anonymous@undisclosed.example.com) — 2023-08-02T08:10:50+00:00

Internal Data Formats VPOP3 stores some data in specific formats internally, eg to encode some settings in the settings database. This page describes some of those. * Access Restrictions Internal Format

VPOP3 Internals

Anonymous (anonymous@undisclosed.example.com) — 2026-02-19T17:17:26+00:00

VPOP3 Internals This section describes some of the internal workings/files of VPOP3. This is not, nor is it intended to be, a complete description, but merely contains information that may be useful to the average, interested (and moderately technical), user. The information here is not guaranteed not to change between versions of VPOP3.

LAN Forwarding Scripting

Anonymous (anonymous@undisclosed.example.com) — 2025-08-20T16:08:40+00:00

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: *

LDAP Schema in VPOP3 4.x

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Database query to list ALL messages in the LAN forwarding queue

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to list ALL messages in the LAN forwarding queue The VPOP3 settings show the first 100 messages in the LAN forwarding queue. Usually this is sufficient as the LAN forwarding queue is usually nearly empty, but in case of a problem it may be much bigger. The database queries below may help in that situation.

Database query to list failed message sends

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to list failed message sends This will list failed outgoing messages from the last 3 days (with the default VPOP3 settings) At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type select created,returnpath,subject,username || '@' || domain as recipient, latesterror from outqueue.outrecipients inner join outqueue.outmessages using(msgid) where failedtime is not null order by created desc;

Database query to list messages in the LAN forwarding queue waiting to go to a specific server

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to list messages in the LAN forwarding queue waiting to go to a specific server The VPOP3 settings show the first 100 messages in the LAN forwarding queue. Usually this is sufficient as the LAN forwarding queue is usually nearly empty, but in case of a problem it may be much bigger. The database queries below let you list just messages going to a specific server.

Settings -> Local Mail -> General

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Settings -> Local Mail -> General The Local Mail -> General page allows you to configure a few simple, but fundamentally important settings. Default Domain In the majority† of cases, this is the domain name that VPOP3 will use when sending automated messages; for instance, users may receive a message from

Database query to make LAN Forwarding immediately attempt to dequeue all pending messages

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to make LAN Forwarding immediately attempt to dequeue all pending messages If VPOP3 cannot send messages using LAN Forwarding it will queue the message and retry periodically. Usually there is no need to do anything special if there was a problem with the onward mail server which has now been fixed, VPOP3 should soon retry the messages automatically (based on the value of the

Message Headers

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Message Headers This article describes some of the headers which VPOP3 can add to messages. Note that some of these may be added by customisable scripts used by VPOP3, so may not match exactly, but the descriptions below are for the defaults distributed with VPOP3.

New message tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Password Strength Checking Script

Anonymous (anonymous@undisclosed.example.com) — 2026-01-05T09:25:39+00:00

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

POP3 Server -> General Tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

POP3 Server -> General Tab Services -> POP3 Server -> General tab This page sets the general settings for the POP3 service component in VPOP3. The POP3 service is how users collect their email from VPOP3 using a POP3 email client Service Name The Service Name is a name you give the service for your reference. It is only used in administrative displays and logging, so the name doesn't matter. Most people leave it at the default.

Spamfilter Quarantine Viewer

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spamfilter Quarantine Viewer Settings -> Spamfilter -> Quarantine Viewer The Quarantine Viewer lets you see messages which have been quarantined by the VPOP3 Spam Filter. As an administrator you can see quarantined messages for any user, and release them if appropriate. If you release a message, it will be sent into the original recipient's Inbox, not into your Inbox.

Reports

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Reset Message Folder Counts

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Reset Message Folder Counts In extremely rare cases, the mail folder message counts in the database may get out of step with the actual stored messages. There are database triggers which will keep the counts in sync during normal operation, but if you have to manipulate the database directly (eg to recover from a corrupted database) it is possible that they will get out of step.

Scheduling Management Scripts

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Send Admin Message

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Mail Sender Advanced Relay Settings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Mail Sender Advanced Relay Settings SMTP Return Address The SMTP Return Address (or Return Path) is a hidden part of a message which says where bounce messages (and other automated responses) should be sent. (It is not the same as the Reply address

Sent message summary

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

SMTP -> General tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

SMTP -> Load Limiting tab

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

SMTP -> Load Limiting tab This page is reached from Services -> SMTP Server, then the Load Limiting tab. Here you can set limits on how many active SMTP sessions there are, and other related settings. This lets you limit the load on the VPOP3 server. This is especially important if VPOP3 is performing spam filtering on incoming SMTP messages, because the spam filter can add considerable load. You can reduce the spamfilter load by using the

Lua SMTP Rules Scripts

Anonymous (anonymous@undisclosed.example.com) — 2026-03-26T11:41:59+00:00

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.

SMTP Server -> Spam Reduction

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…

Increase the spam score for certain recipients

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Increase the spam score for certain recipients This script is for the case where you want certain recipients to have a weighted score. For instance if you have users who have left and who mostly receive spam, but you don't want to reject their mail totally.

Increase the spam score for header marker

Anonymous (anonymous@undisclosed.example.com) — 2020-10-05T16:14:12+00:00

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)

Allow messages through from a specific IP address

Anonymous (anonymous@undisclosed.example.com) — 2022-01-25T11:59:27+00:00

Allow messages through from a specific IP address This script allows messages through the spam filter if they arrive at VPOP3 from a specific SMTP sender (only when the message is sent directly to VPOP3 using SMTP, not via another server). Add the following to the spamrules_userlocal.txt file. This script file gets processed on all messages.

Spamrules example - increase spam score for long sender domain

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spamrules example - increase spam score for long sender domain This script is for the case where you to increase the spamminess of emails where the sender's email address contains a long domain. In this case we'll say if the sender's domain has 20 or more characters in the first section (between the @ and first .). Note that we do not necessarily recommend that you do this as it is not a very good indicator of spam, but it is something we've been asked for, so here it is.

Spam Filter Rules: AddBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: AddBag Statement AddBag Version 2.2.1+ Purpose Adds a value into a 'bag' containing a collection of values, creating the bag if necessary The AddBag statement requires a type, bag name and value, in the format AddBag

Spam Filter Rules: AddNullAddress

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: AddNullAddress Statement AddNullAddress Version 2.2.1+ Purpose Temporarily adds an email address to VPOP3's configuration where the mail will be discarded AddNullAddress is intended for use to make 'pseudo' addresses, such as 'spam@' and 'notspam@' for the spam filter to process.

Spam Filter Rules: ClearBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: ClearBag Statement ClearBag Version 2.2.1+ Purpose Clears all items from a 'bag' The ClearBag requires a bag name, in the format ClearBag Example The following example removes all values from the 'recipient' bag ClearBag recipient

Spam Filter Rules: Convert

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: Convert Statement Convert Version 2.4.9+ Purpose Allows you to convert data from one form to another The Convert statement requires a data parameter, conversion method and variable name, in the format Convert

Spam Filter Rules: CopyBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: CopyBag Statement CopyBag Version 6.17+ Purpose Copies the contents of one bag into another bag The CopyBag statement requires an operator, “from bag” name and “to bag” name, in the format AddBag

Spam Filter Rules: DBDeleteTime

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DBDeleteTime Statement DBDeleteTime Version 6.16+ Purpose Deletes records from the spam filter database based on their last update time The DBDeleteTime statement requires a component name, comparator and time value, in the format

Spam Filter Rules: DBInsert

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DBInsert Statement DBInsert Version 6.16+ Purpose Inserts a record into the spam filter database The DBInsert statement requires a type, component name, key and value, in the format DBInsert

Spam Filter Rules: DBQueryOne

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Spam Filter Rules: DBUpdate

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DBUpdate Statement DBUpdate Version 6.16+ Purpose Updates a record in the spam filter database The DBUpdate statement requires a component name, key, operator and value, in the format DBUpdate

Spam Filter Rules: DefineRule

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 "" ""

Spam Filter Rules: DefineSetting

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DefineSetting Statement DefineSetting Version 2.1.9+ Purpose Defines a generic setting, the default value and description The DefineSetting statement requires a name, default value and description, in the format DefineSetting "" ""

Spam Filter Rules: DNS

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: DNSBL

Anonymous (anonymous@undisclosed.example.com) — 2020-10-23T16:07:49+00:00

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

Spam Filter Rules: Escape

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 Example ${myvar} = "This costs $10.00" Escape myvar # ${myvar} is now "This costs \$10\.00"

Spam Filter Rules: ForEach

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: GetAddressType

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 format

Spam Filter Rules: GetMD5

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: GetSectionEncoding

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: GetSectionMD5

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: GetUserGroup

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: GlobalMatch

Anonymous (anonymous@undisclosed.example.com) — 2025-06-06T08:15:50+00:00

Spam Filter Rules: GlobalMatch Statement GlobalMatch Version 2.3.13+ Purpose Does a RegExp match on the supplied data and puts the results in a bag The GlobalMatch statement requires a data parameter, a search value, and the name of a bag to place the matches into, in the format

Spam Filter Rules: Goto

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 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.

Spam Filter Rules: HTTPGet

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: HTTPGet Statement HTTPGet Version 2.3.7+ Purpose Enables the script to retrieve a web page The HTTPGet statement requires a url, headers variable name and content variable name, in the format HTTPGet

Spam Filter Rules: HTTPGetMD5

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: HTTPGetMD5 Statement HTTPGetMD5 Version 2.3.7+ Purpose Enables the script to retrieve a web page, returning an MD5 hash of its contents in hex encoded form The HTTPGetMD5 statement requires a url, headers variable name and MD5 hash variable name, in the format

Spam Filter Rules: HTTPPost

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: HTTPPost Statement HTTPPost Version 2.4.9+ Purpose Enables the script to post data to a web server The HTTPPost statement requires a url, data string, headers variable name and content variable name, in the format HTTPPost

Spam Filter Rules: IfInBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: IfInBag Statement IfInBag Version 2.3.7+ Purpose Checks if a specified value is in a particular bag The IfInBag statement requires a bag name and value, in the format IfInBag * All IfInBag statements must be followed by an

Spam Filter Rules: IfLocalAddress

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: IfLocalAddress Statement IfLocalAddress Version 2.2.1+ Purpose Allows you to check if a specified email address is local to your VPOP3 installation IfLocalAddress requires just one paramater; the address, in the format IfLocalAddress

Spam Filter Rules: Random

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: Random Statement Random Version 2.5.2+ Purpose Generates a random number The Random statement requires a lower and higher numeric bound, and a variable to assign the result to, in the format Random *

Spam Filter Rules: Reject

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 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.

Spam Filter Rules: RemoveBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: RemoveBag Statement RemoveBag Version 2.2.1+ Purpose Removes a specified value from a bag The RemoveBag statement requires a bag name and a value, in the format RemoveBag * If the value is found in the bag, it is removed

Spam Filter Rules: RemoveTags

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: RemoveTags Statement RemoveTags Version 2.2.1+ Purpose Converts an HTML string to its plain text equivalent The RemoveTags statement requires a variable name, in the format RemoveTags * HTML tags are removed *

Spam Filter Rules: Replace

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: Replace Statement Replace Version 2.3.5+ Purpose Replaces specified text in the specified variable with new text Replace statements require a variable name, a search value and a replacement string, in the format Replace

Spam Filter Rules: SendMessage

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: *IFSUPPORT

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: *IFSUPPORT Statement *IFSUPPORT Version 2.2.5+ Purpose Allows the script to determine whether a particular command or function is supported by the installed version of VPOP3 The *IFSUPPORT statement requires a command or a function, in the format

Spam Filter Rules: StartDNS

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: StartDNSBL

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 format

Spam Filter Rules: StartSURBL

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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 format

Spam Filter Rules: SURBL

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: WinHTTPGet

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: WinHTTPGet Statement WinHTTPGet Version 2.4.9+ Purpose Enables the script to retrieve a web page using the WinINET functionality The WinHTTPGet statement requires a url, headers variable name and content variable name, in the format

Spam Filter Rules: ZipCount

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: ZipCount Statement ZipCount Version 6.7+ Purpose Enables the script to obtain the number of files contained in a ZIP attachment The ZipCount statement requires a message section number and variable name, in the format ZipCount

Increase the spam score for subject marker

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Increase the spam score for subject marker This script is for the case where your ISP adds a marker eg '[spam]' to the message subject, 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)

Status Monitor (port 5109) protocol

Anonymous (anonymous@undisclosed.example.com) — 2019-08-19T08:58:45+00:00

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.

Useful Database Queries

Anonymous (anonymous@undisclosed.example.com) — 2026-03-16T11:02:32+00:00

Useful Database Queries Below are some database (SQL) queries which may be useful in some situations. You can run these from the 'psql' program at the command prompt. Some can also be run from the Settings -> Database -> Query page in the VPOP3 settings.

Message Rules

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Permissions

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Prune Rules

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Prune Rules The Edit User -> Prune Rules tab can be used to create/edit rules which cause messages to be automatically deleted according to specified criteria. To add or edit a “prune rule”, press the Add Rule button. This will add a new rule to the table, with a set of default settings. Don't worry, this rule doesn't take effect until you press the Submit button.

Using tables/grids

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…

Database query to view password change history

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Database query to view password change history At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type select username,updateuser,updatetime from settingaudit inner join users.users on keyfield=usernumber::varchar where tablename='users.usersettings' and keyfield2='mainpassword' order by updatetime desc;

Virus Scan Filter Scripting

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

VPOP3.GetFolders Lua function

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Webmail Menu bar

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Webmail Tabs

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.