Expansions: A tls option on ${readsocket }. Bug 2282

3 files changed, 16 insertions, 1 deletions

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index d6b65bf8b..8b939b52b 100644
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -9878,15 +9878,26 @@ extend what can be done. Firstly, you can vary the timeout. For example:
 .code
 ${readsocket{/socket/name}{request string}{3s}}
 .endd
+
 The third argument is a list of options, of which the first element is the timeout
 and must be present if the argument is given.
 Further elements are options of form &'name=value'&.
-One option type is currently recognised, defining whether (the default)
+Two option types is currently recognised: shutdown and tls.
+The first defines whether (the default)
 or not a shutdown is done on the connection after sending the request.
 Example, to not do so (preferred, eg. by some webservers):
 .code
 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
 .endd
+.new
+The second, tls, controls the use of TLS on the connection.  Example:
+.code
+${readsocket{/socket/name}{request string}{3s:tls=yes}}
+.endd
+The default is to not use TLS.
+If it is enabled, a shutdown as descripbed above is never done.
+.wen
+
 A fourth argument allows you to change any newlines that are in the data
 that is read, in the same way as for &%readfile%& (see above). This example
 turns them into spaces:
diff --git a/doc/doc-txt/ChangeLog b/doc/doc-txt/ChangeLog
index 13d8d8236..bc3f8d393 100644
--- a/doc/doc-txt/ChangeLog
+++ b/doc/doc-txt/ChangeLog
@@ -74,6 +74,7 @@ JH/15 Rework TLS client-side context management.  Stop using a global, and
       connection is using TLS; with cutthrough connections this is quite likely.
 
 JH/16 Fix ARC verification to do AS checks in reverse order.
+JH/16 Support a "tls" option on the ${readsocket } expansion item.
 
 
 Exim version 4.91
diff --git a/doc/doc-txt/NewStuff b/doc/doc-txt/NewStuff
index aaf9734f0..7c922cc2e 100644
--- a/doc/doc-txt/NewStuff
+++ b/doc/doc-txt/NewStuff
@@ -14,6 +14,9 @@ Version 4.92
     when individual headers are wrapped onto multiple lines; with previous
     facilities hard to parse.
 
+ 2. The ${readsocket } expansion item now takes a "tls" option, doing the
+    obvious thing.
+
 Version 4.91
 --------------