Docs: clarify $authentication_failed. Bug 2878
authorJeremy Harris <jgh146exb@wizmail.org>
Sun, 8 May 2022 12:20:49 +0000 (13:20 +0100)
committerJeremy Harris <jgh146exb@wizmail.org>
Sun, 8 May 2022 12:20:49 +0000 (13:20 +0100)
doc/doc-docbook/spec.xfpt

index 911f17ad8580a42ca07de4797f4991a40c7aa4a2..eafd56fbadb2ccc18b1d26386ce98b2eb00bd2d9 100644 (file)
@@ -12536,9 +12536,10 @@ command that does not succeed. Otherwise it is set to &"0"&. This makes it
 possible to distinguish between &"did not try to authenticate"&
 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
-is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
-negative response to an AUTH command, including (for example) an attempt to use
-an undefined mechanism.
+is empty and &$authentication_failed$& is set to &"1"&).
+Failure includes cancellation of a authentication attempt,
+and any negative response to an AUTH command,
+(including, for example, an attempt to use an undefined mechanism).
 
 .vitem &$av_failed$&
 .cindex "content scanning" "AV scanner failure"