PSCS Wiki

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.

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

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.

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

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

How to Backup VPOP3

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

How to Backup VPOP3 By default VPOP3 v3 and later will automatically perform a daily backup of the database into a file called DBBACK-x.DMP, where the backup file rotates on a weekly basis (DBBACK-0.DMP is Sunday's backup, DBBACK-1.DMP is Monday's backup, etc).

Recovering messages from corrupted database into fresh database

Anonymous (anonymous@undisclosed.example.com) — 2025-09-11T13:48:07+00:00

Recovering messages from corrupted database into fresh database If the VPOP3 message database is corrupted, then one option is to build a fresh database and restore the settings into it, then recover the messages from the old database using the 'Message Restore' function in VPOP3. This has minimal downtime, but old messages will not all be available until the restore has completed. New messages will be available quickly, and you will be able to send messages.

Error message: Your connection has been blocked temporarily - Try again later

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

Error message: Your connection has been blocked temporarily - Try again later If you get an error message in your email client software saying Your connection has been blocked temporarily - Try again later or Server access temporarily blocked! Please try again later

AutoresponderConditionList Replacement

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

AutoresponderConditionList Replacement Use: ~autoresponderconditionlist~ Required parameter: responderid - the ID of the autoresponder This returns a JSON structure containing an array of the rules associated with the specified autoresponder. The return structure is an array of objects containing:

AutoresponderInfo Replacement

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

AutoresponderInfo Replacement Use: ~autoresponderinfo~ Required parameter: responderid - the ID of the autoresponder This returns a JSON structure containing the details of the specified autoresponder. The return structure is an object containing:

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.

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

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

LogDB.Attachments table

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

LogDB.Attachments table The LogDB.Attachments table contains a record of the attachments for messages logged by VPOP3. A message may have zero or more attachments Columns * attachid - this is a bigint sequential value which identifies the attachment uniquely in the database

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:

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

OutMsgRecipients Replacement

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

OutMsgRecipients Replacement Use: [~outmsgrecipients~] Required parameter: MsgID This returns a JSON array containing details on the recipients for the specified message in the VPOP3 out queue. There is one object returned per recipient, and the object is:

What is the VPOP3 Antivirus solution?

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

What is the VPOP3 Antivirus solution? “VPOP3 Antivirus” is a new product to replace the avast! for VPOP3 product which will no longer be supported after the end of 2012. VPOP3 Antivirus uses the popular 'ClamAV' virus scanner to scan incoming and outgoing messages for viruses.

550/553 Not Permitted error from BT Internet's mail servers

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

550/553 Not Permitted error from BT Internet's mail servers BT Internet's mail servers only allow messages to be sent from 'approved' email addresses. If you try to send messages from other addresses BT's mail servers may return a '550 Not Permitted' error, a '553' error, or may silently discard the message depending on what their server feels like doing today.

Controlling VPOP3 via Email

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

Controlling VPOP3 via Email You can control certain aspects of VPOP3 by sending emails to 'mailer_daemon@' The subject line must be one of the lines below: * Set Assistant * Query Assistant * Password * Set Forwarding * Query Forwarding

How to filter attachments

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

How to filter attachments VPOP3 can filter attachments in several ways. The most general is to use the Settings -> Attachment Processing -> Filtering tab as described below. VPOP3 can also filter attachments using the content/spam filter, or by using an integrated virus scanner.

RBL Checking not working in VPOP3 Enterprise

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

RBL Checking not working in VPOP3 Enterprise VPOP3 Enterprise has an RBL checking feature which is configured in the VPOP3 Settings at Services -> SMTP Server -> SPAM Reduction -> Realtime Blacklist Rules If it does not seem to be working properly, there are a few reasons why the RBL feature may not work.

Restore Deleted Calendars

Anonymous (anonymous@undisclosed.example.com) — 2022-11-18T11:43:52+00:00

Restore Deleted Calendars This article will help if a user has been deleted and all their calendars are lost and need to be restored. Note that this functionality is not built into VPOP3, and requires the use of Python3 to run a script First you need to install Python 3.8 or later, and the psycopg2 plugin

How to move the VPOP3 Message Store to a new PC

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

How to move the VPOP3 Message Store to a new PC Use this option if you want to have VPOP3 running on one PC, but have the message store database on another PC. Manually Install PostgreSQL on the new PC Download the 'pgInstaller' version of PostgreSQL from the

v3/4 - Move the message store to a new folder/drive

Anonymous (anonymous@undisclosed.example.com) — 2018-12-05T15:25:24+00:00

v3/4 - Move the message store to a new folder/drive This guide assumes you want to just move the VPOP3 message store/database to a new folder on the same PC, and leave the VPOP3 installation directory where it is. * Stop VPOP3 * Stop PostgreSQL

Move VPOP3 Version 3 or 4 to a new PC

Anonymous (anonymous@undisclosed.example.com) — 2019-11-12T16:09:08+00:00

Move VPOP3 Version 3 or 4 to a new PC Moving VPOP3 Version 3 or 4 to a new PC is slightly different from moving earlier versions, because of the database system. The summary of steps is: * Stop VPOP3 on the original PC * Manually make a backup of the database on the original PC

v5 - Move the message store to a new folder/drive

Anonymous (anonymous@undisclosed.example.com) — 2019-11-12T16:10:42+00:00

v5 - Move the message store to a new folder/drive Here is an alternative method, which may be simpler, but only moves the data, not the whole database store (which is a subtle difference) This guide assumes you want to just move the VPOP3 message store/database to a new folder on the same PC, and leave the VPOP3 installation directory where it is.

Move VPOP3 Version 5 (or later) to a new PC

Anonymous (anonymous@undisclosed.example.com) — 2026-04-21T11:12:40+00:00

Move VPOP3 Version 5 (or later) to a new PC Moving VPOP3 Version 5 or later to a new PC is slightly different from moving earlier versions, because of the database system, which was introduced for version 3 and modified for version 5. The summary of steps is: * Stop VPOP3 on the original PC

Error message: VPOP3 Alert - Non-existent user -

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

Error message: VPOP3 Alert - Non-existent user - If you receive an error message like: Subject: VPOP3 Alert - Non-existent user - Delivery Failure Report. There was incoming mail for non-existent user "". This means that VPOP3 downloaded a message using POP3 and it was addressed to an email address which does not exist.

VPOP3 is using a lot of disk space

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

VPOP3 is using a lot of disk space If VPOP3 is using a lot of disk space, the problem is usually that there is lots of data there, so it has to use the disk space. Message Storage In VPOP3 version 5 and later, all users' messages are stored in the database, so they will occupy space in the VPOP3\pgsql\data folder.

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.

Archive Script

Anonymous (anonymous@undisclosed.example.com) — 2023-03-25T23:33:31+00:00

Archive Script (from VPOP3 v6 onwards) Archive scripting lets you indicate whether full message content should be stored in the message archive. This could be used, for instance, for filtering out messages containing credit card details. The message headers will still be archived, along with the explanation text returned by the script.

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 *

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.

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

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

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.

LogDB.Messages table

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

LogDB.Messages table The LogDB.Messages table contains a record of all messages logged by VPOP3. A message is logged when a message is sent/received/etc. Columns * msgid - this is a bigint sequential value which identifies the message uniquely in the database

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

LogDB.Sessions table

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

LogDB.Sessions table The LogDB.Sessions table contains a record of all 'sessions' logged by VPOP3. A session is something like a POP3 server session as an email client downloads messages, or an SMTP client session as VPOP3 sends a message out to the Internet, and so on.

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:

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:

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:

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.

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

VPOP3 Status Monitor

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

VPOP3 Status Monitor The VPOP3 status monitor allows users to see what VPOP3 is doing, and also, optionally, to send/receive simple 'instant messages' between local users. Different users can have different permissions for the status monitor. They can be set for all administrators or non-administrators on

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

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:

VPOP3.GetUsers Lua function

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

VPOP3.GetUsers Lua function The Lua management function 'VPOP3.GetUsers' retrieves a table containing all the users defined in VPOP3, it takes no parameters and returns a table indexed from 1 to N where the values are the user names.

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

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

VPOP3.PostgresQuery The Lua function 'VPOP3.PostgresQuery' performs a query on the PostgreSQL database and returns the results in a table It takes a single parameter which is the SQL query to perform (Note that any relations used in the query must have the schema specified).

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.