diff options
author | Jeremy Harris <jgh146exb@wizmail.org> | 2021-07-15 21:05:27 +0100 |
---|---|---|
committer | Jeremy Harris <jgh146exb@wizmail.org> | 2021-07-15 21:14:37 +0100 |
commit | 26916dc7554eeff8d82aa8d7461349205b00b912 (patch) | |
tree | 12a8690f8829ee237c68fe4a0a7e72b2b39c2365 /doc/doc-docbook | |
parent | 1f76af318dd32a1f66d36b9ab5f9e8fe96274dc5 (diff) |
Docs: Clarify $acl_verify_message lifetime
Diffstat (limited to 'doc/doc-docbook')
-rw-r--r-- | doc/doc-docbook/spec.xfpt | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index d839c518a..3384d60d9 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -12332,8 +12332,8 @@ this variable has the number of arguments. .vitem &$acl_verify_message$& .vindex "&$acl_verify_message$&" After an address verification has failed, this variable contains the failure -message. It retains its value for use in subsequent modifiers. The message can -be preserved by coding like this: +message. It retains its value for use in subsequent modifiers of the verb. +The message can be preserved by coding like this: .code warn !verify = sender set acl_m0 = $acl_verify_message @@ -12341,6 +12341,9 @@ warn !verify = sender You can use &$acl_verify_message$& during the expansion of the &%message%& or &%log_message%& modifiers, to include information about the verification failure. +.new +&*Note*&: The variable is cleared at the end of processing the ACL verb. +.wen .vitem &$address_data$& .vindex "&$address_data$&" @@ -31383,8 +31386,11 @@ anyway. If the message contains newlines, this gives rise to a multi-line SMTP response. .vindex "&$acl_verify_message$&" -For ACLs that are called by an &%acl =%& ACL condition, the message is -stored in &$acl_verify_message$&, from which the calling ACL may use it. +.new +While the text is being expanded, the &$acl_verify_message$& variable +contains any message previously set. +Afterwards, &$acl_verify_message$& is cleared. +.wen If &%message%& is used on a statement that verifies an address, the message specified overrides any message that is generated by the verification process. @@ -33269,6 +33275,7 @@ warn !verify = sender If you are writing your own custom rejection message or log message when denying access, you can use this variable to include information about the verification failure. +This variable is cleared at the end of processing the ACL verb. In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as appropriate) contains one of the following words: |