Docs: more detail for DKIM

[exim.git] / doc / doc-docbook / spec.xfpt

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index 6ff06f3a47f97b39e3936b3bd084de71d51f159d..1f5e295119726d9d868533f8a335e850e3bd75c6 100644 (file)
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -4020,7 +4020,7 @@ user.
 This option requests Exim to give up trying to deliver the listed messages,
 including any that are frozen. However, if any of the messages are active,
 their status is not altered. For non-bounce messages, a delivery error message
 This option requests Exim to give up trying to deliver the listed messages,
 including any that are frozen. However, if any of the messages are active,
 their status is not altered. For non-bounce messages, a delivery error message

-is sent to the sender, containing the text &"cancelled by administrator"&.
+is sent to the sender.

 Bounce messages are just discarded. This option can be used only by an admin
 user.
 
 Bounce messages are just discarded. This option can be used only by an admin
 user.
 


@@ -12088,6 +12088,10 @@ Exim was built with the EXPAND_LISTMATCH_RHS option.
 
 Consult section &<<SECThoslispatip>>& for further details of these patterns.
 
 
 Consult section &<<SECThoslispatip>>& for further details of these patterns.
 

+The variable &$value$& will be set for a successful match and can be
+used in the success clause of an &%if%& expansion item using the condition.
+Any previous &$value$& is restored after the if.
+

 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
 .cindex "domain list" "in expansion condition"
 .cindex "address list" "in expansion condition"
 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
 .cindex "domain list" "in expansion condition"
 .cindex "address list" "in expansion condition"


@@ -42023,7 +42027,7 @@ option.
 
 .endlist
 
 
 .endlist
 

-In addition, two ACL conditions are provided:
+In addition, two ACL conditions are provided, usable only in a DKIM ACL:

 
 .vlist
 .vitem &%dkim_signers%&
 
 .vlist
 .vitem &%dkim_signers%&


@@ -42291,18 +42295,30 @@ encoding operation.
 If this value is empty the the expansion result will be empty.
 The third argument should be the recipient domain of the message when
 it arrived at this system.
 If this value is empty the the expansion result will be empty.
 The third argument should be the recipient domain of the message when
 it arrived at this system.

+All arguments are expanded before use.
+
+The result of the expansion is the replacement envelope-from (return path)
+to be used.

 .endlist
 
 .cindex SRS decoding
 To decode an address use this expansion condition:
 .vlist
 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
 .endlist
 
 .cindex SRS decoding
 To decode an address use this expansion condition:
 .vlist
 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&

-The first argument should be the recipient local prt as is was received.
+The first argument should be the recipient local part as it was received.

 The second argument is the site secret.
 The second argument is the site secret.

+Both arguments are expanded before use.

 
 If the messages is not for an SRS-encoded recipient the condition will
 
 If the messages is not for an SRS-encoded recipient the condition will

-return false.  If it is, the condition will return true and the variable
+return false.
+If it is, the condition will return true and the variable

 &$srs_recipient$& will be set to the decoded (original) value.
 &$srs_recipient$& will be set to the decoded (original) value.

+
+.new
+If the second argument is empty then the condition returns true if
+the first argument is in valid SRS formet, else false.
+The variable &$srs_recipient$& is not set for this case.
+.wen

 .endlist
 
 Example usage:
 .endlist
 
 Example usage: