User Tools

Site Tools


reference:lua_scripting

Lua Scripting

Lua is a simple scripting programming language often used for embedding in other applications. VPOP3 uses it to customise behaviour in places where most people will be happy with the default behaviour, but occasionally people will want to do something more complicated. Rather than having lots of extra options to complicate things for most users, we have opted to go for a more flexible scripting facility.

For general Lua programming instructions see www.lua.org for documentation. Note that if you use the print command in Lua, VPOP3 will write the output to the Lua.out file, it won't appear directly on screen. VPOP3 writes Lua interpreter errors (eg syntax errors etc) to Luaerrors.log in the VPOP3 logging directory.

Please note - the only help we will give with Lua with our free support is to clarify the Lua interface (eg function signatures etc), we will not give help with Lua in general or help you to write or debug your own Lua scripts. We can help with that, but it will be on a chargeable basis depending on the complexity of the issue. Contact us for more information.

In VPOP3 v6.6 and earlier, Lua scripts are stored as files in the main VPOP3 installation directory, or in users' directories (if they are user specific scripts). These must be edited from outside of VPOP3 and backed up separately. In VPOP3 v6.7 and later, scripts are stored in the VPOP3 database, and are managed from the Settings → Scripts page in the VPOP3 settings. These are backed up with the main VPOP3 backups. If you save a script as a file in the VPOP3 directory, VPOP3 will import it into the database on first use.

Extra VPOP3 Functions

Version 5

Version 3 or later

Only in POP3CLT.LUA and SMTPSVR.LUA 'ProcessMessage' function

reference/lua_scripting.txt · Last modified: 2018/11/14 10:45 (external edit)