README
1NAME
2 Net::SMTP::TLS::ButMaintained - An SMTP client supporting TLS and AUTH
3 (DEPRECATED, use Net::SMTPS instead)
4
5VERSION
6 version 0.24
7
8SYNOPSIS
9 use Net::SMTP::TLS::ButMaintained;
10 my $mailer = Net::SMTP::TLS::ButMaintained->new(
11 'your.mail.host',
12 Hello => 'some.host.name',
13 Port => 25, #redundant
14 User => 'emailguy',
15 Password=> 's3cr3t');
16 $mailer->mail('emailguy@your.mail.host');
17 $mailer->to('someonecool@somewhere.else');
18 $mailer->data;
19 $mailer->datasend("Sent thru TLS!");
20 $mailer->dataend;
21 $mailer->quit;
22
23DESCRIPTION
24 DEPRECATED!, Please use Net::SMTPS instead.
25
26 Net::SMTP::TLS::ButMaintained is forked from Net::SMTP::TLS. blame "Evan
27 Carroll" for the idea. :)
28
29 Net::SMTP::TLS::ButMaintained is a TLS and AUTH capable SMTP client
30 which offers an interface that users will find familiar from Net::SMTP.
31 Net::SMTP::TLS::ButMaintained implements a subset of the methods
32 provided by that module, but certainly not (yet) a complete mirror image
33 of that API.
34
35 The methods supported by Net::SMTP::TLS::ButMaintained are used in the
36 above example. Though self explanatory for the most part, please see the
37 perldoc for Net::SMTP if you are unclear.
38
39 The differences in the methods provided are as follows:
40
41 The *mail* method does not take the options list taken by Net::SMTP
42
43 The *to* method also does not take options, and is the only method
44 available to set the recipient (unlike the many synonyms provided by
45 Net::SMTP).
46
47 The constructor takes a limited number of Net::SMTP's parameters.
48 The constructor for Net::SMTP::TLS::ButMaintained takes the
49 following (in addition to the hostname of the mail server, which
50 must be the first parameter and is not explicitly named):
51
52 NoTLS - In the unlikely event that you need to use this class to
53 perform non-TLS SMTP (you ought to be using Net::SMTP itself for
54 that...), this will turn off TLS when supplied with a true
55 value. This will most often cause an error related to
56 authentication when used on a server that requires TLS
57
58 Hello - hostname used in the EHLO command
59
60 Port - port to connect to the SMTP service (defaults to 25)
61
62 Timeout - Timeout for inital socket connection (defaults to 5,
63 passed directly to IO::Socket::INET)
64
65 User - username for SMTP AUTH
66
67 Password - password for SMTP AUTH
68
69 TLS and AUTHentication
70 During construction of an Net::SMTP::TLS::ButMaintained instance, the
71 full login process will occur. This involves first sending EHLO to the
72 server, then initiating a TLS session through STARTTLS. Once this is
73 complete, the module will attempt to login using the credentials
74 supplied by the constructor, if such credentials have been supplied.
75
76 The AUTH method will depend on the features returned by the server after
77 the EHLO command. Based on that, CRAM-MD5 will be used if available,
78 followed by LOGIN, followed by PLAIN. Please note that LOGIN is the only
79 method of authentication that has been tested. CRAM-MD5 and PLAIN login
80 functionality was taken directly from the script mentioned in the
81 acknowledgements section, however, I have not tested them personally.
82
83 ERROR HANDLING
84 This module will croak in the event of an SMTP error. Should you wish to
85 handle this gracefully in your application, you may wrap your mail
86 transmission in an eval {} block and check $@ afterward.
87
88 ACKNOWLEDGEMENTS
89 This code was blatantly plagiarized from Michal Ludvig's smtp-client.pl
90 script. See <http://www.logix.cz/michal/devel/smtp> for his excellent
91 work.
92
93 Improvements courtesy of Tomek Zielinski
94
95AUTHORS
96 * Alexander Christian Westholm <awestholm at verizon dawt net>
97
98 * Fayland Lam <fayland@gmail.com>
99
100COPYRIGHT AND LICENSE
101 This software is copyright (c) 2011 by Alexander Christian Westholm,
102 Fayland Lam.
103
104 This is free software; you can redistribute it and/or modify it under
105 the same terms as the Perl 5 programming language system itself.
106
107