PSCS Wiki

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:

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.

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:

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

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.

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

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

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.

Configure SRS

Anonymous (anonymous@undisclosed.example.com) — 2025-08-18T15:28:11+00:00

Configure SRS In VPOP3 8.8 and later, you can use Lua scripting to implement 'SRS' (Sender Rewriting Scheme') in VPOP3 This involves adding a couple of functions to rewrite outgoing return paths in 'relayout.lua' or 'mxout.lua' as appropriate and a couple of functions to redirect rewritten bounce message recipients in 'smtpsvr.lua'

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.

SMTPIDSEvents Replacement

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

SMTPIDSEvents Replacement Use: ~smtpidsevents~ This returns the latest entries from the SMTP client logging database. It will return 100 entries unless the count parameter is specified in the URL, in which case that will specify the maximum number of entries to return.

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

Forwarded Emails Not Arriving

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

Forwarded Emails Not Arriving If you are having problems having VPOP3 forward incoming messages to an external address, but sending messages directly to that address works OK, and forwarding internal messages to that address works OK, then the problem may be the SMTP return address which VPOP3 is using.

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

Spam Filter Rules: Assignments

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

Spam Filter Rules: Assignments You can assign values to variables using the syntax ${variable} = value | ${variable} Assignment operators The spam filter rules support the following assignment operators: = Specify the value of the variable to equal the value after the assignment operator

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

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

Lua SMTP MX Server Rules

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

Lua SMTP MX Server Rules Every time VPOP3 checks for remote MX server for sending messages using direct MX sending, it runs a script called mxserverrules.lua which can be created/edited in Settings -> Scripts (or in the VPOP3 directory in VPOP3 v6.6 or earlier).

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.

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.

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

UserQueueMessage Replacement

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

UserQueueMessage Replacement Use: ~userqueuemessage~ Required parameter: Account, Msgid Optional parameter: Folder ('Inbox' is used if not specified) You can also use the : modifier to set the maximum size of the response. If none is specified then a maximum size of 1000 characters is used. (e.g. use **~userqueuemessage:10000~)

Version 5 Web Admin API

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

Version 5 Web Admin API This section is only relevant for people who may want to access the Administration features from their own scripts, or want to customise the standard administration pages. Note that no free support is available for this. This is not a full list of features, but it will be updated from time to time.

AutoresponderList and AutoresponderGlobalList Replacements

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

AutoresponderList and AutoresponderGlobalList Replacements Use: ~autoresponderlist~ or ~autorespondergloballist~ Required parameter: None This returns a JSON structure listing all the autoresponder details available. autoresponderlist returns the personal autoresponder details.

Version 5 Web Mail API

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

Version 5 Web Mail API This section is only relevant for people who may want to access the WebMail features from their own scripts, or want to customise the standard Webmail pages. Note that no free support is available for this. This is not a full list of features, but it will be updated from time to time.

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

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.

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:

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.

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

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

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:

OutMsgRetPath Replacement

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

OutMsgRetPath Replacement Use: ~outmsgretpath~ Required parameter: MsgID This returns the return path of the specified message in the VPOP3 out queue

SMTPClientBlocks Replacement

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

SMTPClientBlocks Replacement Use: ~smtpclientblocks~ ~end~ The format string can have the replacements * address - IP address (returned as host address or CIDR address as appropriate) * date - the date/time the address was added to the database in YYYYMMDDHHMMSS format

SMTPSPFWhitelist Replacement

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

SMTPSPFWhitelist Replacement Use: ~smtpspfwhitelist~ ~end~ If you specify the parameter serverid then this will just return white list entries which match all servers or this server. The format string can have the replacements * id - the whitelist entry ID

Spamfilter Whitelist & Blacklist

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

Spamfilter Whitelist & Blacklist The VPOP3 spamfilter has a whitelist and a blacklist for sender addresses. It also has a whitelist and blacklist for words/phrases. You can view these lists in the VPOP3 settings by going to Settings -> Spamfilter ->

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:

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.

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

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

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

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

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

OutMsgAuth Replacement

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

OutMsgAuth Replacement Use: ~outmsgauth~ Required parameter: MsgID This returns the authenticated sender (if any) of the specified message in the VPOP3 out queue.

OutMsgHold Replacement

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

OutMsgHold Replacement Use: ~outmsghold~ Required parameter: MsgID This returns whether the specified message in the VPOP3 out queue is held or not (1 or 0 respectively)

OutMsgIP Replacement

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

OutMsgIP Replacement Use: ~outmsgip~ Required parameter: MsgID This returns the sender IP address of the specified message in the VPOP3 out queue.

SMTPClientAllows Replacement

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

SMTPClientAllows Replacement Use: ~smtpclientallows~ ~end~ The format string can have the replacements * address - IP address (returned as host address or CIDR address as appropriate) * date - the date/time the address was added to the database in YYYYMMDDHHMMSS format

UserId Replacement

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

UserId Replacement Use: ~userid~ Required parameter: None This returns the userid/name of the currently logged in user

UserNumber Replacement

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

UserNumber Replacement Use: ~usernumber~ Required parameter: None This returns the numeric ID of the currently logged in user

UserRuleActions Replacement

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

UserRuleActions Replacement Use: ~userruleactions~ ~end~ Required parameter: Account, RuleId This returns the message rule actions for the specified rule The format string can have the replacements * id - numeric ID of the action * type - action type

UserRuleActionUpdate Replacement

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

UserRuleActionUpdate Replacement Use: ~userruleactionupdate~ Required parameter: * Account * RuleId * gr_id - action ID * !nativeeditor_status - inserted/deleted/updated * type * data This inserts/updates/deletes the specified message rule action

UserRuleConditions Replacement

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

UserRuleConditions Replacement Use: ~userruleconditions~ ~end~ Required parameter: Account, RuleId This returns the message rule conditions for the specified rule The format string can have the replacements * id - numeric ID of the condition

UserRuleConditionUpdate Replacement

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

UserRuleConditionUpdate Replacement Use: ~userruleconditionupdate~ Required parameter: * Account * RuleID * gr_id - condition ID * !nativeeditor_status - inserted/deleted/updated * matchi (1/0) * matchn (1/0) * match * field * data

UserRuleList Replacement

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

UserRuleList Replacement Use: ~userrulelist~ ~end~ Required parameter: Account This returns the message rule list (in order) for the specified user The format string can have the replacements * id - numeric ID of the rule * order - numeric order number (1-n) of the rule

UserRuleUpdate Replacement

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

UserRuleUpdate Replacement Use: ~userruleupdate~ Required parameter: * Account * gr_id - rule ID * !nativeeditor_status - inserted/deleted/updated * name * all * type This inserts/updates/deletes the specified message rule The return value is an XML tag:

535 Authentication Failed

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

535 Authentication Failed This is an SMTP error meaning that an attempt to authenticate has failed. If this error is appearing when the email client is trying to log into VPOP3, then you can check the VPOP3 'SECURITY.LOG' file which may contain more information, such as an invalid password, unknown username, etc. (This information is not returned in the SMTP session because it would help an attacker).

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.

Backscatter

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

Backscatter In email, “backscatter” is the term used if you send bounce messages back to spam messages. As most spam messages use forged email addresses, then the bounce messages will go to an innocent person, who will find them very annoying. Stopping VPOP3 from sending Backscatter

VPOP3 Database Size

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

VPOP3 Database Size The VPOP3 directory is stored in the VPOP3\pgsql\data folder and subfolders. If you are concerned about the size of the VPOP3 database, there are several factors which may make the database larger than you would expect: * The VPOP3 database contains a lot more information than just messages in mailboxes. This can include settings, outgoing messages, historical logging information, statistical information for the spamfilter, information about archived messages, etc. Also,…

Delete OutQueue messages directly from the database

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

Delete OutQueue messages directly from the database If there is an extremely large number of messages (eg hundreds of thousands) in the VPOP3 OutQueue, then it may take a very long time for VPOP3 v5 and later to start as it check the message database tables for consistency during initialisation.

Error Messages

Anonymous (anonymous@undisclosed.example.com) — 2025-10-06T15:21:37+00:00

Error Messages This is the place to look if you are trying to trouble shoot a problem and you have received or have access to a specific error message or error code. If instead your problem is that something you think is set up correctly is not working then the best place to look would be the

Mail Not Downloading From ISP

Anonymous (anonymous@undisclosed.example.com) — 2026-04-06T17:59:47+00:00

Mail Not Downloading From ISP This normally happens because you have told VPOP3 to Leave Messages On Server (on the Mail Connectors -> Mail Collectors -> (name) -> POP3 General tab). If you do this, VPOP3 will leave messages on the ISP's mail server for several days, and remember that it has already downloaded them. Then, the next time it connects it will see that there are some messages waiting, but it may find that it has already downloaded them, so it won't download them again.

Out of Disk Space When Sending Mail

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

Out of Disk Space When Sending Mail The first thing you should do is check that there is enough free disk space on the disk where VPOP3 is installed. VPOP3 requires a certain amount of free space before it will allow new messages to be sent, so the disk might not be totally full, but VPOP3 will still report that there is insufficient disk space when you try to send a new message. This buffer zone is designed to help prevent the disk totally filling up, which can cause lots of bigger problems!

VPOP3 - POP3 Client Problem

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

VPOP3 - POP3 Client Problem These errors occur whilst VPOP3 is communicating with your ISP's POP3 mail server to retrieve your mail. The server connection was closed unexpectedly If the message text is Error with Pop3 Client (XXXX (YY)) The server connection was closed unexpectedly

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

Seeing where a message came from

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

Seeing where a message came from Sometimes you need to check to see where a message really came from. The 'From:' email address is easily forged, so that cannot be relied upon. The first thing you have to do is to get the full message headers. These may look daunting, but are very useful for problem diagnosis.

VPOP3 - SMTP Client Problem

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

VPOP3 - SMTP Client Problem These errors occur whilst VPOP3 is communicating with your ISP's SMTP mail server to send your mail. If the message text is: Error with SMTP Client (XXXX (YY)) The server connection was closed unexpectedly Then this means that the the connection between VPOP3 and your ISP's SMTP mail server was closed when VPOP3 did not expect it to be. This can be caused by the network connection failing or a bug in the ISP's mail server which drops the connection in abnormal circ…

The message could not be loaded. Please return to the Quarantine page and try again

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

The message could not be loaded. Please return to the Quarantine page and try again This error normally means the message file has been deleted from the hard disk (probably by a virus scanner or something else on the PC). If you can find the message in the VPOP3 settings (Settings

MessageView4 Replacement

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

MessageView4 Replacement Use: ~messageview4~ Parameters: * “headers” (optional - “y” means show full headers, otherwise show condensed headers) * “msgformat” (optional - specifies format of 'message' in result. “text” means UTF8 text, otherwise UTF8

MinPasswordLength Replacement

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

MinPasswordLength Replacement Use: ~minpasswordlength~ Required parameter: None This returns the minimum password length specified in the VPOP3 Settings -> Security settings

UserId Replacement

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

UserId Replacement Use: ~userid~ Required parameter: None This returns the userid/name of the currently logged in user

UserNumber Replacement

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

UserNumber Replacement Use: ~usernumber~ Required parameter: None This returns the numeric ID of the currently logged in user

UserRuleActions Replacement

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

UserRuleActions Replacement Use: ~userruleactions~ ~end~ Required parameter: RuleId This returns the message rule actions for the specified rule The format string can have the replacements * id - numeric ID of the action * type - action type

UserRuleActionUpdate Replacement

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

UserRuleActionUpdate Replacement Use: ~userruleactionupdate~ Required parameter: * RuleId * gr_id - action ID * !nativeeditor_status - inserted/deleted/updated * type * data This inserts/updates/deletes the specified message rule action

UserRuleConditions Replacement

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

UserRuleConditions Replacement Use: ~userruleconditions~ ~end~ Required parameter: RuleId This returns the message rule conditions for the specified rule The format string can have the replacements * id - numeric ID of the condition * field - field/data to test

UserRuleConditionUpdate Replacement

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

UserRuleConditionUpdate Replacement Use: ~userruleconditionupdate~ Required parameter: * RuleID * gr_id - condition ID * !nativeeditor_status - inserted/deleted/updated * matchi (1/0) * matchn (1/0) * match * field * data This inserts/updates/deletes the specified message condition

UserRuleList Replacement

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

UserRuleList Replacement Use: ~userrulelist~ ~end~ Required parameter: None This returns the message rule list (in order) for the current user The format string can have the replacements * id - numeric ID of the rule * order - numeric order number (1-n) of the rule

UserRuleUpdate Replacement

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

UserRuleUpdate Replacement Use: ~userruleupdate~ Required parameter: * gr_id - rule ID * !nativeeditor_status - inserted/deleted/updated * name * all * type This inserts/updates/deletes the specified message rule The return value is an XML tag:

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.

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

Bandwidth Control

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

Bandwidth Control (VPOP3 Enterprise Only) Every time a connection is made to a VPOP3 service, or a user logs into a service, VPOP3 Enterprise runs a Lua function which can assign the connection a bandwidth pool, or assign a bandwidth limit on the connection.

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;

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:

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

os.timedexecute

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

os.timedexecute The Lua function 'os.timedexecute' runs an external program with a time limit It takes three parameters: * The program/command line to execute * The time to wait for completion (in seconds). If this time expires, the program is terminated

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

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

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

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

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

VPOP3.MessageReset The Lua function 'VPOP3.MessageReset' resets an internal read pointer to the start of the message being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes no parameters The function returns no value

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:

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: