Merge remote-tracking branch 'upstream/develop' into media
[friendica-addons.git/.git] / phpmailer / README.md
1 PHP Mailer SMTP
2 ============
3
4 by Marcus Mueller
5
6 This addon replaces the default `mail()` function by the `PHPMailer` library, allowing the use of an outbound SMTP server.
7
8 Configuration
9 -------------
10
11 You can override the default value of the following config keys in your base Friendica install `config/addon.config.php` file:
12
13         'phpmailer' => [
14         // smtp (Boolean)
15         // Enables SMTP relaying for outbound emails
16         'smtp' => false,
17
18         // smtp_server (String)
19         // SMTP server host name
20         'smtp_server' => 'smtp.example.com',
21
22         // smtp_port (Integer)
23         // SMTP server port number
24         'smtp_port' => 25,
25
26         // smtp_secure (String)
27         // What kind of encryption to use on the SMTP connection.
28         // Options: '', 'ssl' or 'tls'.
29         'smtp_secure' => '',
30
31         // smtp_port_s (Integer)
32         // Secure SMTP server port number
33         'smtp_port_s' => 465,
34
35         // smtp_username (String)
36         // SMTP server authentication user name
37         // Empty string disables authentication
38         'smtp_username' => '',
39
40         // smtp_password (String)
41         // SMTP server authentication password
42         // Empty string disables authentication
43         'smtp_password' => '',
44
45         // smtp_from (String)
46         // From address used when using the SMTP server
47         // Example: no-reply@example.com
48         'smtp_from' => '',
49     ],
50
51 License
52 =======
53
54 The _PHPMailer addon_ is licensed under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.html).
55
56 The _PHP Mailer_ library is licensed under the [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.html).