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

fix: Email library forces to switch to TLS when setting port 465 #7883

Merged
merged 3 commits into from
Sep 4, 2023
Merged

fix: Email library forces to switch to TLS when setting port 465 #7883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5fee43
docs: fix doc comments
kenjis Aug 30, 2023
a5b4f9b
fix: now you can use SSL with port 465
kenjis Aug 30, 2023
2d0fa2e
docs: improve descriptions
kenjis Aug 30, 2023
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
6 changes: 5 additions & 1 deletion app/Config/Email.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@ class Email extends BaseConfig
public bool $SMTPKeepAlive = false;

/**
* SMTP Encryption. Either tls or ssl
* SMTP Encryption.
*
* @var string '', 'tls' or 'ssl'. 'tls' will issue a STARTTLS command
* to the server. 'ssl' means implicit SSL. Connection on port
* 465 should set this to ''.
*/
public string $SMTPCrypto = 'tls';

Expand Down
10 changes: 8 additions & 2 deletions system/Email/Email.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ class Email
/**
* SMTP Encryption
*
* @var string Empty, 'tls' or 'ssl'
* @var string '', 'tls' or 'ssl'. 'tls' will issue a STARTTLS command
* to the server. 'ssl' means implicit SSL. Connection on port
* 465 should set this to ''.
*/
public $SMTPCrypto = '';

Expand Down Expand Up @@ -1868,9 +1870,13 @@ protected function SMTPConnect()

$ssl = '';

// Connection to port 465 should use implicit TLS (without STARTTLS)
// as per RFC 8314.
if ($this->SMTPPort === 465) {
$ssl = 'tls://';
} elseif ($this->SMTPCrypto === 'ssl') {
}
// But if $SMTPCrypto is set to `ssl`, SSL can be used.
if ($this->SMTPCrypto === 'ssl') {
$ssl = 'ssl://';
}

Expand Down
15 changes: 9 additions & 6 deletions user_guide_src/source/libraries/email.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Email properties. Then save the file and it will be used automatically.
You will NOT need to use the ``$email->initialize()`` method if
you set your preferences in the config file.

.. _email-ssl-tls-for-smtp:

SSL versus TLS for SMTP Protocol
--------------------------------

Expand All @@ -85,7 +87,7 @@ will upgrade the channel to use encryption using the ``STARTTLS`` SMTP command.

Upgrading a connection on port 465 may or may not be supported by the server, so the
``STARTTLS`` SMTP command may fail if the server does not allow it. If you set the port to 465,
you should try to leave the ``SMTPCrypto`` setting blank since the communication is
you should try to set the ``SMTPCrypto`` to an empty string (``''``) since the communication is
secured using TLS from the start and the ``STARTTLS`` is not needed.

If your configuration requires you to connect to port 587, you should most likely set
Expand Down Expand Up @@ -115,14 +117,15 @@ Preference Default Value Options Descript
**SMTPHost** No Default None SMTP Server Address.
**SMTPUser** No Default None SMTP Username.
**SMTPPass** No Default None SMTP Password.
**SMTPPort** 25 None SMTP Port. (If set to 465, TLS will be used for the connection
regardless of SMTPCrypto setting.)
**SMTPPort** 25 None SMTP Port. (If set to ``465``, TLS will be used for the connection
regardless of ``SMTPCrypto`` setting.)
**SMTPTimeout** 5 None SMTP Timeout (in seconds).
**SMTPKeepAlive** false true or false (boolean) Enable persistent SMTP connections.
**SMTPCrypto** No Default tls or ssl SMTP Encryption. Setting this to "ssl" will create a secure
channel to the server using SSL and "tls" will issue a
**SMTPCrypto** tls tls, ssl, or empty string SMTP Encryption. Setting this to ``ssl`` will create a secure
channel to the server using SSL, and ``tls`` will issue a
``STARTTLS`` command to the server. Connection on port 465 should
set this to blank.
set this to an empty string (``''``). See also
:ref:`email-ssl-tls-for-smtp`.
**wordWrap** true true or false (boolean) Enable word-wrap.
**wrapChars** 76 Character count to wrap at.
**mailType** text text or html Type of mail. If you send HTML email you must send it as a complete web
Expand Down