User Tools

Site Tools


reference:user_routing_script

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 to this user are handled. (Messages from this user are not affected by the script at all).

If that script doesn't exist, but there is a user_redirect.lua script, that Lua script will be used instead.

When the user_redirect.lua script is run there are several global variables set:

  • Assistants - the value of the 'Assistants' setting for this user (string)
  • RedirectToAssistant - the value of the 'Redirect to Assistant' setting for this user (boolean)
  • Forwards - the value of the 'Forward To' setting for this user (string)
  • UseForwards - the value of the 'UseForwarding' setting for this user (boolean)
  • SendToNormalRecipient - if this is true the message will be sent to the normal recipient (unless a Forward or Assistant overrides this) (boolean)
  • ShouldForward - if this is false then VPOP3 will ignore the Assistants and any forwarding settings (boolean)
  • BigRedirect - the settings for the 'If message > xxx kb' setting for this user
  • SmallRedirect - the settings for the 'If message < xxx kb' setting for this user

The BigRedirect and SmallRedirect variables are tables with 4 entries:

  • Target - the target address(es) for this redirector (string)
  • Threshold - the threshold at which this redirector is actioned (in kB) (number)
  • Copy - whether this redirector will copy or redirect the message (boolean)
  • Bigger - true if the redirector checks for messages > Threshold, false if it checks for messages < Threshold (boolean)

All the above settings can be changed by the script to alter the routing (the changes will only apply for this message, not future messages)

There are also some global variables which should be treated as read-only - any changes to them will be ignored outside the Lua script

  • MessageSize - the size of the message in bytes (may be zero if size is unknown)
  • SpamScore - the spam score for the message
  • SpamScoreValid - true if the SpamScore setting is value (it will be false if spam processing is disabled, for instance)
  • Sender - the email address of the message sender
  • User - the username of the user being processed
  • Subject - the subject of the message

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.

Examples

Don't forward messages from *@localdomain.com addresses

--Don't forward any messages from any *@localdomain.com addresses
if string.find(Sender, "@localdomain%.com$") then
  ShouldForward = false;
end

If the sender is user@domain.com forward to person@mycompany.com

--If  the sender is user@domain.com forward to person@mycompany.com
if string.lower(Sender) == "user@domain.com" then
  Forwards = "person@mycompany.com";
  UseForwards = true;
  ShouldForward = true;
end

If the time is currently in the morning, override the assistant to send to someone else

now = os.date("*t"); --https://www.lua.org/pil/22.1.html
if now.hour < 12 then
  Assistants = "otheraddress@example.com"
end
reference/user_routing_script.txt · Last modified: 2021/02/19 09:51 by paul