PSCS Wiki

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

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.

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

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

ListServer Settings

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

ListServer Settings Settings -> ListServer Settings In VPOP3, the ListServer is an automated 'user' which handles mailing list requests, such as subscribe & unsubscribe commands. Anyone can send an email to the ListServer to subscribe to (public) mailing lists, or unsubscribe from mailing lists they are on, or see a list of public mailing lists etc.

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)

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 …

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

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.

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

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.

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.

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.

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.

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.

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

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.

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.

SMTP Service -> Advanced Tab

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

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…

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

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…

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…

Settings -> Admin Settings

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

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.

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.

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.

Database -> Restore Tab

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

Database -> Restore Tab This tab is only in VPOP3 Enterprise (v5 and later), and is for performing a partial (mailbox/mail folder) restore of the database. To do a full restore of the database, or for VPOP3 Basic/Standard, see the “Restore a Backup of VPOP3” topic Using the

Error Handling Scripting

Anonymous (anonymous@undisclosed.example.com) — 2023-11-20T10:18:01+00:00

Error Handling Scripting For most error messages that VPOP3 generates, it allows control of error messages, eg to limit the frequency of error messages if they would be generated repeatedly. These limits are set in Settings -> Admin Settings -> Message Control. However, if you want more granular control, you can use Lua scripting for more fine-grained control

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

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:

ListServer Commands

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

ListServer Commands The ListServer is an automated process in VPOP3 which manages mailing lists. People can send commands to the ListServer to perform various functions remotely. Whether these commands are allowed, and exactly how they work depends on the particular mailing list's settings.

LogDB.Recipients table

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

LogDB.Recipients table The LogDB.Recipients table contains a record of the recipients for messages logged by VPOP3. A message may have one or more recipients Columns * rcptid - this is a bigint sequential value which identifies the recipient uniquely in the database

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

Running database updates within a transaction

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

Running database updates within a transaction This is a trick which database experts use, because they have learned (often the hard way) that a simple mistype can trash a database... Before running any database query which can alter the database (UPDATE, DELETE, INSERT, DROP, CREATE, ALTER) begin a database transaction using the

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

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

Spam Filter Rules

Anonymous (anonymous@undisclosed.example.com) — 2023-01-18T15:57:13+00:00

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.

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

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.

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.

VPOP3.MessageSeek

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

VPOP3.MessageSeek The Lua function 'VPOP3.MessageSeek' sets an internal read pointer to the specified location of the message being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter:

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 -> Results Tab

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

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

Attachment Extraction Scripting

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

Attachment Extraction Scripting This is the 'extraction.lua' script. (Added in V6.17) This script has one functions: * Extract This functions is called if the attachment extraction is enabled in Settings -> Attachment Processing -> Extraction.

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

Attachment Processing Script

Anonymous (anonymous@undisclosed.example.com) — 2022-11-24T09:29:03+00:00

Attachment Processing Script (Added in v7.6) This script has functions to allow message attachments to be altered: * NeedsRecode * NeedsRewrite * GetRename * GetContentDispositionLine (added in v7.8) * IsLockNeeded * RewriteAttachment

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

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

Database files used in VPOP3 2.x

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

Database files used in VPOP3 2.x VPOP3 2.x usually uses SQLite 2.8.3 as its database engine. This stores databases in discrete *.db files in the VPOP3\_database directory on the server PC. We do not recommend that you access these databases directly unless you know what you are doing, and we strongly discourage the alteration of data in the databases directly unless technical support request you to.

Database -> Message Store Tab

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

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.

Settings -> Global Address Book

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

Settings -> Global Address Book The VPOP3 global address book allows users to access a shared address book from any email client which supports the 'LDAP' protocol (most modern email clients do, but they may call it 'directory service' Importing Entries

IDS Log Event Numbers

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

IDS Log Event Numbers The VPOP3 SMTP IDS logging facility logs SMTP events in a form which may be useful to Intrusion Protection Systems, or security monitoring software. One of the fields in the log file is the Log Event Number These are: * 0 = SMTP authentication failure

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

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

Lua Hashing Functions

Anonymous (anonymous@undisclosed.example.com) — 2024-10-29T15:59:51+00:00

Lua Hashing Functions Added in VPOP3 8.7 Four functions have been added to perform hash algorithms on a text string * VPOP3.SHA1(string) * VPOP3.SHA256(string) * VPOP3.SHA512(string) * VPOP3.MD5(string) All functions take a string parameter, and return a table of numbers containing the hash value (one byte per table entry). The length of the returned table are:

Monitor Scripting

Anonymous (anonymous@undisclosed.example.com) — 2019-08-27T16:13:40+00:00

Monitor Scripting (Added in V6.15) This script has three functions: * MonitorIncoming * MonitorInternal * MonitorOut The functions are similar, except they are called when different messages are to be monitored (incoming, internal and outgoing messages respectively).

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:

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:

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

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

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

Misc -> External Fax Tab

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

Misc -> External Fax Tab Settings -> Misc Settings -> External Fax The External Fax tab is for use with some external fax server applications which work by collecting mail from a POP3 mailbox. If a Fax Server Mailbox is selected, then VPOP3 will automatically send any locally sent mail to that mailbox if the recipient is local, but doesn't match another local address (a user, list, mapping etc),

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

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.

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.

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

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

SMTP Reputation Stats

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

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.

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…

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:

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

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

Spam Filter Rules: If Statement If Version 2.1.7+ Purpose Enables you to perform a simple relational test on a variable You can specify a variable or a constant on either or both sides of the relational operator. The relational operator can be one of:

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

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

Spam Filter Rules: Include Statement Include Version 2.1.7+ Purpose Including other files within the spam rules To include another file within the spam rules, insert a line saying ''Include '' There should not be any quotes around the filename to include, even if it contains spaces. Note that all files are within the same 'scope', so variables defined in one file will be visible within all subsequent included files.

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

Status

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

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.

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 Manager Script

Anonymous (anonymous@undisclosed.example.com) — 2024-04-22T08:37:38+00:00

User Manager Script If you want people to be able to log in using a different username than their VPOP3 username (eg if you want them to be able to log in using an email address), then you can use the UserManager Lua script The Lua script is managed through the Settings → Scripts page in VPOP3 v8.0 and later and is called 'UserManager.LUA.

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

User Routing Options

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

User Routing Options Assistant The assistant for a user is an email address (or set of email addresses, separated by semicolons) where incoming messages to this user will be copied or redirected. Normally messages will be copied to the assistant, but if the

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

Anonymous (anonymous@undisclosed.example.com) — 2024-10-29T16:06:11+00:00

VPOP3.Base64 Added in VPOP3 8.7 This function returns a Base64 string encoding of the supplied parameter VPOP3.Base64(text) or VPOP3.Base64(byte-array) It can be passed either a text string or a table containing one byte per table-entry (eg as returned from the

VPOP3.GetMessageLines

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

VPOP3.GetMessageLines The Lua function 'VPOP3.GetMessageLines' retrieves content lines from the message currently being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: * number - number of lines to retrieve

VPOP3.GetMessagePart

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

VPOP3.GetMessagePart The Lua function 'VPOP3.GetMessagePart' retrieves a MIME part of the message currently being processed. This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: * The MIME part 'Path' from the MimeStructure parameter to the ProcessMessage function

VPOP3.GetMessagePartBody

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

VPOP3.GetMessagePartBody The Lua function 'VPOP3.GetMessagePartBody' retrieves the content of a MIME part of the message currently being processed. This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter:

VPOP3.GetMessagePartHeader

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

VPOP3.GetMessagePartHeader The Lua function 'VPOP3.GetMessagePartHeader' retrieves a MIME section header of the message currently being processed. This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter:

VPOP3.GetSetting

Anonymous (anonymous@undisclosed.example.com) — 2018-12-11T17:06:01+00:00

VPOP3.GetSetting The Lua function 'VPOP3.GetSetting' retrieves a general setting from VPOP3 It takes one parameter: * The name of the setting. This can either by the 'Name' field of the 'Settings.Settings' database table or the internal setting name

VPOP3.HexString

Anonymous (anonymous@undisclosed.example.com) — 2024-10-29T16:08:01+00:00

VPOP3.HexString Added in VPOP3 8.7 This function returns a Hex string encoding of the supplied parameter VPOP3.HexString(text) or VPOP3.HexString(byte-array) It can be passed either a text string or a table containing one byte per table-entry (eg as returned from the

VPOP3.HMAC

Anonymous (anonymous@undisclosed.example.com) — 2024-10-29T16:03:19+00:00

VPOP3.HMAC Added in VPOP3 8.7 This function performs a HMAC (Hash-based Message Authentication Code) algorithm on supplied text using the supplied key VPOP3.HMAC(hash algorithm, string, key) The function takes three parameters: * Hash algorithm -

VPOP3.SaveAttachment

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

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 save

VPOP3.SendMessage

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

VPOP3.SendMessage The Lua function 'VPOP3.SendMessage' sends a text email message It takes four parameters: * The email address of the sender * The email address of the recipient * The subject line * The message body The function returns one value:

VPOP3.SetSetting

Anonymous (anonymous@undisclosed.example.com) — 2021-03-09T16:37:10+00:00

VPOP3.SetSetting The Lua function 'VPOP3.SetSetting' sets a general setting forVPOP3 It takes two parameters: * The name of the setting. This can either by the 'Name' field of the 'Settings.Settings' database table or the internal setting name * The data to set (must be a string)

VPOP3.UnBase64

Anonymous (anonymous@undisclosed.example.com) — 2024-10-29T16:07:15+00:00

VPOP3.UnBase64 Added in VPOP3 8.7 This function Decodes a Base64 string into the original data VPOP3.UnBase64(base64-text) It returns a table containing the decoded data bytes - one byte per table entry. If there was an error, it returns a Nil value

VPOP3.UnHexString

Anonymous (anonymous@undisclosed.example.com) — 2024-10-29T16:09:37+00:00

VPOP3.UnHexString Added in VPOP3 8.7 This function Decodes a Hex string into the original data VPOP3.UnHexString(hex-text) The input hex-text should have no extra spaces or punctuation, and be two hex digits per result byte. Any pairs of characters which are not valid hex will be processed as a 'zero' byte.

VPOP3Net.GetHTTP

Anonymous (anonymous@undisclosed.example.com) — 2021-03-09T16:42:44+00:00

VPOP3Net.GetHTTP This function takes a single parameter * the URL to retrieve. This can be http:// or https:// The function returns two values * a table containing the result of the GET * Host - the hostname * File - the filename * Headers - a table containing the response headers

Webmail -> Advanced tab

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

Webmail -> Advanced tab This page is reached from Services -> Webmail Server, then the Advanced tab. Here you can set various options for the VPOP3 Webmail/settings service. Allow Password in URL If you check this option, then you can specify the user's password in a

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.