The command disclaimer() inserts a footer of an existing email into an email.
This command adds a predefined text or HTML template to an email. If no template is specified, an attempt is made to select the correct block on the basis of the Managed domains. For this purpose, the disclaimers assigned to the respective email domains are evaluated.
Structure of the command
disclaimer(['template'][,'position'][,'force']);
This command adds a text attachment from the indicated template to an existing email. If an empty string is indicated as the template, an attempt is made to select the correct block based on the settings of the Managed domains. For this purpose, the Disclaimers assigned to the respective email domains are evaluated.
Return value
positive |
If the disclaimer has been attached successfully |
negative |
If no template can be found/allocated (e.g. due to an undefined variable) or the disclaimer cannot be attached. |
Parameters
template (optional)
Defines the name of the template which is to be used as a text attachment. Footer (disclaimer) templates are configured and managed via the administration interface (see Mail System Edit mail disclaimer...).
If no template is specified, the standard disclaimer template of the respective Managed domain is used.
Variables available!
position (optional)
Possible values
•top |
above the email body |
•bottom |
below the email body |
The default setting is bottom |
|
Alternatively, a disclaimer may also be positioned manually, directly in the email.
For this purpose, a line with the text
##MAILDISCLAIMER##
is to be added to an email in the location in which the disclaimer is to be positioned.
(extended in 12.0)
By indicating
##MAILDISCLAIMER_<disclaimer>##
(whereby <disclaimer> corresponds to the desired disclaimer from ), not only the position but explicitly also the disclaimer to be used can be selected.
force (optional)
If the parameter is set ('1'), the addition of a text attachment to an outgoing email is forced. This means that the text attachment is also attached to reply emails.
Possible values
•true, yes or 1 |
|
•false, no or 0 |
|
The default setting is 0 |
|
Example 1
Line |
Code |
|---|---|
01 |
disclaimer('','bottom','yes'); |
Explanation
In this example, the default text attachment is selected based on the settings within the Managed domains and attached at the end of each email sent. This is done regardless of whether it is a reply email or not.
Example 2
Line |
Code |
|---|---|
01 |
encrypt_webmail(); |
02 |
disclaimer('GINAdisclaimer','bottom'); |
03 |
deliver(); |
Explanation
The disclaimer function can also be used within the GINA carrier emails via the custom commands.
In the present example, a proprietary with the name "GINAdisclaimer" was first created for this purpose.
Line 01 triggers the implementation of the GINA encryption. Directly below (line 02), the disclaimer must be attached for the GINA carrier email. Here, the previously created with the name "GINAdisclaimer". Due to the parameter 'bottom', this disclaimer is attached at the end of the notification text in each selected language of the GINA carrier email. The GINA email is then sent out (line 03).
