[exim-cvs] Add documentation for new $authenticated_fail_id

Top Page
Delete this message
Reply to this message
Author: Exim Git Commits Mailing List
Date:  
To: exim-cvs
Subject: [exim-cvs] Add documentation for new $authenticated_fail_id
Gitweb: http://git.exim.org/exim.git/commitdiff/1ce2c5ce6d8a33b0b3ec8b331bf1d51356e61bc4
Commit:     1ce2c5ce6d8a33b0b3ec8b331bf1d51356e61bc4
Parent:     33382dd9537a16c676e07632e122c0112855d5c3
Author:     Todd Lyons <tlyons@???>
AuthorDate: Mon Sep 23 16:31:31 2013 -0700
Committer:  Todd Lyons <tlyons@???>
CommitDate: Mon Sep 23 17:46:08 2013 -0700


    Add documentation for new $authenticated_fail_id
---
 doc/doc-docbook/spec.xfpt |   13 ++++++++++++-
 1 files changed, 12 insertions(+), 1 deletions(-)


diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index ac95f26..7ab482c 100644
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -10882,6 +10882,16 @@ the value of &$authenticated_id$& is normally the login name of the calling
process. However, a trusted user can override this by means of the &%-oMai%&
command line option.

+.vitem &$authenticated_fail_id$&
+.cindex "authentication" "fail" "id"
+.vindex "&$authenticated_fail_id$&"
+When an authentication attempt fails, the variable &$authenticated_fail_id$&
+will contain the failed authentication id. If more than one authentication
+id is attempted, it will contain only the last one. The variable is
+available for processing in the ACL's, generally the quit or notquit ACL.
+A message to a local recipient could still be accepted without requiring
+authentication, which means this variable could also be visible in all of
+the ACL's as well.



@@ -24548,7 +24558,8 @@ to be returned. If the result of a successful expansion is an empty string,
expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
For any other result, a temporary error code is returned, with the expanded
-string as the error text.
+string as the error text, and the failed id saved in
+&$authenticated_fail_id$&.

&*Warning*&: If you use a lookup in the expansion to find the user's
password, be sure to make the authentication fail if the user is unknown.