about summary refs log tree commit
diff options
context:
space:
mode:
authorSteve Hay <steve.m.hay@googlemail.com>2015-09-03 08:28:57 +0100
committerSteve Hay <steve.m.hay@googlemail.com>2015-09-03 08:28:57 +0100
commit959fe156ffd08ce92beedc04433d94ade65f3259 (patch)
treeeb19315e39ecca930838cd6a3b3c638e4fbe687c
parent8a6248ce3eeb8c147a99d73945437c713296579a (diff)
downloadperl-libnet-959fe156ffd08ce92beedc04433d94ade65f3259.tar.gz
SMTP: document passing of SASL instance to auth()
Based on a patch by Jan Viktorin <viktorin@rehivetech.com>. Fixes CPAN
RT#106183.
-rw-r--r--Changes3
-rw-r--r--lib/Net/SMTP.pm6
2 files changed, 8 insertions, 1 deletions
diff --git a/Changes b/Changes
index 64fbfa6..2ffe17b 100644
--- a/Changes
+++ b/Changes
@@ -2,6 +2,9 @@ Revision history for Perl distribution libnet
 
 3.08 Development
 
+    - Documented the fact that Net::SMTP::auth() can accept an Authen::SASL
+      object instead of a username and password.  [Jan Viktorin, CPAN RT#106183]
+
     - Simplified specification of INSTALLDIRS: We do not need to check the lower
       bound since we only support Perl 5.8.1 and higher anyway.
 
diff --git a/lib/Net/SMTP.pm b/lib/Net/SMTP.pm
index 9cfaa80..6d3e4c2 100644
--- a/lib/Net/SMTP.pm
+++ b/lib/Net/SMTP.pm
@@ -833,7 +833,11 @@ usually use the right arguments already.
 
 =item auth ( USERNAME, PASSWORD )
 
-Attempt SASL authentication. Requires Authen::SASL module.
+=item auth ( SASL )
+
+Attempt SASL authentication. Requires Authen::SASL module. The first form
+constructs a new Authen::SASL object using the given username and password;
+the second form uses the given Authen::SASL object.
 
 =item mail ( ADDRESS [, OPTIONS] )