https://wiki.pscs.co.uk/ 2026-05-13T08:44:46+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:autoresponder_commands?rev=1542192349&do=diff Autoresponder Commands This article only applies to VPOP3 v4 and earlier A VPOP3 autoresponder can contain special text strings to create special behaviour, in addition to plain text as part of the response. There are three types of 'command' * text/html 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/how_to:vpop3_access_security?rev=1542192349&do=diff How To Setup VPOP3 Service Security VPOP3 can be configured to restrict access to its various services depending on the client computer's IP address. This is useful if you want to allow access from only certain IP addresses (eg within your LAN) and prevent access from other IP addresses (eg the Internet). text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:download_rules?rev=1542192349&do=diff Download Rules Download rules are a facility in VPOP3 where it can look at message summary information before downloading a message from an ISP POP3 mailbox (they do not work on incoming SMTP messages - use SMTP Rules for that) To edit download rules, go to text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:using_vpop3_spam_filtering_with_lan_forwarding?rev=1542192349&do=diff Using VPOP3 Spam Filtering with LAN Forwarding When using the VPOP3 Spam filter with LAN forwarding you need to be aware a bit of how it works. The spam filter will only quarantine messages which are going to a VPOP3 user. This is because that user needs to be able to log into VPOP3 to be able to view their quarantined messages. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:listserver_commands?rev=1542192349&do=diff ListServer Commands The ListServer is an automated process in VPOP3 which manages mailing lists. People can send commands to the ListServer to perform various functions remotely. Whether these commands are allowed, and exactly how they work depends on the particular mailing list's settings. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addheader?rev=1542192349&do=diff Spam Filter Rules: AddHeader Statement AddHeader Version 2.1.7+ Purpose Allows you to add, replace or remove the specified header line in the message headers The AddHeader statement requires the full header line in one continuous string, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dbupdate?rev=1542192349&do=diff Spam Filter Rules: DBUpdate Statement DBUpdate Version 6.16+ Purpose Updates a record in the spam filter database The DBUpdate statement requires a component name, key, operator and value, in the format DBUpdate <component name> <key> <operator> <value> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_autoresponder?rev=1542192349&do=diff Autoresponder An autoresponder is a way of automatically replying to messages as they arrive in a user's mailbox. In VPOP3, an incoming message must arrive in a user's mailbox for the autoresponder to trigger. If you use forwards, assistants, mappings, etc to divert a message before it arrives in the mailbox, the autoresponder will never trigger. If you want to use an autoresponder, but not keep the original message, then make sure the message arrives in the mailbox (eg by using an 'Assistant'… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpidsevents?rev=1542192349&do=diff SMTPIDSEvents Replacement Use: ~smtpidsevents~ This returns the latest entries from the SMTP client logging database. It will return 100 entries unless the count parameter is specified in the URL, in which case that will specify the maximum number of entries to return. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:version_5_webmail_api?rev=1542192349&do=diff Version 5 Web Mail API This section is only relevant for people who may want to access the WebMail features from their own scripts, or want to customise the standard Webmail pages. Note that no free support is available for this. This is not a full list of features, but it will be updated from time to time. 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:security_intrusion_protection?rev=1542192349&do=diff Security Settings -> Intrusion Protection Tab Settings -> Security Settings -> Intrusion Protection Tab Starting in VPOP3 v6.0, VPOP3 can monitor failed logins for all accounts across all services and block an attacker's IP address from accessing VPOP3 for a specified time 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: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/adminapi:userqueuemessage?rev=1542192349&do=diff UserQueueMessage Replacement Use: ~userqueuemessage~ Required parameter: Account, Msgid Optional parameter: Folder ('Inbox' is used if not specified) You can also use the :<max size> modifier to set the maximum size of the response. If none is specified then a maximum size of 1000 characters is used. (e.g. use **~userqueuemessage:10000~) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:version_5_webadmin_api?rev=1542192349&do=diff Version 5 Web Admin API This section is only relevant for people who may want to access the Administration features from their own scripts, or want to customise the standard administration pages. Note that no free support is available for this. This is not a full list of features, but it will be updated from time to time. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:french_webmail_language_file?rev=1542192349&do=diff French Webmail Language File Copy/paste the text below to a file 'french.lng' or 'francais.lng' in the VPOP3 directory. (French users, feel free to update/correct the text below) #login page logintitle=VPOP3 Login webadminlogin=web admin login webmaillogin=web mail login enterusername=You must specify your VPOP3 username here bookmarksnotsupported=I'm sorry, but your web browser does not support this function. You will have to add this page to your bookmarks manually. loginfailed=Login Faile… text/html 2026-04-06T17:57:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:make_vpop3_redownload_messages_from_isp?rev=1775498220&do=diff How to make VPOP3 re-download POP3 messages from the ISP If you have the VPOP3 Mail Collector setting Leave Mail On Server enabled, then VPOP3 will leave your messages on the ISP POP3 server for the specified number of days after downloading it. If, during this time, you want to make VPOP3 download those messages again, then you can do so. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:autoresponderconditionlist?rev=1542192349&do=diff AutoresponderConditionList Replacement Use: ~autoresponderconditionlist~ Required parameter: responderid - the ID of the autoresponder This returns a JSON structure containing an array of the rules associated with the specified autoresponder. The return structure is an array of objects containing: 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: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: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:spamrules_statement_getaddresstype?rev=1542192349&do=diff Spam Filter Rules: GetAddressType Statement GetAddressType Version 2.4.6+ Purpose Analyses a specified email address and reports what 'type' of address it is The GetAddressType statement requires an email address and variable name, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_surbl?rev=1542192349&do=diff Spam Filter Rules: SURBL Statement SURBL Version 2.1.7+ Purpose Allows a SURBL lookup on the specified hostname or IP address in the specified SURBL zone, and returns the result into the specified variable The SURBL statement requires a hostname, SURBL zone and 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/adminapi:userrulelist?rev=1542192349&do=diff UserRuleList Replacement Use: ~userrulelist~ <format string> ~end~ Required parameter: Account This returns the message rule list (in order) for the specified user The format string can have the replacements * id - numeric ID of the rule * order - numeric order number (1-n) of the rule text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:10047?rev=1542192349&do=diff Socket Error 10047 - Addresses in the specified family cannot be used with this socket Meaning: Addresses in the specified family cannot be used with this socket This error only normally occurs during VPOP3 startup. There are two main possible reasons for this error: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:10061?rev=1542192349&do=diff Socket Error 10061 - The attempt to connect was forcefully rejected Error 10061 means that the computer which VPOP3 was trying to connect to (probably at your ISP) refused the connection from the computer running VPOP3. There are several possibilities that can cause error 10061: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:configure_a_router_to_allow_incoming_smtp?rev=1542192349&do=diff Accepting Incoming SMTP through a router If your ISP is providing you with an SMTP mail feed (incoming SMTP) and you have VPOP3 connecting to the ISP through a router then you will probably need to modify the router configuration to allow this. Most routers' default configuration will only allow outbound connections (ie connections from the local network out to the Internet). If you need to accept incoming SMTP mail, then you need to tell the router to allow inbound connections on port 25 for … text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:exchange_2003?rev=1542192349&do=diff Setting up VPOP3 to work with Exchange 2003 The instructions below are for Exchange Server 2003. For other versions of Exchange see here. You can link VPOP3 to Exchange Server, so that Exchange Server sends outgoing mail through VPOP3 and VPOP3 sends any incoming mail directly to Exchange Server. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:exchange_2007?rev=1542192349&do=diff Exchange 2007 You can link VPOP3 to Exchange Server, so that Exchange Server sends outgoing mail through VPOP3 and VPOP3 sends any incoming mail directly to Exchange Server. You should first of all set up VPOP3 to send and receive Internet email as normal. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:forwarded_emails_not_arriving?rev=1542192349&do=diff Forwarded Emails Not Arriving If you are having problems having VPOP3 forward incoming messages to an external address, but sending messages directly to that address works OK, and forwarding internal messages to that address works OK, then the problem may be the SMTP return address which VPOP3 is using. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:german_webmail_language_file?rev=1542192349&do=diff German Webmail Language Page Copy/paste the text below to a file 'german.lng' in the VPOP3 directory. (German users, feel free to update/correct the text below) #login page logintitle=VPOP3 Login webadminlogin=web admin login webmaillogin=Webmail Anmeldung enterusername=Sie m&uuml;ssen einen Benutzernamen angeben bookmarksnotsupported=I'm sorry, but your web browser does not support this function. You will have to add this page to your bookmarks manually. loginfailed=Anmeldung fehlgeschlagen … text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:restore_folder_-_v5?rev=1542192349&do=diff Restore selected mail folders or mailbox in VPOP3 v5 or later (This option is only available in VPOP3 Enterprise) First - if the problem is that messages were deleted very recently (the default is within 3 days), you can probably use the Undelete feature in VPOP3. 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:message_monitoring?rev=1542192349&do=diff Message Monitoring Message monitoring in VPOP3 will tell VPOP3 to send a copy of all the outgoing, internal and/or incoming mail from/to specified users to be sent to another specified user. In the current versions of VPOP3, all monitored messages are sent to the same user (or list), you cannot specify different recipients for different monitored users. (This may be something that is added/enhanced in the future) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference: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 2024-03-21T10:49:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:outgoing_message_script?rev=1711018194&do=diff Outgoing Message Scripting Every time VPOP3 adds a message to the Outgoing mail queue, it runs a script called outmessage.lua. Scripts are stored as files in the VPOP3 directory in VPOP3 v6.6 and earlier, or managed through the Settings -> Scripts page in VPOP3 v6.7 and later. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_advanced?rev=1542192349&do=diff SMTP Service -> Advanced Tab Services -> SMTP Server -> Advanced Tab Refuse SMTP Connections from This setting should be rarely needed, and should be normally left blank. It is here for historic purposes. If you put some text in this box, then VPOP3 will refuse any SMTP connections from clients whose 'HELO'/'EHLO' command data contains the text specified here as a substring. Eg, if this setting is set to '.myisp.com', then VPOP3 would refuse SMTP connections from any client which sends the c… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_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 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_dns?rev=1542192349&do=diff 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 <type> <hostname> <variable name> 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_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_reject?rev=1542192349&do=diff Spam Filter Rules: Reject Statement Reject Version 2.4.5+ Purpose Perform an SMTP 'Reject' on the incoming message The Reject statement requires an error code/text string, in the format Reject <error string> This will reject the current SMTP message with the specified SMTP result code. Use a 4xx error code (eg 450) to reject the message temporarily, or a 5xx error code (eg 550) to reject the message permanently. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_replace?rev=1542192349&do=diff Spam Filter Rules: Replace Statement Replace Version 2.3.5+ Purpose Replaces specified text in the specified variable with new text Replace statements require a variable name, a search value and a replacement string, in the format Replace <variable> <search> <replace> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_advanced?rev=1542192349&do=diff User Advanced settings The Edit User → Advanced tab contains some 'advanced' settings for a VPOP3 user. Message Recycle Bin In VPOP3 Enterprise (v5 and later) the Message Recycle Bin will keep messages in the message store for a short time after the user has deleted the messages. This is to allow easier recovery from the inevitable case where a user has deleted messages by mistake, and wants them back. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.messageseek?rev=1542192349&do=diff VPOP3.MessageSeek The Lua function 'VPOP3.MessageSeek' sets an internal read pointer to the specified location of the message being processed This function is only available in the ProcessMessage function of the POP3CLT.LUA or SMTPSVR.LUA scripts. It takes one parameter: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgauth?rev=1542192349&do=diff OutMsgAuth Replacement Use: ~outmsgauth~ Required parameter: MsgID This returns the authenticated sender (if any) of the specified message in the VPOP3 out queue. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsghold?rev=1542192349&do=diff OutMsgHold Replacement Use: ~outmsghold~ Required parameter: MsgID This returns whether the specified message in the VPOP3 out queue is held or not (1 or 0 respectively) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgip?rev=1542192349&do=diff OutMsgIP Replacement Use: ~outmsgip~ Required parameter: MsgID This returns the sender IP address of the specified message in the VPOP3 out queue. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgrecipients?rev=1542192349&do=diff OutMsgRecipients Replacement Use: [~outmsgrecipients~] Required parameter: MsgID This returns a JSON array containing details on the recipients for the specified message in the VPOP3 out queue. There is one object returned per recipient, and the object is: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:outmsgretpath?rev=1542192349&do=diff OutMsgRetPath Replacement Use: ~outmsgretpath~ Required parameter: MsgID This returns the return path of the specified message in the VPOP3 out queue text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientallowadd?rev=1542192349&do=diff SMTPClientAllowAdd Action (VPOP3 Enterprise Only) This adds an entry to the SMTP Client Allow list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientallowremove?rev=1542192349&do=diff SMTPClientAllowRemove Action (VPOP3 Enterprise Only) This removes an entry to the SMTP Client Allow list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientblockadd?rev=1542192349&do=diff SMTPClientBlockAdd Action (VPOP3 Enterprise Only) This adds an entry to the SMTP Client Block list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:smtpclientblockremove?rev=1542192349&do=diff SMTPClientBlockRemove Action (VPOP3 Enterprise Only) This removes an entry to the SMTP Client Block list. The data specified is: * IPAddress - the IP address to add. This can be an individual IP address or a CIDR address (IPv4 and IPv6 addresses are allowed) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleactions?rev=1542192349&do=diff UserRuleActions Replacement Use: ~userruleactions~ <format string> ~end~ Required parameter: Account, RuleId This returns the message rule actions for the specified rule The format string can have the replacements * id - numeric ID of the action * type - action type text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleactionupdate?rev=1542192349&do=diff UserRuleActionUpdate Replacement Use: ~userruleactionupdate~ Required parameter: * Account * RuleId * gr_id - action ID * !nativeeditor_status - inserted/deleted/updated * type * data This inserts/updates/deletes the specified message rule action text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleconditions?rev=1542192349&do=diff UserRuleConditions Replacement Use: ~userruleconditions~ <format string> ~end~ Required parameter: Account, RuleId This returns the message rule conditions for the specified rule The format string can have the replacements * id - numeric ID of the condition text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleconditionupdate?rev=1542192349&do=diff UserRuleConditionUpdate Replacement Use: ~userruleconditionupdate~ Required parameter: * Account * RuleID * gr_id - condition ID * !nativeeditor_status - inserted/deleted/updated * matchi (1/0) * matchn (1/0) * match * field * data text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/adminapi:userruleupdate?rev=1542192349&do=diff UserRuleUpdate Replacement Use: ~userruleupdate~ Required parameter: * Account * gr_id - rule ID * !nativeeditor_status - inserted/deleted/updated * name * all * type This inserts/updates/deletes the specified message rule The return value is an XML tag: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/faq:website_login?rev=1542192349&do=diff How do I login to the PSCS website? You can access your licence details and invoices on the www.pscs.co.uk website. To log into the website click the Login button at the top right of the website. You will log in using the email address you specified linked to your account (usually the email address you used when placing your order) and your password. The password is initially randomly generated and emailed to you with your invoice(s). If you have not received the password, or have forgotten i… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:421_4.3.2_vpop3_too_many_connections_from_your_ip_address_-_try_later?rev=1542192349&do=diff 421 4.3.2 VPOP3 Too many connections from your IP address - try later If you see this error message when you are sending messages, then it means that VPOP3 has detected too many simultaneous connections from your IP address. This would usually happen if the sender is another mail server as they can make many simultaneous connections when there are lots of messages to send. The error code that VPOP3 gives means that the sender should try sending the messages later, so it should be possible to e… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:10048?rev=1542192349&do=diff Socket Error 10048 - Specified Address Already in Use This error only normally occurs during VPOP3 startup. It occurs if some other software running on the same machine as VPOP3 is using one of the ports that VPOP3 is already using. This could be a proxy like WinGate, WinProxy or anti-virus software that acts as a proxy, an LDAP server (e.g. Active Directory) or another mail server program (e.g. Exchange Server). The latter two causes are particularly common on text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:10049?rev=1542192349&do=diff Socket Error 10049 - The specified address is not available from the local computer This error normally means that you have entered an invalid address on the IP Address to Bind To entries on the Services page in the VPOP3 settings. The addresses entered here should be either text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:automatically_forwarding_spam_to_the_pscs_spamtraps?rev=1542192349&do=diff How to automatically forward spam to the PSCS spamtrap Spam filter companies use “spamtraps” to catch samples of spam for analysis so filters can be updated. We do this here as well. Most types of spam are already caught by our spam traps, however sometimes people get lots of spam which gets through the filter because their particular type of spam does not currently get sent to our spam traps. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:custom_filtering_incoming_mail?rev=1542192349&do=diff Custom filtering incoming mail If you want to filter incoming mail using custom rules there are a few ways of doing this, depending on your exact requirements. * Download rules - if your incoming mail is via POP3 collection, you want to filter on headers, size etc (not contents) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:data_stream_contained_nul_character?rev=1542192349&do=diff Data stream contained NUL character Description of the problem NUL characters (bytes with value 0) are not allowed in email messages and should not be transmitted over POP3, SMTP or IMAP4 except in certain circumstances. If an attachment contains such a byte it must be encoded using text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:err_unknown_user?rev=1542192349&do=diff -ERR Unknown User -ERR Unknown User is a POP3 error. There are two places you can receive it: * If you receive it as part of a 'POP3 Client Error' email message from VPOP3, then it means that VPOP3 was unable to log on to your ISP's mail server because the ISP POP3 server reported an error text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:how_to_tell_vpop3_some_users_in_the_local_domain_are_not_to_be_handled_by_vpop3?rev=1542192349&do=diff How to tell VPOP3 that some users in the local domain are not to be handled by VPOP3 In some situations you will have a situation where most of your users are handled by VPOP3, but several users will collect their mail directly from a separate POP3 account on your ISP, even though they may have an email address on the same domain as other users. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:no_transport_provider_is_available?rev=1542192349&do=diff Outlook/Windows Messaging reports "No transport provider is available" If Outlook or Windows Messaging reports No transport provider is available when trying to connect to VPOP3, it can mean several things. (This must be a contender for “the world's most meaningless error message text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:obtaining_error_logs?rev=1542192349&do=diff How to Obtain Error Logs As part of diagnosing a support issue our support team may ask you to send them various log files. This page explains how to obtain the right files at the right time. How Logging Works Under its default settings VPOP3 logs a minimal amount of information about what it is doing to various files in the main VPOP3 directory. When investigating a support issue it is often the case that we will need you to switch on logging to extra files or increase the level of detail be… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:ping_test?rev=1542192349&do=diff The ping command is a useful way of diagnosing network problems. It's similar to the sonar ping in a submarine. It sends out a signal to a specified machine and waits for a response to be echoed back. * Open a command prompt * Type ping www.pscs.co.uk. You should see a display like this: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:problems_sending_messages_to_spam_your_domain?rev=1542192349&do=diff Problems sending messages to spam@<your domain> If a VPOP3 user forwards a message to spam@<your domain>, then the VPOP3 spam filter will train itself that that message was spam. If, when you forward the message, you get an error message like: Subject: Mail Delivery Failure Delivery Failure Report. The following message was incorrectly addressed. Recipient: "spam" is unrecognised. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:restricting_number_of_email_recipients_sent?rev=1542192349&do=diff Restricting the number of recipients sent to Some ISPs set restrictions on the number of recipients that you are allowed to send in a certain time period, eg 50 messages per hour, or the number of recipients that you are allowed to send per message or per connection. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:setup_steps_for_multiple_pop3_accounts_at_the_isp?rev=1542192349&do=diff Setup steps for multiple POP3 accounts at the ISP * Set up all the local users you need in the 'Users' page in the VPOP3 settings. The usernames & passwords do not have to have any relation to the ISP's accounts. These are the details which the users will put in their email clients (eg Outlook) to collect their mail from VPOP3. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:spanish_webmail_language_file?rev=1542192349&do=diff Spanish Webmail Language File Copy/paste the text below to a file 'spanish.lng' or 'espanol.lng' in the VPOP3 directory. (Spanish users, feel free to update/correct the text below) #login page logintitle=VPOP3 Login webadminlogin=web admin login webmaillogin=web mail login enterusername=Especificar aca el usuario de Correo bookmarksnotsupported=Disculpe, pero su navegador no soporta esta funcion. loginfailed=Login Fallido - Favor reintente nuevamente invalidlogin=Detalles del login inválidos… text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:undelete?rev=1542192349&do=diff Undelete Messages in VPOP3 Enterprise v5 or later If a user accidentally deletes messages or a message folder, you can easily undelete this within a few days. The amount of time that messages are stored in the VPOP3 'recycle bin' is set in Settings text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:vpop3_deleting_messages_as_old_messages?rev=1542192349&do=diff VPOP3 Deleting messages as 'old' messages If VPOP3 says 'deleting old message' in the status window activity log that means that it has seen the unique ID of that message before, longer ago than the time specified for VPOP3 to leave messages on the server, so it thinks that the message is an old message, and so deletes it. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:vpop3_is_using_a_lot_of_disk_space?rev=1542192349&do=diff VPOP3 is using a lot of disk space If VPOP3 is using a lot of disk space, the problem is usually that there is lots of data there, so it has to use the disk space. Message Storage In VPOP3 version 5 and later, all users' messages are stored in the database, so they will occupy space in the VPOP3\pgsql\data folder. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:vpop3_xxxxx_server_access_not_allowed?rev=1542192349&do=diff VPOP3 Server Access Not Allowed If you get an error like: -ERR VPOP3 Server access not allowed! when trying to access VPOP3, then this means that the relevant server's IP Access Restrictions defined in VPOP3 do not allow access from your client computer. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/how_to:your_connection_has_been_blocked_temporarily_-_try_again_later?rev=1542192349&do=diff Error message: Your connection has been blocked temporarily - Try again later If you get an error message in your email client software saying Your connection has been blocked temporarily - Try again later or Server access temporarily blocked! Please try again later text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:autoresponderinfo?rev=1542192349&do=diff AutoresponderInfo Replacement Use: ~autoresponderinfo~ Required parameter: responderid - the ID of the autoresponder This returns a JSON structure containing the details of the specified autoresponder. The return structure is an object containing: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:minpasswordlength?rev=1542192349&do=diff MinPasswordLength Replacement Use: ~minpasswordlength~ Required parameter: None This returns the minimum password length specified in the VPOP3 Settings -> Security settings text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:spellcheckaddword?rev=1542192349&do=diff SpellCheckAddWord This adds an entry to the user's custom spell check dictionary The data specified is: * Formaction - SpellCheckAddWord * Word - word to add * Action - ignore (don't mark the word as incorrect) or exclude (always mark the word as incorrect) text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:spellcheckdelword?rev=1542192349&do=diff SpellCheckDelWord This removes an entry from the user's custom spell check dictionary The data specified is: * Formaction - SpellCheckDelWord * Word - word to remove If you POST to the 'response.html' file, then the response comes back as {action: text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleactions?rev=1542192349&do=diff UserRuleActions Replacement Use: ~userruleactions~ <format string> ~end~ Required parameter: RuleId This returns the message rule actions for the specified rule The format string can have the replacements * id - numeric ID of the action * type - action type text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleactionupdate?rev=1542192349&do=diff UserRuleActionUpdate Replacement Use: ~userruleactionupdate~ Required parameter: * RuleId * gr_id - action ID * !nativeeditor_status - inserted/deleted/updated * type * data This inserts/updates/deletes the specified message rule action text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleconditions?rev=1542192349&do=diff UserRuleConditions Replacement Use: ~userruleconditions~ <format string> ~end~ Required parameter: RuleId This returns the message rule conditions for the specified rule The format string can have the replacements * id - numeric ID of the condition * field - field/data to test text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleconditionupdate?rev=1542192349&do=diff UserRuleConditionUpdate Replacement Use: ~userruleconditionupdate~ Required parameter: * RuleID * gr_id - condition ID * !nativeeditor_status - inserted/deleted/updated * matchi (1/0) * matchn (1/0) * match * field * data This inserts/updates/deletes the specified message condition text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userrulelist?rev=1542192349&do=diff UserRuleList Replacement Use: ~userrulelist~ <format string> ~end~ Required parameter: None This returns the message rule list (in order) for the current user The format string can have the replacements * id - numeric ID of the rule * order - numeric order number (1-n) of the rule text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/mailapi:userruleupdate?rev=1542192349&do=diff UserRuleUpdate Replacement Use: ~userruleupdate~ Required parameter: * gr_id - rule ID * !nativeeditor_status - inserted/deleted/updated * name * all * type This inserts/updates/deletes the specified message rule The return value is an XML tag: 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 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:ids_event_number?rev=1542192349&do=diff IDS Log Event Numbers The VPOP3 SMTP IDS logging facility logs SMTP events in a form which may be useful to Intrusion Protection Systems, or security monitoring software. One of the fields in the log file is the Log Event Number These are: * 0 = SMTP authentication failure 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_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 2023-08-16T07:48:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:lua_pop3_client_script?rev=1692172081&do=diff POP3 Client Lua Scripting The POP3 Client Lua Script is called POP3CLT.LUA and is edited in Settings -> Scripts. This script is called whenever VPOP3 runs a POP3 session to download messages from a remote POP3 server. VPOP3 will call the following Lua functions in the script at the following times: text/html 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:quarantine_tab?rev=1542192349&do=diff Quarantine tab The Quarantine tab within VPOP3 webmail is where you view and manage messages that have been quarantined by VPOP3's spam filter. As you can see from the screenshot, unlike many of the other webmail tabs, it is not divided into multiple sections: text/html 2021-08-09T10:55:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:scheduler_script?rev=1628506507&do=diff Scheduled Task Script Note that this functionality is only available in VPOP3 Enterprise VPOP3 Enterprise can run Lua script periodically to do custom background tasks. It can run a function every minute, 5 minutes, hourly or daily. The Lua script is stored in a file called text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:sender_advanced_settings?rev=1542192349&do=diff Mail Sender Advanced Settings Mail Connectors -> Mail Senders -> (name) -> Advanced Advanced Domain Filtering For VPOP3 v6.11 and later, see the Domain Filtering section of the user manual. The Domain Filtering box lets you restrict which email messages are sent via this Mail Sender. You specify each rule on a separate line, and the message will be sent if it matches any sender rule text/html 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 2026-03-26T11:41:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:smtp_rules_script?rev=1774525319&do=diff Lua SMTP Rules Scripts When VPOP3 is processing SMTP Rules for messages received by SMTP, it runs a script called smtprules_(x).lua, where (x) is replaced by the numeric ID of the SMTP service VPOP3 processes SMTP Rules at least three times for each message - once when MAIL FROM has been received, once for each RCPT TO, and once when the whole message data has been received. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_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_addblacklist?rev=1542192349&do=diff Spam Filter Rules: AddBlackList Statement AddBlackList Version 2.1.7+ Purpose Adds the specified data to the blacklist Example AddBlackList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_addwhitelist?rev=1542192349&do=diff Spam Filter Rules: AddWhiteList Statement AddWhiteList Version 2.1.7+ Purpose Adds the specified data to the whitelist Example AddWhiteList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_bulkscan?rev=1542192349&do=diff Spam Filter Rules: BulkScan Statement BulkScan Version 2.1.7+ Purpose Allows you to specify lots of search strings in one section without needing the verbose If statement The BulkScan statement requires a variable name and a limitless number of search specifiers, in the format text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_copy?rev=1542192349&do=diff Spam Filter Rules: Copy Statement Copy Version 2.1.7+ Purpose Sends a copy of the message to the specified recipient (and optionally folder) Examples To copy the message to the Postmaster user's inbox Copy Postmaster To copy the message to the Postmaster user's 'spam' folder text/html 2020-10-23T16:07:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_dnsbl?rev=1603469269&do=diff Spam Filter Rules: DNSBL Statement DNSBL Version 2.1.7+ Purpose Allows the script to perform a DNS blacklist lookup, returning the result into a specified variable The DNSBL statement requires a hostname, DNSBL zone 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_escape?rev=1542192349&do=diff Spam Filter Rules: Escape Statement Escape Version 2.3.6+ Purpose 'Escapes' the specified variable ready to pass as a regular expression The Escape statement should be called immediately before the variable, in the format Escape <variable name> Example ${myvar} = "This costs $10.00" Escape myvar # ${myvar} is now "This costs \$10\.00" 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_getmd5?rev=1542192349&do=diff Spam Filter Rules: GetMD5 Statement GetMD5 Version 2.3.6+ Purpose Performs an MD5 hash on a string, and returns the result into the specified variable in hex encoded form The GetMD5 statement requires a string and variable name, in the format GetMD5 <string> <variable name> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_getusergroup?rev=1542192349&do=diff Spam Filter Rules: GetUserGroup Statement GetUserGroup Version 2.4.5+ Purpose Checks if the specified user is assigned to a VPOP3 group, and returns the group name The GetUserGroup statement requires a username and variable name, in the format GetUserGroup <username> <variable name> 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 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:spamrules_statement_iflocaladdress?rev=1542192349&do=diff Spam Filter Rules: IfLocalAddress Statement IfLocalAddress Version 2.2.1+ Purpose Allows you to check if a specified email address is local to your VPOP3 installation IfLocalAddress requires just one paramater; the address, in the format IfLocalAddress <address> text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_redirect?rev=1542192349&do=diff Spam Filter Rules: Redirect Statement Redirect Version 2.1.7+ Purpose Remove all original recipients, and send the message to the specified recipient (and optionally folder) Examples To redirect the message to the Postmaster user's inbox Redirect Postmaster text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removebag?rev=1542192349&do=diff Spam Filter Rules: RemoveBag Statement RemoveBag Version 2.2.1+ Purpose Removes a specified value from a bag The RemoveBag statement requires a bag name and a value, in the format RemoveBag <bag name> <value> * If the value is found in the bag, it is removed text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removeblacklist?rev=1542192349&do=diff Spam Filter Rules: RemoveBlackList Statement RemoveBlackList Version 2.1.7+ Purpose Removes the specified data from the blacklist Example RemoveBlackList ${MailFrom} text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:spamrules_statement_removewhitelist?rev=1542192349&do=diff Spam Filter Rules: RemoveWhiteList Statement RemoveWhiteList Version 2.1.7+ Purpose Removes the specified data from the whitelist Example RemoveWhiteList ${MailFrom} text/html 2019-08-19T08:58:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:status_monitor_protocol?rev=1566205125&do=diff Status Monitor (port 5109) protocol This page documents the protocol used between VPOP3 and the Status Monitor. It's not intended for any other purpose, so it's a bit limited, but in certain cases you may find this useful Login Before the Status Monitor receives any updates or can issue commands it must log in using a user's credentials. text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:user_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:users?rev=1542192349&do=diff Users The Users page shows the list of users, as well as giving you some actions which you can perform use the user list. * Import users from file * Import users from Windows * Export users to file * Bulk Add Users * Edit User Welcome Message * Send Admin Message * Edit a User User List Outgoing Messages Just above the main user list is an entry Outgoing Message Queue. Clicking on this will let you see which messages are waiting to be sent out, and you can delete/ text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:users_autoresponders?rev=1542192349&do=diff Users.Autoresponders table The Users.Autoresponders table contains the users' autoresponder definitions Columns * autoresponderid - this is a numeric id of the autoresponder entry (primary key) * owneruser - this is the numeric id of the user which the autoresponder belongs to (or 0 for a 'template' autoresponder) text/html 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.markmessageread?rev=1542192349&do=diff VPOP3.MarkMessageRead Lua function The Lua management function 'VPOP3.MarkMessageRead' marks or unmarks a specified message as read. VPOP3.MarkMessageRead(username, folder, UID, read); * username is the username from VPOP3.GetUsers * folder is the folder from VPOP3.GetFolders * UID is the UID from text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.postgresquery?rev=1542192349&do=diff VPOP3.PostgresQuery The Lua function 'VPOP3.PostgresQuery' performs a query on the PostgreSQL database and returns the results in a table It takes a single parameter which is the SQL query to perform (Note that any relations used in the query must have the schema specified). text/html 2018-11-14T10:45:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.pscs.co.uk/reference:vpop3.purgemessage?rev=1542192349&do=diff VPOP3.PurgeMessage Lua function The Lua management function 'VPOP3.PurgeMessage' deletes the specified message immediately. VPOP3.PurgeMessage(username, folder, UID); * username is the username from VPOP3.GetUsers * folder is the folder from VPOP3.GetFolders * UID is the UID from VPOP3.GetMessages 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. 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