https://wiki.pscs.co.uk/ 2026-05-13T05:08:51+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: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: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: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: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:batch_file_to_end_a_database_backup?rev=1542192349&do=diff Batch file to end a database backup VPOP3 runs pg_dump.exe to perform the regular database backups. Ending this process through Task Manager will not end the back-end database processes creating the backup data. This batch file will do it for you. text/html 2026-03-16T11:12:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:group_a_user_s_folders_into_letter_groups?rev=1773659562&do=diff Group a user's folders into letter groups This is useful in VPOP3 Enterprise if you have a large folder with many subfolders and want to group the subfolders into other subfolders based on their first letter For example, if you have * Customers 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 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:alter_lan_forwarding_queued_messages_going_to_one_server_to_go_to_another?rev=1542192349&do=diff Database query to alter LAN Forwarding rules for one server to go to another If a LAN forwarding destination server fails, you may wish to change the queued messages to go to the new server. (Note that, if planning ahead, it may be easier to use DNS text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:alter_lan_forwarding_rules_for_one_server_to_go_to_another?rev=1542192349&do=diff Database query to alter LAN Forwarding rules for one server to go to another If a LAN forwarding destination server fails, you may wish to change the LAN forwarding rules to point to the new server. (Note that, if planning ahead, it may be easier to use text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference: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:delete_list_member_from_all_lists?rev=1542192349&do=diff Delete list member from all lists You can delete an email address from all VPOP3 distribution & mailing lists. 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:diagnostics?rev=1542192349&do=diff Settings -> Diagnostics The Diagnostics page allows you to enable, configure and disable various methods of diagnostic logging, within VPOP3. Log file overview By default, VPOP3 will keep two copies of most log files: * The current log file, with a text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:export_lan_forwarding_rules?rev=1542192349&do=diff Database query to export LAN Forwarding rules At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type \copy (select conditions, address, server, username, password, outaddress as rewriteaddress, matchcount as matches from rules.lanforwarding order by ruleorder) to 'c:/temp/x.csv' csv header; text/html 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 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:get_all_lists_members?rev=1542192349&do=diff Database query to get all lists and members At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type \copy (select l.name, address from users.listmembers m inner join users.lists l on m.list=l.id) to 'c:/temp/x.csv' csv header; 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_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:list_messages_in_lan_forwrding_queue_waiting_to_go_to_a_specific_server?rev=1542192349&do=diff Database query to list messages in the LAN forwarding queue waiting to go to a specific server The VPOP3 settings show the first 100 messages in the LAN forwarding queue. Usually this is sufficient as the LAN forwarding queue is usually nearly empty, but in case of a problem it may be much bigger. The database queries below let you list just messages going to a specific server. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:listserver_settings?rev=1542192349&do=diff ListServer Settings Settings -> ListServer Settings In VPOP3, the ListServer is an automated 'user' which handles mailing list requests, such as subscribe & unsubscribe commands. Anyone can send an email to the ListServer to subscribe to (public) mailing lists, or unsubscribe from mailing lists they are on, or see a list of public mailing lists etc. 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: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 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 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: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: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: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: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: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_goto?rev=1542192349&do=diff Spam Filter Rules: Goto Statement Goto Version 2.1.7+ Purpose A mechanism for directing the script towards a specified label The Goto statement requires a label name, in the format Goto <label name> Labels are single word entries that appear on a line of their own, immediately preceded by the colon (:) character. The colon character is not part of the label name. text/html 2023-03-27T10:32:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_routing_script?rev=1679913138&do=diff User Routing Script If there is a <username>/user_redirect.lua script, this Lua script can override VPOP3's message routing options. You can edit this either in the Settings -> Scripts page in the settings, or via the 'Routing' tab in the user's settings in the VPOP3 administration console. This script affects how VPOP3 will handle how messages text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:view_password_change_history?rev=1542192349&do=diff Database query to view password change history At a command prompt in the VPOP3 directory run psql (The password is 'vpop3pass') Then, type select username,updateuser,updatetime from settingaudit inner join users.users on keyfield=usernumber::varchar where tablename='users.usersettings' and keyfield2='mainpassword' order by updatetime desc; 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…