https://wiki.pscs.co.uk/ 2026-05-06T12:36:13+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: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:imap4_server?rev=1542192349&do=diff This page lets you configure the IMAP4 server component of VPOP3. This is used for collecting mail from VPOP3, with all the IMAP4 facilities, such as folder sharing, synchronisation, access from anywhere, etc * General Tab * IP Access Restrictions Tab * Advanced Tab 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:msgaudit?rev=1542192349&do=diff msgaudit Database table This can (optionally) contain data showing how messages have been handled (eg deleted, moved, etc) * id - incrementing ID of msgaudit entry * datetime - the date & time the event occurred * component - which VPOP3 component performed the event text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference: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:diagnostics?rev=1542192349&do=diff Settings -> Diagnostics The Diagnostics page allows you to enable, configure and disable various methods of diagnostic logging, within VPOP3. Log file overview By default, VPOP3 will keep two copies of most log files: * The current log file, with a text/html 2026-03-26T23:49:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_scripting?rev=1774568941&do=diff Lua Scripting Lua is a simple scripting programming language often used for embedding in other applications. VPOP3 uses it to customise behaviour in places where most people will be happy with the default behaviour, but occasionally people will want to do something more complicated. Rather than having lots of extra options to complicate things for most users, we have opted to go for a more flexible scripting facility. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference: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: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_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: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:bandwidth_management_script?rev=1542192349&do=diff Bandwidth Control (VPOP3 Enterprise Only) Every time a connection is made to a VPOP3 service, or a user logs into a service, VPOP3 Enterprise runs a Lua function which can assign the connection a bandwidth pool, or assign a bandwidth limit on the connection. 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_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 2023-08-15T07:33:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:loginaudit?rev=1692084838&do=diff loginaudit Database table This contains data showing login attempts within the most recent 30 days * id - incrementing ID of loginaudit entry * ipaddress - IP address the login attempt came from * datetime - the date & time the event occurred text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:services?rev=1542192349&do=diff Services This page lets you see and manage the services which VPOP3 provides for other programs, such as email clients. These are how users communicate with VPOP3. * General * POP3 Server * SMTP Server * IMAP4 Server (VPOP3 Enterprise Only) * Password Server * Finger Server * LDAP Server * WebMail Server * Status Server * NNTP Server 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 2026-02-19T17:56:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:temporary_files?rev=1771523787&do=diff Temporary Files This is for files in the VPOP3\_temp folder Most of the filename is the hexadecimal timestamp (in Windows 'FILETIME'/65536 form) with a 4 digit hex sequential number afterwards. The first letter or two (usually G-Z) can tell something about what caused the file. 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:vpop3.deletemessage?rev=1542192349&do=diff VPOP3.DeleteMessage Lua function The Lua management function 'VPOP3.DeleteMessage' marks a specified message to be deleted, or removes the deleted flag. Messages marked to be deleted will not be deleted immediately, but only when that mailbox is 'purged' from an IMAP4 client. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getfolders?rev=1542192349&do=diff VPOP3.GetFolders Lua function The Lua management function 'VPOP3.GetFolders' retrieves a table containing all the mail folders for a specified user. VPOP3.GetFolders(username); It returns a table where the key is the folder name (in IMAP4 UTF-7 encoded format - see text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.getmessages?rev=1542192349&do=diff VPOP3.GetMessages Lua function The Lua management function 'VPOP3.GetMessages' retrieves a table containing all the mail messages in a specified folder. VPOP3.GetFolders(username, folder); * username is the username from VPOP3.GetUsers * folder is the folder from VPOP3.GetFolders It returns a table where the key is the message UID and the value is a table of: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.renamefolder?rev=1542192349&do=diff VPOP3.RenameFolder Lua function The Lua management function 'VPOP3.RenameFolder' renames a folder for the specified user. VPOP3.RenameFolder(username, folder, newname); * username is the username from VPOP3.GetUsers * folder is the folder from VPOP3.GetFolders * newname is the new name for the folder.