https://wiki.pscs.co.uk/ 2026-05-06T11:55:36+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:users_autoresponderconditions?rev=1542192349&do=diff Users.AutoresponderConditions table The Users.AutoresponderConditions table contains a record of all autoresponder trigger conditions created in VPOP3. These tell VPOP3 when a particular autoresponder should fire for a particular user. Each autoresponder can have zero or more conditions. An autoresponder with zero conditions will never fire but can be reactivated later by adding a new condition. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:autoresponder_commands?rev=1542192349&do=diff Autoresponder Commands This article only applies to VPOP3 v4 and earlier A VPOP3 autoresponder can contain special text strings to create special behaviour, in addition to plain text as part of the response. There are three types of 'command' * 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 2026-03-23T15:29:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:autoresponder_global_script?rev=1774279769&do=diff Autoresponder Global Scripting For scripting to modify the autoresponder text which is embedded in the autoresponder itself, see Autoresponder Scripting The Autoresponder Global Script is executed for every autoresponse. It is stored in the 'Autoresponder.lua' script in Settings → Scripts text/html 2025-05-28T09:24:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:autoresponder_script?rev=1748424278&do=diff Autoresponder scripting For scripting to alter the whole autoresponder definition and set in the VPOP3 settings rather than embedded in an autoresponder itself, see Autoresponder Global Scripting In an autoresponder, you can create a Lua script by surrounding it with <lua> & </lua> tags, eg 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: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:msgaudit?rev=1542192349&do=diff msgaudit Database table This can (optionally) contain data showing how messages have been handled (eg deleted, moved, etc) * id - incrementing ID of msgaudit entry * datetime - the date & time the event occurred * component - which VPOP3 component performed the event text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:quarantine_tab?rev=1542192349&do=diff 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: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_advanced?rev=1542192349&do=diff SMTP Service -> Advanced Tab Services -> SMTP Server -> Advanced Tab Refuse SMTP Connections from This setting should be rarely needed, and should be normally left blank. It is here for historic purposes. If you put some text in this box, then VPOP3 will refuse any SMTP connections from clients whose 'HELO'/'EHLO' command data contains the text specified here as a substring. Eg, if this setting is set to '.myisp.com', then VPOP3 would refuse SMTP connections from any client which sends the c… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamfilter_whitelist?rev=1542192349&do=diff Spamfilter.Whitelist table The Spamfilter.Whitelist table contains the spamfilter whitelist entries which do not contain wildcards or regular expressions. They are separated out to speed up checking. Columns * address - this is the email address in the whitelist text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:summary_log_file_format?rev=1542192349&do=diff Summary Log File Format VPOP3 creates a file called SUMMARY.LOG in the VPOP3 directory which contains summary information which is compiled daily into a daily summary reports sent to the administrator. VPOP3 can keep these summary logs in a subdirectory called text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:white_black_lists?rev=1542192349&do=diff 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… text/html 2023-11-12T09:51:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:dmarc_reporter_script?rev=1699782700&do=diff DMARC Reporter Script (from VPOP3 v8.6 onwards) This script lets you customise how VPOP3 sends DMARC reports to the sending domain. This can be useful in case the sending domain's DMARC configuration is incorrect as that can cause errors sending the reports or cause messages to be 'stuck' in VPOP3's Outqueue. These problems won't cause any lasting damage, but may be inconvenient or annoying, so you can alter the behaviour using Lua scripting text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:logdb_messages?rev=1542192349&do=diff LogDB.Messages table The LogDB.Messages table contains a record of all messages logged by VPOP3. A message is logged when a message is sent/received/etc. Columns * msgid - this is a bigint sequential value which identifies the message uniquely in the database text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:logdb_sessions?rev=1542192349&do=diff LogDB.Sessions table The LogDB.Sessions table contains a record of all 'sessions' logged by VPOP3. A session is something like a POP3 server session as an email client downloads messages, or an SMTP client session as VPOP3 sends a message out to the Internet, and so on. text/html 2023-08-15T07:33:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:loginaudit?rev=1692084838&do=diff loginaudit Database table This contains data showing login attempts within the most recent 30 days * id - incrementing ID of loginaudit entry * ipaddress - IP address the login attempt came from * datetime - the date & time the event occurred text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:mail_tab?rev=1542192349&do=diff Mail tab The Mail tab within VPOP3 webmail enables you to manage your sent and received messages. As you can see from the screenshot, the page is divided into three main sections: Menu bar General tab bar Status bar [Mail tab - VPOP3 Version 5 Webmail] Page structure Mail toolbar The Mail toolbar contains the following buttons: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtpstats_smtpclientfailures?rev=1542192349&do=diff SMTPStats.SMTPClientFailures table The SMTPStats.SMTPClientFailures table contains logging data about errors/usage for the SMTP Services in VPOP3. These are used for the Intrusion Protection facility & logging. Columns * id - sequential ID for the event * ipaddress - the SMTP client's IP address text/html 2023-03-27T10:32:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_routing_script?rev=1679913138&do=diff User Routing Script If there is a <username>/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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_offline?rev=1542192349&do=diff Message Archive -> Offline Tab Settings -> Message Archive -> Offline Tab. The Offline tab lets you tell VPOP3 to move old archived messages to an alternative store, such as CD/DVD or external drive etc. VPOP3 will create a ZIP file containing the old messages. The archive index will still remember the messages, and the name of the ZIP file they are contained in, so you will still be able to search for messages on date, sender, subject, etc, but not on the message content. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_restore?rev=1542192349&do=diff Database -> Restore Tab This tab is only in VPOP3 Enterprise (v5 and later), and is for performing a partial (mailbox/mail folder) restore of the database. To do a full restore of the database, or for VPOP3 Basic/Standard, see the “Restore a Backup of VPOP3” topic Using the 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 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:imap4_advanced?rev=1542192349&do=diff IMAP4 -> Advanced tab This page is reached from Services -> IMAP4 Server, then the Advanced tab. Here are some advanced options for the IMAP4 service in VPOP3 Fake access to inaccessible mailboxes In the IMAP4 service you may have folders which do not exist. For instance, if you are accessing a shared Inbox folder from a user called 'Karen', then their folder will be called text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:listserver_commands?rev=1542192349&do=diff 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. 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: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: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:sent_message_summary?rev=1542192349&do=diff Sent message summary This will display the number of messages sent and total size over the past month. (It counts each recipient as its own message). You must have Historical Logging enabled in VPOP3 (Settings -> Logging) 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:signature_script?rev=1542192349&do=diff 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 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_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 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 2019-08-19T08:58:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:status_monitor_protocol?rev=1566205125&do=diff Status Monitor (port 5109) protocol This page documents the protocol used between VPOP3 and the Status Monitor. It's not intended for any other purpose, so it's a bit limited, but in certain cases you may find this useful Login Before the Status Monitor receives any updates or can issue commands it must log in using a user's credentials. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_advanced?rev=1542192349&do=diff User Advanced settings The Edit User → Advanced tab contains some 'advanced' settings for a VPOP3 user. Message Recycle Bin In VPOP3 Enterprise (v5 and later) the Message Recycle Bin will keep messages in the message store for a short time after the user has deleted the messages. This is to allow easier recovery from the inevitable case where a user has deleted messages by mistake, and wants them back. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getmessages?rev=1542192349&do=diff VPOP3.GetMessages Lua function The Lua management function 'VPOP3.GetMessages' retrieves a table containing all the mail messages in a specified folder. VPOP3.GetFolders(username, folder); * username is the username from VPOP3.GetUsers * folder is the folder from VPOP3.GetFolders It returns a table where the key is the message UID and the value is a table of: 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…