The authenticated() command checks the identification status of the sender.
The sender's identification status includes identity and authentication.
For authentication, it is first checked whether the sender header is present and its content is stored intermediately, if applicable. If no sender header is present, the content of the Envelope From (envelope MAIL) is stored intermediately instead. If the intermediately stored address belongs to a Managed domain, it is used for authentication, provided that the FROM header does not contain an address of a Managed domain.
For the successful authentication of a sender, the SMTP address, which is to be determined as described above, must already be present on the appliance as a "Named User" (see Users).
Structure of the command
authenticated(['from-header']);
Return value
positive |
if the sender could be successfully authenticated |
negative |
if the authentication of the sender fails |
Parameters
from-header (optional)
Enforces the authentication based on the SMTP address of the FROM header.
Possible values
•true, yes or 1
•false, no or 0
The default setting is 0
The key required for an email signature is always used based on the email address of the authenticated user. This means that if the parameter from-header contains the value "1", signing is enforced with the key of the sender from the FROM header. |
Example 1
Line |
Code |
---|---|
01 |
if (!authenticated()) { |
02 |
createaccount(); |
03 |
log(1,'user account generated'); |
04 |
} |
Explanation
The example evaluates the negated return value of the command authenticated() from (line 01). If the internal sender of the email could be authenticated successfully, due to the negation, the return value is false. If the authentication has failed, due to the negation, the return value is true and the indicated instruction block applies. In the example, a user account would therefore be created for the sender determined as described above (line 02) and a corresponding log entry would be created (line 03).
Example 2
Line |
Code |
---|---|
01 |
if (!authenticated('1')) { |
02 |
createaccount(); |
03 |
log(1,'user account generated'); |
04 |
} |
Explanation
Contrary to Example 1 the use of the sender from the FROM header is enforced due to the set parameter 'from-header’.