Skip to content

Files

29 lines (18 loc) · 1.32 KB

custom-parameters.md

File metadata and controls

29 lines (18 loc) · 1.32 KB
title up
Custom list parameters
../customize.md#customizing-sympa-services

Custom list parameters

You can create an unlimited number of custom parameters to be used with authorization scenarios and mail/web templates.

These parameters are defined in each list configuration through the web interface by using the form in "Admin" -> "Edit list config" -> "Miscellaneous" page. There, you add a parameter in the "custom parameters (custom_vars)" section. The "var name (name)" field corresponds to your custom parameter name, and the "var value (value)" field corresponds to your custom parameter value.

You can later access this parameter:

  • in scenarios: with the variable [custom_vars->your_custom_var_name]
  • in web or mail templates: with the variable [%custom_vars.your_custom_var_name%]

Example

You define a custom parameter with the following values:

  • var name: sisterList
  • var value: math-teachers

You can use it as follows:

  • in scenarios: with the variable [custom_vars->sisterList], which will correspond to "math-teachers"
  • in web or mail templates: with the variable [%custom_vars.sisterList%], which will correspond to "math-teachers"