Attachment "pop3.man.diff" to
ticket [1906274fff]
added by
egavilan
2008-03-03 21:24:08.
--- pop3.man.orig 2008-03-03 12:02:21.000000000 -0300
+++ pop3.man 2008-03-03 12:22:06.000000000 -0300
@@ -1,7 +1,7 @@
[manpage_begin pop3 n 1.6.3]
[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl POP3 Client Library}]
-[titledesc {Tcl client for POP3 email protocol}]
+[titledesc {Tcl client for POP3 email protocol with optional SSL support}]
[require Tcl 8.2]
[require pop3 [opt 1.6.3]]
[description]
@@ -9,10 +9,11 @@
The [package pop3] package provides a simple Tcl-only client library
for the POP3 email protocol as specified in
RFC 1939 ([uri http://www.rfc-editor.org/rfc/rfc1939.txt]). It works
-by opening the standard POP3 socket on the server, transmitting the
-username and password, then providing a Tcl API to access the POP3
-protocol commands. All server errors are returned as Tcl errors
-(thrown) which must be caught with the Tcl [cmd catch] command.
+by opening the standard POP3 or POP3S socket on the server,
+transmitting the username and password, then providing a Tcl API
+to access the POP3 protocol commands.
+All server errors are returned as Tcl errors (thrown) which must be
+caught with the Tcl [cmd catch] command.
[section COMMANDS]
@@ -20,6 +21,7 @@
[call [cmd ::pop3::open] [opt "[option -msex] 0|1"] \
[opt "[option -retr-mode] retr|list|slow"] \
+ [opt "[option -tls] 0|1"] \
[arg {host username password}] [opt [arg port]]]
Open a socket connection to the server specified by [arg host],
@@ -30,12 +32,14 @@
[para]
-The command recognizes the options [option -msex] and
-
-[option -retr-mode]. The first of them can be used to notify the
-package of the fact that the server to talk to is an MS Exchange
-server (which has some oddities we have to work around). The default
-is 0.
+The command recognizes the options [option -msex],
+[option -retr-mode] and [option -tls]. The first of them can be used
+to notify the package of the fact that the server to talk to is an
+MS Exchange server (which has some oddities we have to work around).
+The default is 0. The last is used to enable SSL connections with
+the server. In case that tls is set to 1, an additional package
+is required (tls) and the default port number is set to 995.
+Not having this package throws an error.
[para]
