https://wiki.pscs.co.uk/ 2026-05-06T06:47:16+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:spamrules_db_comparator?rev=1542192349&do=diff Spamfilter database comparators Several Spamfilter DB statements allow comparators which are listed below If the value specified in the statement is numeric: * = or == compare numeric values for equality * <> or != compare numeric values for inequality text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:schedule?rev=1542192349&do=diff Mail Connectors -> Connector Schedule The Connector Schedule tells VPOP3 when to connect to send mail using Mail Senders and collect mail using Mail Collectors. It does not affect incoming SMTP over a permanent connection, or LAN Forwarding. The connection schedule also tells VPOP3 when to check for updates to the 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: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 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_dns?rev=1542192349&do=diff Misc -> DNS Tab Settings -> Misc Settings -> DNS The DNS tab lets you specify which DNS servers VPOP3 will use. DNS (Domain Name System) is a system which converts Internet host names (eg www.google.com) into a numeric IP address (eg 1.2.3.4), because all connections on the Internet are actually performed using numeric IP addresses, but it is easier for people to remember names. 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_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_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: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: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: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:mail_senders?rev=1542192349&do=diff Mail Connectors -> Mail Senders The Mail Sender tells VPOP3 how to send mail out to the Internet. If you want to send mail for specific users to another specific mail server (e.g. a local Microsoft Exchange Server or another VPOP3 server) then use the 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 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/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: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 2023-08-02T08:22:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:access_restrictions_internal_format?rev=1690964557&do=diff Access Restrictions Internal Format VPOP3 internally stores service IP Access Restrictions in its settings database using the following format to encode the multiple entries These are stored in the settings database as *ALLOWED*.DAT (using VPOP3SETTINGS GET *ALLOWED*.DAT will list them) 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:connections?rev=1542192349&do=diff Connections In VPOP3 a Connection tells VPOP3 how to 'connect' to the Internet. VPOP3 supports up to 10 Connections, which can be either network connections or Dial-Up connections (using a modem) A Connection is linked to one Mail Sender and zero or more Mail Collectors. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_backups?rev=1542192349&do=diff Database -> Backups Tab The Backups tab lets you specify how VPOP3 will make its daily backup of its database. We strongly recommend that you backup the database regularly in case of disk problems or file corruption. You can use the VPOP3 backup feature, or manually backup the PostgreSQL database using the pg_dump command, or use another program to backup the PostgreSQL database if you wish. Note that a simple disk copy will 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:find_message?rev=1542192349&do=diff Find a message If you know the subject of a message, you can search the entire message store for messages with this subject. Go to Settings → Database → Query Alternatively, at a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:global_signature?rev=1542192349&do=diff Global Signature You can set a Global Signature in VPOP3 by going to Settings -> Global Signature The Global Signature option lets you tell VPOP3 to add a standard piece of text or HTML to the bottom of all outgoing messages. You can create just a plain text, or 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 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:list_all_messages_in_lan_forwrding_queue?rev=1542192349&do=diff Database query to list ALL messages in the LAN forwarding queue 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 may help in that situation. 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 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 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:misc_general?rev=1542192349&do=diff Misc -> General Tab VPOP3 Host Name The VPOP3 Host Name is used by VPOP3 when it is telling other mail software what it is called. For instance, when it connects to another SMTP server it will send the host name as the parameter for the HELO or EHLO command, and when an SMTP client connects to VPOP3, it announces its name in the welcome banner as required by the SMTP standard. 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:reset_message_folder_counts?rev=1542192349&do=diff Reset Message Folder Counts In extremely rare cases, the mail folder message counts in the database may get out of step with the actual stored messages. There are database triggers which will keep the counts in sync during normal operation, but if you have to manipulate the database directly (eg to recover from a corrupted database) it is possible that they will get out of step. 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: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:status_monitor?rev=1542192349&do=diff VPOP3 Status Monitor The VPOP3 status monitor allows users to see what VPOP3 is doing, and also, optionally, to send/receive simple 'instant messages' between local users. Different users can have different permissions for the status monitor. They can be set for all administrators or non-administrators on 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 2024-04-22T08:37:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_manager_script?rev=1713775058&do=diff User Manager Script If you want people to be able to log in using a different username than their VPOP3 username (eg if you want them to be able to log in using an email address), then you can use the UserManager Lua script The Lua script is managed through the Settings → Scripts page in VPOP3 v8.0 and later and is called 'UserManager.LUA. 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: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 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: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 2023-03-25T23:33:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_script?rev=1679787211&do=diff Archive Script (from VPOP3 v6 onwards) Archive scripting lets you indicate whether full message content should be stored in the message archive. This could be used, for instance, for filtering out messages containing credit card details. The message headers will still be archived, along with the explanation text returned by the script. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:archive_search_results?rev=1542192349&do=diff Message Archive -> Results Tab Settings -> Message Archive -> Results tab The Results tab only exists if you have previously done a search operation and are viewing the results of that search. The Results page shows you a list of the messages (up to 1000 entries are available) returned by the search. You can select multiple entries by using shift+click or ctrl+click text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_files_used_in_vpop3_2.x?rev=1542192349&do=diff Database files used in VPOP3 2.x VPOP3 2.x usually uses SQLite 2.8.3 as its database engine. This stores databases in discrete *.db files in the VPOP3\_database directory on the server PC. We do not recommend that you access these databases directly unless you know what you are doing, and we strongly discourage the alteration of data in the databases directly unless technical support request you to. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:database_message_store?rev=1542192349&do=diff Database -> Message Store Tab This tab says how VPOP3 handles its message store Message Store The Delay while moving messages setting tells VPOP3 how quickly to import messages into the new database structure if it was upgraded from version 2.x or earlier. Usually this is OK to be left as it is, but if there is some special requirement to import the messages more quickly, you can decrease this number, but that will increase the load on the server. 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: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 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 2019-07-08T08:19:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:find_biggest_messages?rev=1562573942&do=diff Find biggest messages To find the 10 biggest messages in your VPOP3 message store: Go to Settings → Database → Query Alternatively, at a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type SELECT username, folder, subject, fromaddr, PG_SIZE_PRETTY(size) FROM messages.messages INNER JOIN messages.folders f USING(folderid) INNER JOIN users.users u ON u.usernumber=f.userid ORDER BY size DESC LIMIT 10; text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:find_forwards_assistants_etc?rev=1542192349&do=diff Database query to find forwards/assistants etc in user settings Go to Settings -> Database -> Query Alternatively, at a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type select username,dataname,datavalue from users.usersettings inner join users.users using(usernumber) where datavalue ilike '%searchname%'; text/html 2025-06-23T10:51:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:imap4_server_script?rev=1750675906&do=diff IMAP4 Server Scripting (Added in V6.12) DoCapability function When the IMAP4 CAPABILITY command is received, VPOP3 generates a capability string based on settings, then calls DoCapability(ipaddr, capabilities) * ipaddr = IP address of the client computer text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:list_failed_message_send_summary?rev=1542192349&do=diff Database query to list failed message sends This will list failed outgoing messages from the last 3 days (with the default VPOP3 settings) At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type select created,returnpath,subject,username || '@' || domain as recipient, latesterror from outqueue.outrecipients inner join outqueue.outmessages using(msgid) where failedtime is not null order by created desc; 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: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: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: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:message_archive?rev=1542192349&do=diff Message Archive The Message Archive facility is for VPOP3 to store copies of all messages sent or received. It stores the messages in a central archive store which can be searched by an administrator. The prime purpose of the archive facility is for recording messages in case of possible disputes, as you can see what was sent/received by email. It can also be used as a backup/restore facility in an emergency, but that is not its prime purpose, so it is better to have a proper text/html 2021-11-29T12:06:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:password_lengths?rev=1638187584&do=diff Password Lengths If you want to do an audit of users' password lengths, then go to Settings -> Database -> Queries and run this query: SELECT username,LENGTH(DECODE(SUBSTRING(datavalue FROM 2),'base64')) FROM users.usersettings INNER JOIN users.users USING(usernumber) WHERE dataname='mainpassword'; 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:pop3_general?rev=1542192349&do=diff POP3 Server -> General Tab Services -> POP3 Server -> General tab This page sets the general settings for the POP3 service component in VPOP3. The POP3 service is how users collect their email from VPOP3 using a POP3 email client Service Name The Service Name is a name you give the service for your reference. It is only used in administrative displays and logging, so the name doesn't matter. Most people leave it at the default. 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:running_database_updates_within_a_transaction?rev=1542192349&do=diff Running database updates within a transaction This is a trick which database experts use, because they have learned (often the hard way) that a simple mistype can trash a database... Before running any database query which can alter the database (UPDATE, DELETE, INSERT, DROP, CREATE, ALTER) begin a database transaction using the 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: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: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_load_limiting?rev=1542192349&do=diff SMTP -> Load Limiting tab This page is reached from Services -> SMTP Server, then the Load Limiting tab. Here you can set limits on how many active SMTP sessions there are, and other related settings. This lets you limit the load on the VPOP3 server. This is especially important if VPOP3 is performing spam filtering on incoming SMTP messages, because the spam filter can add considerable load. You can reduce the spamfilter load by using the 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: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: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: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 2022-01-25T11:59:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_ipwhitelist?rev=1643111967&do=diff Allow messages through from a specific IP address This script allows messages through the spam filter if they arrive at VPOP3 from a specific SMTP sender (only when the message is sent directly to VPOP3 using SMTP, not via another server). Add the following to the spamrules_userlocal.txt file. This script file gets processed on all messages. 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_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_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_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_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_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_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_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_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_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: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 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 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/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:using_tables?rev=1542192349&do=diff Using tables/grids Many VPOP3 settings pages use grids to show you a set of data, for instance on the Users, Mappings and Lists pages. These have several standard features which are described below. * Most of the grids are 'delayed-fill'. This means that they don't fill up with data immediately when the page is loaded, this is to speed up the page load times. Only the first (visible) section of the grid is filled at first (sometimes there may be a short delay before this is filled, if the da… 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:vpop3.getmessagelines?rev=1542192349&do=diff VPOP3.GetMessageLines The Lua function 'VPOP3.GetMessageLines' retrieves content lines from the message currently being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: * number - number of lines to retrieve 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 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.