https://wiki.pscs.co.uk/ 2026-05-06T07:44:57+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: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 2026-01-05T09:25:39+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:password_strength_checking_script?rev=1767605139&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:incoming_smtp?rev=1542192349&do=diff Incoming SMTP Mail If you have an incoming SMTP mail feed, then the mail server sending mail to you will connect to your VPOP3 computer to send the mail. The mail connection is controlled by the sending computer. IMPORTANT If you have a permanent Internet connection with a static IP address, the usual way of having incoming SMTP is to configure your 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 2025-05-08T08:23:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_server_script?rev=1746692615&do=diff SMTP Server Lua Scripting The SMTP Server Lua Script is called SMTPSVR.LUA and can be edited from the Settings -> Scripts page in the VPOP3 settings. This script is called whenever an instance of the VPOP3 SMTP server is launched - ie whenever someone opens a connection to port 25 on the VPOP3 server to send it a message, whether from a local user or an incoming SMTP message. 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 2024-10-29T16:03:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.hmac?rev=1730217799&do=diff VPOP3.HMAC Added in VPOP3 8.7 This function performs a HMAC (Hash-based Message Authentication Code) algorithm on supplied text using the supplied key VPOP3.HMAC(hash algorithm, string, key) The function takes three parameters: * Hash algorithm - 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:message_monitoring?rev=1542192349&do=diff Message Monitoring Message monitoring in VPOP3 will tell VPOP3 to send a copy of all the outgoing, internal and/or incoming mail from/to specified users to be sent to another specified user. In the current versions of VPOP3, all monitored messages are sent to the same user (or list), you cannot specify different recipients for different monitored users. (This may be something that is added/enhanced in the future) 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/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 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 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:scheduling_management_scripts?rev=1542192349&do=diff Scheduling Management Scripts VPOP3 runs a script called scheduler.lua in the background, it will periodically call functions in this script at approximately 1 minute, 5 minute, 1 hour and 1 day intervals. These times are only approximate so should not be relied upon for timing. 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 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 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 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:status?rev=1542192349&do=diff Status The VPOP3 Status screen has two tabs * Server Status * Sessions Server Status The Server Status tab is essentially a copy of the VPOP3 Status Monitor information. * Connection Status - this shows the 'online' status of VPOP3. If it says idle, it does not mean VPOP3 is not working, or not doing anything, it just means that it is not currently sending or collecting mail from the Internet. 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 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lan_forwarding_queue_status?rev=1542192349&do=diff LAN Forwarding Queue Status To view the LAN Forwarding Queue Status, go to Settings -> Local Mail -> LAN Forwarding -> Queue Status The LAN Forwarding Queue shows the messages which VPOP3 has currently got queued to be sent to another mail server on your network using SMTP. The LAN Forwarding Queue status page shows a simple list of the messages waiting to be sent. The four columns in the table show: text/html 2024-10-29T15:59:51+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_hash_functions?rev=1730217591&do=diff Lua Hashing Functions Added in VPOP3 8.7 Four functions have been added to perform hash algorithms on a text string * VPOP3.SHA1(string) * VPOP3.SHA256(string) * VPOP3.SHA512(string) * VPOP3.MD5(string) All functions take a string parameter, and return a table of numbers containing the hash value (one byte per table entry). The length of the returned table are: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_direct?rev=1542192349&do=diff 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 … 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: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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:about?rev=1542192349&do=diff About The VPOP3 'About' page lets you see the version and build number of your VPOP3 installation, along with any licence details, and supplier details (if any) Licence Information The Licence Information section shows your current licence information text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:address_book_tab?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_general?rev=1542192349&do=diff Message Archive -> General Settings -> Message Archive -> General Tab Archive Messages If the Archive Messages box is checked, then VPOP3 will archive incoming and outgoing messages. Main Archive Store Directory You can set the message archive store to any directory accessible by the VPOP3 service. Enter the path in the 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 2022-11-24T09:29:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:attachment_processing_script?rev=1669282143&do=diff Attachment Processing Script (Added in v7.6) This script has functions to allow message attachments to be altered: * NeedsRecode * NeedsRewrite * GetRename * GetContentDispositionLine (added in v7.8) * IsLockNeeded * RewriteAttachment 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: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: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 2019-08-27T16:13:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_monitor_script?rev=1566922420&do=diff Monitor Scripting (Added in V6.15) This script has three functions: * MonitorIncoming * MonitorInternal * MonitorOut The functions are similar, except they are called when different messages are to be monitored (incoming, internal and outgoing messages respectively). text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:mail_collectors?rev=1542192349&do=diff Mail Collectors A Mail Collector is how you tell VPOP3 to collect incoming mail. Each Mail Collector is associated with one or more Connections. The VPOP3 Connector Schedule determines when each Connection is run. Mail Collector General Tab Each Mail Collector has a General text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:management_scripting?rev=1542192349&do=diff Management Scripting In VPOP3 Enterprise, from version 6.17 there is the facility to run Lua scripts manually or according to a schedule. These scripts can do things like access mail folders & messages and perform some maintenance on them. Creating a new script text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:mappings?rev=1542192349&do=diff Mappings In VPOP3, Mappings are a way of explicitly linking an email address to a user or list. They can also be used to indicate that an email address is remote, even though it would otherwise appear to be a local email address. In other email servers, a similar feature may be called 'aliases' text/html 2021-08-09T10:55:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:scheduler_script?rev=1628506507&do=diff Scheduled Task Script Note that this functionality is only available in VPOP3 Enterprise VPOP3 Enterprise can run Lua script periodically to do custom background tasks. It can run a function every minute, 5 minutes, hourly or daily. The Lua script is stored in a file called text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:send_admin_message?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_ids_ips?rev=1542192349&do=diff SMTP Server -> IDS/IPS The IDS/IPS tab lets you set logging and automatic blocking parameters for the IDS (Intrusion Detection System) and IPS (Intrusion Prevention System) component of the SMTP server. SMTP servers are regularly attacked, both by incoming mail attacks (spam/viruses etc) and relay attacks (by spammers and other malware distributors trying to send mail through them). Because of this, there is a system in VPOP3 which will track attack attempts on the SMTP service and can automat… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_reputation_stats?rev=1542192349&do=diff SMTP Reputation Stats (Added in v6.20) If you receive email by direct incoming SMTP (not via an ISP or filtering service) then you can tell VPOP3 to report sender reputation statistics back to VPOP3. This is enabled/disabled in the Settings -> Misc Settings page. 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_longsenderdomain?rev=1542192349&do=diff 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. 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_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_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 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: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:webmail_advanced?rev=1542192349&do=diff Webmail -> Advanced tab This page is reached from Services -> Webmail Server, then the Advanced tab. Here you can set various options for the VPOP3 Webmail/settings service. Allow Password in URL If you check this option, then you can specify the user's password in a 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/reference:admin_settings?rev=1542192349&do=diff 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. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:attachment_extraction_script?rev=1542192349&do=diff 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. 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 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:autoresponders_v3_v4?rev=1542192349&do=diff 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 text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:calendar_calendars?rev=1542192349&do=diff Calendar.Calendars table The Calendar.Calendars table contains a list of all 'calendars' created in VPOP3. Each user account has at least one calendar Columns * calid - this is a integer sequential value which identifies the calendar uniquely in the database * text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lan_forwarding?rev=1542192349&do=diff LAN Forwarding LAN Forwarding is a feature of VPOP3 where it can send messages to another mail server using SMTP. This other mail server is usually on your local network (LAN), hence the name, but it can actually be anywhere that has a permanent network connection to VPOP3. VPOP3 will send messages using text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:logging?rev=1542192349&do=diff Logging Activity Summary Reports You can tell VPOP3 to send you a daily summary report each day. To do this check the box to say Send daily summary logs to, and choose the appropriate user (or “Main Administrator” if you want the reports to be sent to the text/html 2026-02-24T15:49:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_smtp_mx_control?rev=1771948188&do=diff 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: 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:make_lan_forwarding_immediately_attempt_to_dequeue_all_pending_messages?rev=1542192349&do=diff Database query to make LAN Forwarding immediately attempt to dequeue all pending messages If VPOP3 cannot send messages using LAN Forwarding it will queue the message and retry periodically. Usually there is no need to do anything special if there was a problem with the onward mail server which has now been fixed, VPOP3 should soon retry the messages automatically (based on the value of the text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:pop3_server?rev=1542192349&do=diff POP3 Server This page lets you configure the POP3 server component of VPOP3. This is how users collect mail from VPOP3 using a POP3 email client. In VPOP3 Enterprise, you can create multiple POP3 servers with different settings for instance, to allow SSL connections for local users using the older text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:route_by_parsing_message_headers?rev=1542192349&do=diff Route incoming POP3 mail by parsing message headers This routing method is generally used if you have a catch-all or 'multi-catch' mailbox with your Internet provider. With this method, VPOP3 will look at the To/Cc and other fields in the message headers to try to work out who the message is for. If the recipient is not listed in the headers (eg for BCCd mail) it may not be able to automatically detect who the message is for. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:sender_advanced_relay_settings?rev=1542192349&do=diff Mail Sender Advanced Relay Settings SMTP Return Address The SMTP Return Address (or Return Path) is a hidden part of a message which says where bounce messages (and other automated responses) should be sent. (It is not the same as the Reply address text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:sender_direct_settings?rev=1542192349&do=diff 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. 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:smtp_general?rev=1542192349&do=diff SMTP -> General tab This page is reached from Services -> SMTP Server, then the General tab. This page lets you set general settings for the SMTP service component of VPOP3. The SMTP service is how users send outgoing mail, and how incoming SMTP messages arrive. Service Name text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_server?rev=1542192349&do=diff SMTP Server This page lets you configure the SMTP server component of VPOP3. This is how users send mail (either outgoing or internal), and also how VPOP3 receives incoming SMTP messages. In VPOP3 Enterprise, you can create multiple SMTP servers with different settings for instance, to allow SSL connections for local users using the older 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:spam_filter_general?rev=1542192349&do=diff Spamfilter -> General This page has 6 tabs to allow you to configure the VPOP3 spamfilter * General tab * Quarantine Settings tab * Bayesian Database tab * Script Configuration tab * Rule Weights tab * Advanced tab 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:spamfilter_script_configuration?rev=1542192349&do=diff Spamfilter Script Configuration tab You reach this tab by going to Settings --> Spam Filter -> General, and then choose the General tab. The Spamfilter script has various settings that can be changed to alter the behaviour of the spamfilter. These are defined in the script, so may change with different versions of the script. The settings are currently: 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_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_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_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_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_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_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_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_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 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 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_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/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: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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_routing?rev=1542192349&do=diff User Routing Options Assistant The assistant for a user is an email address (or set of email addresses, separated by semicolons) where incoming messages to this user will be copied or redirected. Normally messages will be copied to the assistant, but if the 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:users_autoresponders?rev=1542192349&do=diff Users.Autoresponders table The Users.Autoresponders table contains the users' autoresponder definitions Columns * autoresponderid - this is a numeric id of the autoresponder entry (primary key) * owneruser - this is the numeric id of the user which the autoresponder belongs to (or 0 for a 'template' autoresponder) text/html 2024-10-29T16:06:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.base64?rev=1730217971&do=diff VPOP3.Base64 Added in VPOP3 8.7 This function returns a Base64 string encoding of the supplied parameter VPOP3.Base64(text) or VPOP3.Base64(byte-array) It can be passed either a text string or a table containing one byte per table-entry (eg as returned from the text/html 2024-10-29T16:08:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.hexstring?rev=1730218081&do=diff VPOP3.HexString Added in VPOP3 8.7 This function returns a Hex string encoding of the supplied parameter VPOP3.HexString(text) or VPOP3.HexString(byte-array) It can be passed either a text string or a table containing one byte per table-entry (eg as returned from the 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/reference:webmail_server?rev=1542192349&do=diff Webmail Server This page lets you configure the Webmail server component of VPOP3. This is how users can access their mail through a web browser, access their spam quarantine, and also how administrators configure VPOP3. This page has 5 tabs: * 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.