]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blob - vendor/pear/mail/README.rst
MediaWiki 1.30.2
[autoinstalls/mediawiki.git] / vendor / pear / mail / README.rst
1 ****
2 Mail
3 ****
4 Class that provides multiple interfaces for sending emails.
5
6 PEAR's Mail package defines an interface for implementing mailers under the
7 PEAR hierarchy.
8 It also provides supporting functions useful to multiple mailer backends.
9
10 Currently supported backends include:
11
12 - PHP's native ``mail()`` function
13 - sendmail
14 - SMTP
15
16 This package also provides a `RFC 822`__ email address list validation utility class.
17
18 Use Mail in combination with `Mail_Mime`__ to send HTML emails or emails with
19 attachments - have a look at the example__.
20
21 __ https://tools.ietf.org/html/rfc822
22 __ http://pear.php.net/package/Mail_Mime
23 __ http://pear.php.net/manual/en/package.mail.mail-mime.example.php
24
25 ============
26 Installation
27 ============
28
29 PEAR
30 ====
31 ::
32
33     $ pear install mail
34
35 Composer
36 ========
37 ::
38
39     $ composer require pear/mail
40
41 =====
42 Links
43 =====
44 Homepage
45   http://pear.php.net/package/Mail
46 Source code
47   https://github.com/pear/Mail
48 Issue tracker
49   http://pear.php.net/bugs/search.php?cmd=display&package_name[]=Mail
50 Unit test status
51   https://travis-ci.org/pear/Mail
52 Packagist
53   https://packagist.org/packages/pear/mail