Synchronet v3.21e-Win32 (install) has been released (Mar-2026).

You can donate to the Synchronet project using PayPal.

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
module:emailval [2020/12/10 19:15] – [Configure] add valid_chars and code_length options mlongmodule:emailval [2026/03/01 01:21] (current) – Document text/menu/emailval.* and the prompt option digital man
Line 4: Line 4:
  
 Upon successful validation, the user's security level is updated, allowing for more access privileges. Upon successful validation, the user's security level is updated, allowing for more access privileges.
 +
 +===== Invoke =====
 +
 +Normally this module executes automatically for every Terminal Server logon via the [[module:logon]] module (controlled via ''[[config:modopts.ini]]''), but for testing, it can also be run using the '';exec'' sysop command.
 +
 +Alternatively, it could be configured to run via [[util:SCFG]]->External Programs->Online Programs (configured to Execute upon "Logon") or [[util:SCFG]]->External Programs->Fixed Events->Logon Event (runs much later in the logon process).
 +
 +A test mode can be enabled by including the ''-test'' argument on the command-line. This will cause the module to display the menu even if the current user has already been "validated".
  
 ===== Install ===== ===== Install =====
Line 11: Line 19:
 ===== Configure =====  ===== Configure ===== 
  
-The [[https://gitlab.synchro.net/main/sbbs/-/blob/master/exec/emailval.js|e-mail validation module]] supports the following configuration options in the ''[emailval]'' section of the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:+The [[https://gitlab.synchro.net/main/sbbs/-/blob/master/exec/emailval.js|e-mail validation module]] supports the following configuration options in ''[[dir:ctrl]]/[[dir:modopts]]/emailval.ini'' (the default) or the ''[emailval]'' section of the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:
  
 ^ Option ^ Default ^ Description ^ ^ Option ^ Default ^ Description ^
Line 17: Line 25:
 | code_length | ''16'' | Length of generated validation codes | | code_length | ''16'' | Length of generated validation codes |
 | level_before_validation | ''50''  | Security [[access:level]] of unvalidated users | | level_before_validation | ''50''  | Security [[access:level]] of unvalidated users |
-| level_after_validation | ''60''  | Security [[access:level]] of validated users  |+| level_after_validation | ''60''  | Security [[access:level]] of validated users (optional) |
 | flags1_after_validation | //no change// | [[access:Flags]] (from flags set 1) to give, add-to, or remove-from validated users | | flags1_after_validation | //no change// | [[access:Flags]] (from flags set 1) to give, add-to, or remove-from validated users |
 | flags2_after_validation | //no change// | " " (from flags set 2) | | flags2_after_validation | //no change// | " " (from flags set 2) |
Line 26: Line 34:
 | expiration_after_validation | ''false'' | If ''true'', leave or extend the user account expiration date. If ''false'', set validated users to not expire | | expiration_after_validation | ''false'' | If ''true'', leave or extend the user account expiration date. If ''false'', set validated users to not expire |
 | expiration_days_after_validation | //no change// | If ''expiration_after_validation = true'', the days to extend the user's expiration date, once validated | | expiration_days_after_validation | //no change// | If ''expiration_after_validation = true'', the days to extend the user's expiration date, once validated |
 +| credits_added_after_validation | 0 | Number of credits to award the user after validation | 
 +| minutes_added_after_validation | 0 | Number of minutes to bank for the user after validation | 
 +| prompt                           | Override the default prompt |
  
 **Note**:\\ **Note**:\\
Line 34: Line 44:
  
 Numeric values are supported for assignment (not modification). \\ Numeric values are supported for assignment (not modification). \\
-e.g. 0 = no flags, 1 = A, 2 = B, 4 = C, 8 = D, etc. \\+e.g. 0 = no flags, 1 = A, 2 = B, 4 = C, 8 = D, etc. 
 + 
 +===== Customize ===== 
 + 
 +If the ''[[dir:text]]/menu/emailval.*'' display file exists, it'll be displayed in place of the default introductory text.
  
 ===== See Also ===== ===== See Also =====
   * [[:module:|Modules]]   * [[:module:|Modules]]