PSCS Wiki

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.

Mail Connectors -> Mail Senders -> SMTP Direct

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

Mail Connectors -> Mail Senders -> SMTP Direct VPOP3 can be configured to send mail directly to the recipient's mail server (or the recipient's mail service provider). Usually this is only used if you have a high-end business class Internet connection - such as a leased line, or your mail server is co-located in a data centre. Attempts to use SMTP Direct sending on a dial-up/ADSL/Cable/FTTC/etc connection may be problematic since the receiving mail server may think you a home user who has been …

Spam Filter Rules: ForEach

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

Spam Filter Rules: ForEach Statement ForEach Version 2.1.7+ Purpose Causes a loop to be run through for all values within specified criteria The ForEach statement requires either two or three parameters (depending on the type of loop that is being conducted), in the format

Spam Filter Rules: IfMatch

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

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

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

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 -> Local Mail -> General

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

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

Spam Filter Rules: AddBag

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

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

Spam Filter Rules: 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

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

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

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

Spamfilter Rule Weights

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

Spamfilter Rule Weights To edit the spamfilter rule weights, go to Settings -> Spamfilter -> General -> Rule Weights The VPOP3 spamfilter contains several rules which test for certain things, eg 'adult words', or entries in real-time blacklist databases, or whitelisted email addresses etc.

Spam Filter Rules: Comments

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

Spam Filter Rules: Comments In the spam filter scripts, blank lines are ignored. Any line beginning with a # character is treated as a comment. Comments must be on a line of their own; there is no way to add a comment to the end of a line. Examples

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

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

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

Spam Filter Rules: 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: 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: 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: 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: 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: HTTPGet

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

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

Spam Filter Rules: HTTPGetMD5

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

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

Spam Filter Rules: HTTPPost

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

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

Spam Filter Rules: SendMessage

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

Spam Filter Rules: SendMessage Statement SendMessage Version 2.4.5+ Purpose Allows you to send a message The SendMessage statement requires a recipient, subject, message text and a currently unused options parameter, in the format SendMessage

Spam Filter Rules: SURBL

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

Spam Filter Rules: SURBL Statement SURBL Version 2.1.7+ Purpose Allows a SURBL lookup on the specified hostname or IP address in the specified SURBL zone, and returns the result into the specified variable The SURBL statement requires a hostname, SURBL zone and variable name, in the format

Spam Filter Rules: WinHTTPGet

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

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

Spam Filter Rules: ZipContents

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

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

Spam Filter Rules: ZipContentsFull

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

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

Spam Filter Rules: ZipCount

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

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

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.

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.

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.

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

Settings -> Diagnostics

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

Settings -> Diagnostics The Diagnostics page allows you to enable, configure and disable various methods of diagnostic logging, within VPOP3. Log file overview By default, VPOP3 will keep two copies of most log files: * The current log file, with a

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.

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

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:

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.

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.

SMTP Direct Sender Settings

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

SMTP Direct Sender Settings Mail Connectors -> Mail Senders -> SMTP Direct Sender -> Settings tab The SMTP Direct Settings tab lets you set how VPOP3 will send mail using SMTP Direct DNS Servers to Use This setting tells VPOP3 the IP addresses of the DNS servers it should use to find the recipients' mail servers. Separate multiple addresses with commas.

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

Increase the spam score for certain recipients

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

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

Spamrules example - increase spam score for long sender domain

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

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

Spamrules example - increase spam score if there are many links in the email

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

Spamrules example - increase spam score if there are many links in the email This script is for the case where you to increase the spamminess of emails where the email contains many links - in this case we'll say if the email contains 10 or more links. Note that we do not necessarily recommend that you do this as it is not a very good indicator of spam, and will probably catch a lot of newsletter type emails, but it is something we've been asked for, so here it is.

Spam Filter Rules: Rule names and weights

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

Spam Filter Rules: Rule names and weights The script can designate names to refer to certain rules. This name is created using a DefineRule statement. If you the follow a statement by a word in square brackets, when that statement is actioned, VPOP3 will add the specified word to a list of 'matched conditions' which can be used in reporting.

Spam Filter Rules: AddBayesHam

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

Spam Filter Rules: AddBayesHam Statement AddBayesHam Version 2.1.7+ Purpose Adds the current message to the 'not-spam' (or 'ham') Bayesian database Example Add the message to the 'not-spam' database if score is less than 100 If ${Score} < 100 AddBayesHam EndIf

Spam Filter Rules: AddBayesSpam

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

Spam Filter Rules: AddBayesSpam Statement AddBayesSpam Version 2.1.7+ Purpose Adds the current message to the 'spam' Bayesian database Example Add the message to the 'spam' database if score is 100 or more If ${Score} >= 100 AddBayesSpam EndIf

Spam Filter Rules: AddBlackList

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

Spam Filter Rules: AddBlackList Statement AddBlackList Version 2.1.7+ Purpose Adds the specified data to the blacklist Example AddBlackList ${MailFrom}

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

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

Spam Filter Rules: AddWhiteList Statement AddWhiteList Version 2.1.7+ Purpose Adds the specified data to the whitelist Example AddWhiteList ${MailFrom}

Spam Filter Rules: Break

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

Spam Filter Rules: Break Statement Break Version 2.1.11+ Purpose Breaks out of a loop prematurely Example ForEach Recipient Rcpt IfMatch ${Rcpt} "/@spammer.com/i" ${Score} += 100 Break EndIf EndFor

Spam Filter Rules: CopyBag

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

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

Spam Filter Rules: DBDeleteTime

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

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

Spam Filter Rules: DBInsert

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

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

Spam Filter Rules: DBQueryOne

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

Spam Filter Rules: DBQueryOne Statement DBQueryOne Version 6.16+ Purpose Queries the spam filter database for a single record/aggregate The DBQueryOne statement performs a query on the spam filter database and returns a single value which is either the value of a record or an aggregate of several records.

Spam Filter Rules: DBUpdate

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

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

Spam Filter Rules: 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: Escape

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

Spam Filter Rules: Escape Statement Escape Version 2.3.6+ Purpose 'Escapes' the specified variable ready to pass as a regular expression The Escape statement should be called immediately before the variable, in the format Escape Example ${myvar} = "This costs $10.00" Escape myvar # ${myvar} is now "This costs \$10\.00"

Spam Filter Rules: 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: GetRFC822Date

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

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

Spam Filter Rules: GetSectionEncoding

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

Spam Filter Rules: GetSectionEncoding Statement GetSectionEncoding Version 2.3.9+ Purpose Retrieves the MIME encoding method for the specified MIME section number, and returns the result into the specified variable The GetSectionEncoding statement requires a message section number and variable name, in the format

Spam Filter Rules: GetSectionMD5

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

Spam Filter Rules: GetSectionMD5 Statement GetSectionMD5 Version 2.3.6+ Purpose Performs an MD5 hash on a specified MIME section of the message, and returns the result into the specified variable in hex encoded form The GetSectionMD5 statement requires a message section number and variable name, in the format

Spam Filter Rules: Goto

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

Spam Filter Rules: Goto Statement Goto Version 2.1.7+ Purpose A mechanism for directing the script towards a specified label The Goto statement requires a label name, in the format Goto Labels are single word entries that appear on a line of their own, immediately preceded by the colon (:) character. The colon character is not part of the label name.

Spam Filter Rules: IfInBag

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

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

Spam Filter Rules: IfLocalAddress

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

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

Spam Filter Rules: 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: Log

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

Spam Filter Rules: Log Statement Log Version 2.1.11+ Purpose Allows you to write entries to the spamrules log file The Log statement lets you write a custom entry to the SPAMRULES.LOG file. This can be useful for debugging scripts. Example Log "Sender = ${MailFrom}"

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

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

Spam Filter Rules: Redirect Statement Redirect Version 2.1.7+ Purpose Remove all original recipients, and send the message to the specified recipient (and optionally folder) Examples To redirect the message to the Postmaster user's inbox Redirect Postmaster

Spam Filter Rules: Reject

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

Spam Filter Rules: Reject Statement Reject Version 2.4.5+ Purpose Perform an SMTP 'Reject' on the incoming message The Reject statement requires an error code/text string, in the format Reject This will reject the current SMTP message with the specified SMTP result code. Use a 4xx error code (eg 450) to reject the message temporarily, or a 5xx error code (eg 550) to reject the message permanently.

Spam Filter Rules: RemoveBag

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

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

Spam Filter Rules: RemoveBayesHam

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

Spam Filter Rules: RemoveBayesHam Statement RemoveBayesHam Version 2.1.7+ Purpose Removes the current message from the 'not-spam' (or 'ham') Bayesian database Example Remove the message from the 'not-spam' database if score is 100 or more If ${Score} >= 100 RemoveBayesHam EndIf

Spam Filter Rules: RemoveBayesSpam

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

Spam Filter Rules: RemoveBayesSpam Statement RemoveBayesSpam Version 2.1.7+ Purpose Removes the current message from the 'spam' Bayesian database Example Remove the message from the 'spam' database if score is less than 100 If ${Score} < 100 RemoveBayesSpam EndIf

Spam Filter Rules: RemoveBlackList

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

Spam Filter Rules: RemoveBlackList Statement RemoveBlackList Version 2.1.7+ Purpose Removes the specified data from the blacklist Example RemoveBlackList ${MailFrom}

Spam Filter Rules: RemoveTags

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

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

Spam Filter Rules: RemoveWhiteList

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

Spam Filter Rules: RemoveWhiteList Statement RemoveWhiteList Version 2.1.7+ Purpose Removes the specified data from the whitelist Example RemoveWhiteList ${MailFrom}

Spam Filter Rules: Replace

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

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

Spam Filter Rules: *IFSUPPORT

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

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

Spam Filter Rules: *STOP

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

Spam Filter Rules: *STOP Statement *STOP Version 2.2.5+ Purpose Stops the parsing of the current spam filter script file The statements after the *STOP statement are not parsed, so will not cause syntax errors if they involve unrecognised commands.

Spam Filter Rules: StartDNS

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

Spam Filter Rules: StartDNS Statement StartDNS Version 2.2.1+ Purpose Begins an asynchronous DNS lookup in advance of the result being required in a subsequent DNS statement The StartDNS statement requires a type and hostname, in the format StartDNS

Spam Filter Rules: StartDNSBL

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

Spam Filter Rules: StartDNSBL Statement StartDNSBL Version 2.2.1+ Purpose Begins an asynchronous DNS blacklist lookup in advance of the result being required in a subsequent DNSBL statement The StartDNSBL statement requires a hostname and DNSBL zone, in the format

Spam Filter Rules: StartSURBL

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

Spam Filter Rules: StartSURBL Statement StartSURBL Version 2.2.1+ Purpose Begins an asynchronous SURBL lookup in advance of the result being required in a subsequent SURBL statement The StartSURBL statement requires a hostname and SURBL zone, in the format

Spam Filter Rules: Stop

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

Spam Filter Rules: Stop Statement Stop Version 2.1.7+ Purpose Stop processing the spam rules Example # Statements Stop # The script has stopped processing before it gets to this line

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.

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

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.

Webmail Status bar

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

Webmail Status bar The Status bar within VPOP3 webmail displays important information at a glance. [VPOP3 version 5.0 Webmail Status bar] User - At the far left, is a display to let you know which user is currently logged in. Version - After the username, there is an indication of the current VPOP3 version.