https://wiki.pscs.co.uk/ 2026-05-06T05:19:27+00:00 https://wiki.pscs.co.uk/ https://wiki.pscs.co.uk/_media/wiki:dokuwiki.svg text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_filtering?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:smtp_rule_example_-_restrict_who_can_send_to_a_local_email_address?rev=1542192349&do=diff SMTP Rule Example - restrict who can send to a local email address If you have a local email address (a user, group or distribution list) and you want to restrict which email addresses can send messages to this address, you can use SMTP rules. There are a few ways you can configure the SMTP rules for this scenario. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:use_download_rules_for_incoming_pop3_filtering?rev=1542192349&do=diff Use Download Rules for incoming POP3 message filtering If you have VPOP3 retrieving messages from a POP3 account on an ISP, then you can use Download Rules to do basic filtering on incoming messages. (If you have incoming SMTP, then use SMTP Rules instead) Download rules cannot perform all mail filtering tasks. For more features, text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:custom_filtering_incoming_mail?rev=1542192349&do=diff Custom filtering incoming mail If you want to filter incoming mail using custom rules there are a few ways of doing this, depending on your exact requirements. * Download rules - if your incoming mail is via POP3 collection, you want to filter on headers, size etc (not contents) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:download_rules?rev=1542192349&do=diff Download Rules Download rules are a facility in VPOP3 where it can look at message summary information before downloading a message from an ISP POP3 mailbox (they do not work on incoming SMTP messages - use SMTP Rules for that) To edit download rules, go to text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_autoresponder?rev=1542192349&do=diff Autoresponder An autoresponder is a way of automatically replying to messages as they arrive in a user's mailbox. In VPOP3, an incoming message must arrive in a user's mailbox for the autoresponder to trigger. If you use forwards, assistants, mappings, etc to divert a message before it arrives in the mailbox, the autoresponder will never trigger. If you want to use an autoresponder, but not keep the original message, then make sure the message arrives in the mailbox (eg by using an 'Assistant'… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:download_rules?rev=1542192349&do=diff Download Rules Download rules are applied to messages downloaded using a POP3 mail collector. To configure the rules, go to the VPOP3 settings, then Mail Connectors -> Mail Collectors -> POP3 General. There is an Edit Download Rules button which brings up the download rule editor. To tell this mail collector to use the download rules, ensure that the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:vpop3_access_security?rev=1542192349&do=diff How To Setup VPOP3 Service Security VPOP3 can be configured to restrict access to its various services depending on the client computer's IP address. This is useful if you want to allow access from only certain IP addresses (eg within your LAN) and prevent access from other IP addresses (eg the Internet). text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_prune_rules?rev=1542192349&do=diff Prune Rules The Edit User -> Prune Rules tab can be used to create/edit rules which cause messages to be automatically deleted according to specified criteria. To add or edit a “prune rule”, press the Add Rule button. This will add a new rule to the table, with a set of default settings. Don't worry, this rule doesn't take effect until you press the Submit button. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:copy_smtp_rules?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_message_rules?rev=1542192349&do=diff Message Rules The Edit User -> Message Rules tab can be used to create/edit rules which are processed when messages arrive in a User's mailbox. They can be used to copy messages, mark them as read, delete them, etc VPOP3 will process Message Rules in the order they appear in the list. If you want to change the order of the rules, you can drag & drop them into the correct order. Usually when VPOP3 has processed a rule, it will go on to check further rules, but you can use the text/html 2025-08-20T16:08:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lan_forwarding_script?rev=1755706120&do=diff 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: * text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:whats_new_in_version_5_webmail?rev=1542192349&do=diff What's new in version 5 webmail? This is a list of some of the most noticeable changes to VPOP3's webmail interface for version 5. For a more detailed list of changes, view our bugtracker. [VPOP3 Version 5 - mobile compatible webmail] Mobile compatible webmail If you access version 5 webmail from a mobile device, you will probably be redirected to the mobile compatible version. It is a cut-down version of Webmail, which retains the key features, but doesn't utilise the extra features which w… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:smtp_rules?rev=1542192349&do=diff SMTP Rules Download rules are applied to messages which arrive at VPOP3 using SMTP - either locally sent messages, or incoming messages received through an SMTP mail feed. To configure the rules, go to the VPOP3 settings, then Services -> SMTP Service text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:using_vpop3_spam_filtering_with_lan_forwarding?rev=1542192349&do=diff Using VPOP3 Spam Filtering with LAN Forwarding When using the VPOP3 Spam filter with LAN forwarding you need to be aware a bit of how it works. The spam filter will only quarantine messages which are going to a VPOP3 user. This is because that user needs to be able to log into VPOP3 to be able to view their quarantined messages. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:alter_lan_forwarding_rules_for_one_server_to_go_to_another?rev=1542192349&do=diff Database query to alter LAN Forwarding rules for one server to go to another If a LAN forwarding destination server fails, you may wish to change the LAN forwarding rules to point to the new server. (Note that, if planning ahead, it may be easier to use text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:diagnostics?rev=1542192349&do=diff 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 text/html 2026-03-26T11:41:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_rules_script?rev=1774525319&do=diff 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. text/html 2023-01-18T15:57:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spam_filter_rules?rev=1674057433&do=diff Spam Filter Rules VPOP3 Versions 2.1.7 and later have a built-in spam filter system which supports a simple script language optimised for content- and spam-filtering of email messages. This reference contains a definition of the spam filtering script language supported by VPOP3. Note that as later versions of VPOP3 are released, more language features may be added, so this reference indicates in which version of VPOP3 a particular feature was added. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:copy_outgoing_mail?rev=1542192349&do=diff Copy Outgoing mail Sometimes people need to copy outgoing mail for various reasons. There are several ways of doing this in VPOP3 depending on your exact requirements: * Message Monitoring - this copies all outgoing, incoming and/or internal mail sent by/to specific users to another specific user text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:write_your_own_spam_filter_rules?rev=1542192349&do=diff How to write your own spam filter rules VPOP3's spam filter uses a basic scripting language designed for filtering email messages, so a full description of writing your own rules would be very long and complex, as it is really something that only a programmer should do. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:autoresponderconditionlist?rev=1542192349&do=diff 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: text/html 2026-03-26T23:49:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_scripting?rev=1774568941&do=diff Lua Scripting Lua is a simple scripting programming language often used for embedding in other applications. VPOP3 uses it to customise behaviour in places where most people will be happy with the default behaviour, but occasionally people will want to do something more complicated. Rather than having lots of extra options to complicate things for most users, we have opted to go for a more flexible scripting facility. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:pop3_collection?rev=1542192349&do=diff POP3 Mail Collection POP3 Mail Collection is when VPOP3 will collect mail from an external POP3 mailbox - for instance, from an Internet Provider. POP3 General This page tells VPOP3 how to collect mail. * POP3 Server Address - this is the name (or IP address) of the POP3 server from which you want VPOP3 to collect mail text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:users?rev=1542192349&do=diff Users The Users page shows the list of users, as well as giving you some actions which you can perform use the user list. * Import users from file * Import users from Windows * Export users to file * Bulk Add Users * Edit User Welcome Message * Send Admin Message * Edit a User User List Outgoing Messages Just above the main user list is an entry Outgoing Message Queue. Clicking on this will let you see which messages are waiting to be sent out, and you can delete/ text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:webmail_tabs?rev=1542192349&do=diff Webmail Tabs From version 4 onwards, VPOP3 webmail has a tabbed structure, which enables you to move between various screens with minimal effort. By using tabs, the entire webmail can be loaded in one go - so there is no need to waste time and bandwidth by downloading the same key components each time you switch between the various parts of the webmail. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:filtering_attachments?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:attachment_processing?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getaddresstype?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_include?rev=1542192349&do=diff 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 <filename to 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. text/html 2026-03-16T11:02:32+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:useful_database_queries?rev=1773658952&do=diff Useful Database Queries Below are some database (SQL) queries which may be useful in some situations. You can run these from the 'psql' program at the command prompt. Some can also be run from the Settings -> Database -> Query page in the VPOP3 settings. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/faq:gdpr_for_vpop3?rev=1542192349&do=diff GDPR for VPOP3 self-hosted software VPOP3 is an email server program, it is not a service, so if you use VPOP3 on your own computer we are not a “data controller” or a “data processor” under GDPR rules as we never see any of your data (unless you give us permission to remotely connect to your PC for technical support purposes). text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:550_5.7.1_recipient_prohibited_x?rev=1542192349&do=diff 550 5.7.1 Recipient Prohibited (x) (where 'x' is a number) This means that you have an SMTP rule which is rejecting this recipient. The (x) indicates the SMTP rule number which is causing the rejection. View & edit your SMTP rules at Services -> SMTP Server text/html 2026-03-18T20:20:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:how_to?rev=1773865250&do=diff "How To" Articles Installation/Upgrades * Download VPOP3 * Install VPOP3 * Move VPOP3 * Upgrade VPOP3 * Upgrade VPOP3 to version 5.x or 6.x from version 4 or earlier * Upgrade VPOP3 to version 7.x from version 6 or earlier * Upgrade VPOP3 to version 8.x from version 7 or earlier * Upgrade VPOP3 to version 9 or later from version 7 or 8 * Performance Requirements * Installation Checklist General Configuration * Initial Configuration * Users * Add an Alias * Create… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:incoming_smtp_feed?rev=1542192349&do=diff Incoming SMTP Feed An incoming SMTP feed is where incoming mail is sent directly to your mail server without going through your ISP's POP3 mail server on the way. Advantages An incoming SMTP feed has several advantages over going via a POP3 mailbox: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:limit_size_of_sent_mail?rev=1542192349&do=diff How to limit size of sent mail There are several ways to limit the size of mail which can be sent * Limit the size of mail accepted by the SMTP component of VPOP3 * Limit the size sent for a particular user * Limit size based on 'rules' * Limit size based on text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:sender_policy_framework?rev=1542192349&do=diff Sender Policy Framework / SPF SPF is a system used to tell mail servers which IP addresses can send mail from which domains. It is designed to reduce 'spoofing' of email addresses. For instance, if you receive an email message from your bank, your mail software can check that it came from an IP address authorised to send mail from your bank, and treat the message with suspicion if it didn't come from an authorised IP address. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:whitelist_blacklist?rev=1542192349&do=diff 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 -> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:alter_lan_forwarding_queued_messages_going_to_one_server_to_go_to_another?rev=1542192349&do=diff Database query to alter LAN Forwarding rules for one server to go to another If a LAN forwarding destination server fails, you may wish to change the queued messages to go to the new server. (Note that, if planning ahead, it may be easier to use DNS text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:edit_a_user?rev=1542192349&do=diff Edit a user To edit a user, go to the Users list in the VPOP3 settings and double-click on the username. * General * Passwords * Routing * WebMail Settings * Autoresponder * Message Rules * Permissions * Quotas * Aliases * Address Book * Signature * Advanced * Media * Finger Info text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:export_lan_forwarding_rules?rev=1542192349&do=diff Database query to export LAN Forwarding rules At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type \copy (select conditions, address, server, username, password, outaddress as rewriteaddress, matchcount as matches from rules.lanforwarding order by ruleorder) to 'c:/temp/x.csv' csv header; text/html 2023-08-16T07:48:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_pop3_client_script?rev=1692172081&do=diff 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: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:sender_advanced_settings?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamfilter_rule_weights?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_assignments?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_rule_names_and_weights?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_definerule?rev=1542192349&do=diff 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 "<name>" <default weights> "<description>" text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_stop?rev=1542192349&do=diff 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 text/html 2023-08-14T16:01:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_variables?rev=1692028861&do=diff Spam Filter Rules: Variables The VPOP3 spam filter script language supports simple variables. In most places these are specified as ${<variable name>}, but in some places they are just specified as <variable name> - for instance where a statement always puts its result into a variable. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_delivery_script?rev=1542192349&do=diff User Delivery Script (VPOP3 v6.5 or later) If there is a <username>/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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:version_4_webmail?rev=1542192349&do=diff VPOP3 Webmail Help Webmail is a way of accessing your mail using a normal web browser. It is designed to be close in functionality to a 'normal' email client, so should be straightforward to use. If you use VPOP3 Enterprise, then the mail visible through the web browser will be the same as that visible through your IMAP4 email client - the IMAP4 client will synchronise with Webmail. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:webmail_menu?rev=1542192349&do=diff Webmail Menu bar The Webmail Menu bar within VPOP3 webmail enables you to quickly perform relevant actions. The Menu has six main headings; of which, three have multiple options. Option Active Function V Notes Message Mail and View Message tabs Opens/closes Message menu text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleactions?rev=1542192349&do=diff UserRuleActions Replacement Use: ~userruleactions~ <format string> ~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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/faq:what_is_postgresql?rev=1542192349&do=diff What is PostgreSQL? PostgreSQL is an SQL database engine. VPOP3 and PostgreSQL In VPOP3 2.x, VPOP3 uses a database engine called SQLite for its database needs. SQLite has limited locking facilities, so on busy systems we encountered problems where databases would need very frequent updates, and the lock limitations would cause the updates to take a long time. For this reason we added optional support for PostgreSQL to later versions of VPOP3 2.x. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/faq:what_is_the_difference_between_vpop3_standard_and_vpop3_enterprise?rev=1542192349&do=diff What is the difference between VPOP3 Basic and VPOP3 Enterprise? VPOP3 Enterprise includes all the features of VPOP3 Basic, plus: * IMAP4 mail support as well as POP3, SMTP and Webmail * Support for database (ODBC) links for the Global Address Book and Mailing Lists. * Shared calendars & webmail address books text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:550_not_permitted?rev=1542192349&do=diff 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. text/html 2025-05-21T07:57:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:allowing_mail_relay_through_vpop3?rev=1747814238&do=diff How To Allow Mail Relay Through VPOP3 If you are allowing remote access into VPOP3 to collect mail then you may also want those remote users to be able to send their outgoing mail through VPOP3 as well. This is more complex than allowing users to collect mail, because, by default, SMTP connections are not authenticated. This means that when someone tries to send a message through VPOP3, VPOP3 doesn't know who that user is. This can cause a problem if unauthorised users try to send mail through… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:attachments_have_been_removed_or_renamed?rev=1542192349&do=diff Attachments have been removed or renamed If you have received an email and one or more of its attachments have been removed or renamed, it might be a result of Attachment Filtering. You can inspect the filtering rules by going to Administration Settings -> Settings -> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:autoresponders_out_of_office?rev=1542192349&do=diff Autoresponders / Out of Office VPOP3 has an autoresponder facility for sending automatic replies when a message arrives in a mailbox. This is often used for 'Out of Office' replies, but it is not limited to that use. To set an autoresponder, the administrator can edit the user and go to the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:can_t_alter_dates_in_autoresponder_rules?rev=1542192349&do=diff Can't alter dates in Autoresponder Rules If you try to edit an Autoresponder Rule which has a start/end time set, you may notice that you can't edit the dates in there. This is because VPOP3 prevents you from setting it so that the “start date” is after the “end date text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:don_t_download_big_messages_during_the_working_day?rev=1542192349&do=diff Don't download big messages during the working day using Download Rules Say you don't want to download messages over 10,000,000 bytes long between 8:00am and 6:00pm. To do this, create a download rule as: * Rule Type: Ignore * Match Type: All Conditions text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:err_mailbox_locked?rev=1542192349&do=diff -ERR Mailbox Locked error If your email client displays an '-ERR Mailbox Locked' or '-ERR [IN-USE] Mailbox Locked' error when trying to log into VPOP3 it means that the mailbox is locked. The POP3 standard requires that POP3 mailboxes have an 'exclusive lock' on them when they are in use. This means that only one POP3 client can access the mailbox at once. Also, if a POP3 mailbox is currently accessing a mailbox, then no IMAP4, Webmail or administrator access is allowed to the mailbox at the s… text/html 2026-04-06T17:59:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:mail_not_downloading_from_isp?rev=1775498387&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:not_working_as_expected?rev=1542192349&do=diff Not Working As Expected This is the page to come to if you think you've set something up correctly but it isn't doing what you think it should be doing. If you're getting an error message or some other concrete indication that something has actually 'gone wrong' then the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:obtaining_error_logs?rev=1542192349&do=diff How to Obtain Error Logs As part of diagnosing a support issue our support team may ask you to send them various log files. This page explains how to obtain the right files at the right time. How Logging Works Under its default settings VPOP3 logs a minimal amount of information about what it is doing to various files in the main VPOP3 directory. When investigating a support issue it is often the case that we will need you to switch on logging to extra files or increase the level of detail be… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:rbl_checking_not_working_in_vpop3_enterprise?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:spam_filter_content_filter_scripts?rev=1542192349&do=diff Spam filter / Content filter scripts The spam filter system uses basic scripting language for processing messages. This can be used for custom content filtering as well if you need to look inside the messages (e.g. at message content, attachments) as well as at the message headers etc. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:using_advanced_vpop3_features_with_lan_forwarding?rev=1542192349&do=diff Using VPOP3 Advanced Features with LAN Forwarding If you are wanting to use any of VPOP3's advanced features (such as mailing lists, message monitoring, wildcard aliases etc) because you are LAN forwarding to a less capable server, then you will usually need to have VPOP3 do all its normal message routing functions initially, then, as the final stage have it forward the messages on to the other server. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:using_the_spam_filter?rev=1542192349&do=diff Using the VPOP3 Spam Filter * Training the Spam Filter * Customising the spam filter scripts text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:vpop3_deleting_messages_as_old_messages?rev=1542192349&do=diff VPOP3 Deleting messages as 'old' messages If VPOP3 says 'deleting old message' in the status window activity log that means that it has seen the unique ID of that message before, longer ago than the time specified for VPOP3 to leave messages on the server, so it thinks that the message is an old message, and so deletes it. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleactions?rev=1542192349&do=diff UserRuleActions Replacement Use: ~userruleactions~ <format string> ~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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:calendar_events?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_schema_used_in_vpop3_5.x?rev=1542192349&do=diff Database schema used in VPOP3 5.x Note that all information in this section is subject to change. We do not guarantee that the database schema will remain constant, even between minor upgrade versions, so use this information at your own risk. Do not alter the database schema used by VPOP3 (including indexes, triggers & functions) or your whole VPOP3 data store may collapse. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:list_messages_in_lan_forwrding_queue_waiting_to_go_to_a_specific_server?rev=1542192349&do=diff Database query to list messages in the LAN forwarding queue waiting to go to a specific server The VPOP3 settings show the first 100 messages in the LAN forwarding queue. Usually this is sufficient as the LAN forwarding queue is usually nearly empty, but in case of a problem it may be much bigger. The database queries below let you list just messages going to a specific server. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lists?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:local_mail_general?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:logdb_spamrules?rev=1542192349&do=diff LogDB.SpamRules table The LogDB.SpamRules table contains a record of the spamfilter rules which matched for messages logged by VPOP3. A message may have zero or more spamrules entries Columns * spamruleid - this is a bigint sequential value which identifies the spam rule entry uniquely in the database text/html 2026-02-24T15:50:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_mx_server_rules?rev=1771948203&do=diff 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). text/html 2025-08-14T09:24:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_relay_control?rev=1755163495&do=diff 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: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:misc_advanced?rev=1542192349&do=diff Misc -> Advanced Tab Settings -> Misc Settings -> Advanced You will normally not need to change any settings on this page unless VPOP3 technical support have suggested it. If you do make changes, and want to go back to the original settings, the Restore Defaults button will restore the settings to their defaults. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:misc_external_fax?rev=1542192349&do=diff Misc -> External Fax Tab Settings -> Misc Settings -> External Fax The External Fax tab is for use with some external fax server applications which work by collecting mail from a POP3 mailbox. If a Fax Server Mailbox is selected, then VPOP3 will automatically send any locally sent mail to that mailbox if the recipient is local, but doesn't match another local address (a user, list, mapping etc), text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:quarantine_viewer?rev=1542192349&do=diff Spamfilter Quarantine Viewer Settings -> Spamfilter -> Quarantine Viewer The Quarantine Viewer lets you see messages which have been quarantined by the VPOP3 Spam Filter. As an administrator you can see quarantined messages for any user, and release them if appropriate. If you release a message, it will be sent into the original recipient's Inbox, not into your Inbox. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:reference?rev=1542192349&do=diff VPOP3 Reference This is a reference guide for VPOP3 version 3 or later's settings. For details on how to do things, rather than what a particular button does, see the how to section. Also see the online manual: * Users * Lists * Mappings * Mail Connectors * Services * Settings * Status * Reports * About * Status Monitor * text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_spam_reduction?rev=1542192349&do=diff SMTP Server -> Spam Reduction The Spam Reduction tab lets you configure various ways VPOP3 can reduce spam and email address spoofing Domainkeys “Domainkeys” is a way of signing a message to show that it comes from the person it claims to come from. The system is too complex to go into here, but it essentially takes key parts of the message header, as well as the message body and creates a PKI digital signature on it, using a 'private key' on your system. The receiving end will find the same… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_comments?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addbag?rev=1542192349&do=diff 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 <type> <bag name> <value> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addbayesham?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addbayesspam?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addblacklist?rev=1542192349&do=diff Spam Filter Rules: AddBlackList Statement AddBlackList Version 2.1.7+ Purpose Adds the specified data to the blacklist Example AddBlackList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addheader?rev=1542192349&do=diff Spam Filter Rules: AddHeader Statement AddHeader Version 2.1.7+ Purpose Allows you to add, replace or remove the specified header line in the message headers The AddHeader statement requires the full header line in one continuous string, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addnulladdress?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addwhitelist?rev=1542192349&do=diff Spam Filter Rules: AddWhiteList Statement AddWhiteList Version 2.1.7+ Purpose Adds the specified data to the whitelist Example AddWhiteList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_break?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_bulkscan?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_clearbag?rev=1542192349&do=diff 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 <bag name> Example The following example removes all values from the 'recipient' bag ClearBag recipient text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_convert?rev=1542192349&do=diff Spam Filter Rules: Convert Statement Convert Version 2.4.9+ Purpose Allows you to convert data from one form to another The Convert statement requires a data parameter, conversion method and variable name, in the format Convert <data> <conversion method> <variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_copy?rev=1542192349&do=diff Spam Filter Rules: Copy Statement Copy Version 2.1.7+ Purpose Sends a copy of the message to the specified recipient (and optionally folder) Examples To copy the message to the Postmaster user's inbox Copy Postmaster To copy the message to the Postmaster user's 'spam' folder text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_copybag?rev=1542192349&do=diff 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 <operator> <from bag> <to bag> text/html 2025-06-06T08:12:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_countmatches?rev=1749197557&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dbdeletetime?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dbinsert?rev=1542192349&do=diff 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 <type> <component name> <key> <value> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dbqueryone?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dbupdate?rev=1542192349&do=diff 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 <component name> <key> <operator> <value> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_definesetting?rev=1542192349&do=diff Spam Filter Rules: DefineSetting Statement DefineSetting Version 2.1.9+ Purpose Defines a generic setting, the default value and description The DefineSetting statement requires a name, default value and description, in the format DefineSetting "<name>" <default value> "<description>" text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dns?rev=1542192349&do=diff 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 <type> <hostname> <variable name> text/html 2020-10-23T16:07:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dnsbl?rev=1603469269&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_escape?rev=1542192349&do=diff 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 <variable name> Example ${myvar} = "This costs $10.00" Escape myvar # ${myvar} is now "This costs \$10\.00" text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_foreach?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getdecodedsection?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getmd5?rev=1542192349&do=diff 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 <string> <variable name> text/html 2023-08-14T15:53:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getrfc822date?rev=1692028395&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getsectionencoding?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getsectionmd5?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getusergroup?rev=1542192349&do=diff 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 <username> <variable name> text/html 2025-06-06T08:15:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_globalmatch?rev=1749197750&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_goto?rev=1542192349&do=diff 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 <label name> 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_httpget?rev=1542192349&do=diff 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 <url> <headers variable name> <content variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_httpgetmd5?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_httppost?rev=1542192349&do=diff 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 <url> <data string> <headers variable name> <content variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_if?rev=1542192349&do=diff Spam Filter Rules: If Statement If Version 2.1.7+ Purpose Enables you to perform a simple relational test on a variable You can specify a variable or a constant on either or both sides of the relational operator. The relational operator can be one of: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_ifinbag?rev=1542192349&do=diff 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 <bag name> <value> * All IfInBag statements must be followed by an text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_iflocaladdress?rev=1542192349&do=diff 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 <address> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_ifmatch?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_log?rev=1542192349&do=diff 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}" text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_random?rev=1542192349&do=diff 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 <lower> <higher> <variable> * text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_redirect?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_reject?rev=1542192349&do=diff 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 <error string> 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removebag?rev=1542192349&do=diff 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 <bag name> <value> * If the value is found in the bag, it is removed text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removebayesham?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removebayesspam?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removeblacklist?rev=1542192349&do=diff Spam Filter Rules: RemoveBlackList Statement RemoveBlackList Version 2.1.7+ Purpose Removes the specified data from the blacklist Example RemoveBlackList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removetags?rev=1542192349&do=diff 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 <variable name> * HTML tags are removed * text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removewhitelist?rev=1542192349&do=diff Spam Filter Rules: RemoveWhiteList Statement RemoveWhiteList Version 2.1.7+ Purpose Removes the specified data from the whitelist Example RemoveWhiteList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_replace?rev=1542192349&do=diff 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 <variable> <search> <replace> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_sendmessage?rev=1542192349&do=diff 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 <recipient> <subject> <message text> <options> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_star_ifsupport?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_star_stop?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_startdns?rev=1542192349&do=diff 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 <type> <hostname> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_startdnsbl?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_startsurbl?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_surbl?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_winhttpget?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_zipcontents?rev=1542192349&do=diff 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 <message section number> <bag name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_zipcontentsfull?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_zipcount?rev=1542192349&do=diff 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 <message section number> <variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_permissions?rev=1542192349&do=diff Permissions This section lets you configure the permissions that a particular user has. Allowed Protocols The Allowed Protocols section lets you specify which services this user has access to. Note that these settings affect access to the whole service. If you want users to be able to access a service from some IP addresses, but not from others, then use the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:virus_scan_filter_script?rev=1542192349&do=diff 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.