PSCS Wiki

Spam Filter Rules: ForEach

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Attachment Processing Script

Anonymous (anonymous@undisclosed.example.com) — 2022-11-24T09:29:03+00:00

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

Spam Filter Rules: AddBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: AddBag Statement AddBag Version 2.2.1+ Purpose Adds a value into a 'bag' containing a collection of values, creating the bag if necessary The AddBag statement requires a type, bag name and value, in the format AddBag

Spam Filter Rules: DBInsert

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DBInsert Statement DBInsert Version 6.16+ Purpose Inserts a record into the spam filter database The DBInsert statement requires a type, component name, key and value, in the format DBInsert

Error Handling Scripting

Anonymous (anonymous@undisclosed.example.com) — 2023-11-20T10:18:01+00:00

Error Handling Scripting For most error messages that VPOP3 generates, it allows control of error messages, eg to limit the frequency of error messages if they would be generated repeatedly. These limits are set in Settings -> Admin Settings -> Message Control. However, if you want more granular control, you can use Lua scripting for more fine-grained control

POP3 Client Lua Scripting

Anonymous (anonymous@undisclosed.example.com) — 2023-08-16T07:48:01+00:00

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:

SMTP Server Lua Scripting

Anonymous (anonymous@undisclosed.example.com) — 2025-05-08T08:23:35+00:00

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.

Spam Filter Rules: CopyBag

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: CopyBag Statement CopyBag Version 6.17+ Purpose Copies the contents of one bag into another bag The CopyBag statement requires an operator, “from bag” name and “to bag” name, in the format AddBag

Status

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Autoresponders - v3 and v4

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Copy SMTP Rules - Database Query

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Monitor Scripting

Anonymous (anonymous@undisclosed.example.com) — 2019-08-27T16:13:40+00:00

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).

Mappings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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'

Running database updates within a transaction

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Signature Script

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Signature Script If you want more complex signatures on outgoing emails, rather than the static text/HTML you can define within VPOP3, then you can use a simple Lua script to define the signature. The Lua script is stored in a file called signature.lua

SMTPStats.SMTPClientFailures table

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: DNS

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DNS Statement DNS Version 2.1.11+ Purpose Allows the script to perform an arbitrary DNS lookup, returning the result into a specified variable The DNS statement requires a type, hostname and variable name, in the format DNS

Spam Filter Rules: GetAddressType

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Message Rules

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Access Restrictions Internal Format

Anonymous (anonymous@undisclosed.example.com) — 2023-08-02T08:22:37+00:00

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)

Archive Script

Anonymous (anonymous@undisclosed.example.com) — 2023-03-25T23:33:31+00:00

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.

Mail Sender Advanced Settings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

SMTP Service - Filtering

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Spam Filter Rules: DBQueryOne

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: DBQueryOne Statement DBQueryOne Version 6.16+ Purpose Queries the spam filter database for a single record/aggregate The DBQueryOne statement performs a query on the spam filter database and returns a single value which is either the value of a record or an aggregate of several records.

Spam Filter Rules: StartDNS

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: StartDNS Statement StartDNS Version 2.2.1+ Purpose Begins an asynchronous DNS lookup in advance of the result being required in a subsequent DNS statement The StartDNS statement requires a type and hostname, in the format StartDNS

Status Monitor (port 5109) protocol

Anonymous (anonymous@undisclosed.example.com) — 2019-08-19T08:58:45+00:00

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.

Database query to alter LAN Forwarding rules for one server to go to another

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Database query to alter LAN Forwarding rules for one server to go to another

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Settings -> Attachment Processing

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Bandwidth Control

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Delete list member from all lists

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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')

Settings -> Diagnostics

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Database query to export LAN Forwarding rules

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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;

Find biggest messages

Anonymous (anonymous@undisclosed.example.com) — 2019-07-08T08:19:02+00:00

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;

Database query to find forwards/assistants etc in user settings

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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%';

Find a message

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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')

Database query to get all lists and members

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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;

Import Users From File

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Import Users From File VPOP3 supports the importation and exportation of users, via a CSV file (see for a specification of the CSV file format). NOTE: This process is not designed to provide a complete backup of user data, nor is it intended to facilitate moving VPOP3 to a new computer. Instead, see the following relevant pages:

Database query to list ALL messages in the LAN forwarding queue

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Database query to list failed message sends

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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;

Database query to list messages in the LAN forwarding queue waiting to go to a specific server

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Lists

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

LogDB.Recipients table

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

LogDB.Recipients table The LogDB.Recipients table contains a record of the recipients for messages logged by VPOP3. A message may have one or more recipients Columns * rcptid - this is a bigint sequential value which identifies the recipient uniquely in the database

LogDB.Sessions table

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

LogDB.Sessions table The LogDB.Sessions table contains a record of all 'sessions' logged by VPOP3. A session is something like a POP3 server session as an email client downloads messages, or an SMTP client session as VPOP3 sends a message out to the Internet, and so on.

Mail Connectors -> Mail Senders

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Database query to make LAN Forwarding immediately attempt to dequeue all pending messages

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spamfilter Quarantine Viewer

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spamfilter Quarantine Viewer Settings -> Spamfilter -> Quarantine Viewer The Quarantine Viewer lets you see messages which have been quarantined by the VPOP3 Spam Filter. As an administrator you can see quarantined messages for any user, and release them if appropriate. If you release a message, it will be sent into the original recipient's Inbox, not into your Inbox.

Reset Message Folder Counts

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

Sent message summary

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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

Spam Filter Rules: Comments

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spam Filter Rules: Comments In the spam filter scripts, blank lines are ignored. Any line beginning with a # character is treated as a comment. Comments must be on a line of their own; there is no way to add a comment to the end of a line. Examples

Spamrules example - increase spam score if there are many links in the email

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

Spamrules example - increase spam score if there are many links in the email This script is for the case where you to increase the spamminess of emails where the email contains many links - in this case we'll say if the email contains 10 or more links. Note that we do not necessarily recommend that you do this as it is not a very good indicator of spam, and will probably catch a lot of newsletter type emails, but it is something we've been asked for, so here it is.

Autoresponder

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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'…

Using tables/grids

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…

Database query to view password change history

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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;

Webmail Tabs

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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.

What's new in version 5 webmail?

Anonymous (anonymous@undisclosed.example.com) — 2018-11-14T10:45:49+00:00

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…