Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the new starttls() method #65

Merged
merged 1 commit into from
Mar 19, 2021
Merged

Document the new starttls() method #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Net/SMTP.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,8 @@ protected function getBestAuthMethod()
* Establish STARTTLS Connection.
*
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
* kind of failure, true on success, or false if SSL/TLS
* isn't available.
* @since 1.9.3
*/
public function starttls()
Expand Down
6 changes: 6 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,13 @@ establish a secure connection to the remote SMTP server::
This example connects to ``mail.example.com`` on port 465 (a common SMTPS
port) using the ``ssl://`` transport.

TLS/SSL is enabled for authenticated connections by default (via the ``auth()``
method's ``$tls`` parameter), but the |STARTTLS|_ command can also be sent
manually using the ``starttls()`` method.

.. _secure socket transports: https://www.php.net/transports
.. |STARTTLS| replace:: ``STARTTLS``
.. _STARTTLS: https://tools.ietf.org/html/rfc3207

Sending Data
============
Expand Down