User Tools

Site Tools


reference:outgoing_message_script

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Last revisionBoth sides next revision
reference:outgoing_message_script [2015/02/10 10:17] – created paulreference:outgoing_message_script [2024/03/21 10:44] – [Messages to be sent] paul
Line 3: Line 3:
  
 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. 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.
 +
 +See the [[Lua Scripting]] page for general details about VPOP3's scripting, and information on how we can help.
  
 =====Messages to be sent===== =====Messages to be sent=====
Line 21: Line 23:
   * HoldSeconds - The current number of seconds the message will be held before being sent (0 = no time).   * HoldSeconds - The current number of seconds the message will be held before being sent (0 = no time).
   * DeleteAfterSeconds - The current number of seconds before the message will be deleted from the queue (0 = never).   * DeleteAfterSeconds - The current number of seconds before the message will be deleted from the queue (0 = never).
 +  * HoldTimeFromSender - The ISO-8601 time to hold to as defined at message send time (eg by 'FUTURERELEASE') (added in v8.6)
 +  * DeleteTimeFromSender - The ISO-8601 time to delete the message at as defined at message send time (added in v8.6)
  
 The function returns a table of new settings. This can contain the following fields. If the field doesn't exist, then the value is not changed. The function returns a table of new settings. This can contain the following fields. If the field doesn't exist, then the value is not changed.
Line 28: Line 32:
   * HoldUntil - If this is set to a string like YYYYMMDDHHMMSS then the message is held until that time, otherwise it is held for the specified number of seconds.   * HoldUntil - If this is set to a string like YYYYMMDDHHMMSS then the message is held until that time, otherwise it is held for the specified number of seconds.
   * DeleteAfter - If this is set to 'none', then it is never deleted. If this is set to a string like YYYYMMDDHHMMSS then the message will be deleted after that time, otherwise it will be deleted after the specified number of seconds.   * DeleteAfter - If this is set to 'none', then it is never deleted. If this is set to a string like YYYYMMDDHHMMSS then the message will be deleted after that time, otherwise it will be deleted after the specified number of seconds.
 +  * ReturnPath - (added in v8.6) - A new value for the ReturnPath (MAILFROM) of the message being sent
  
reference/outgoing_message_script.txt · Last modified: 2024/03/21 10:49 by paul