Skip to content

Commit 2d0fa2e

Browse files
committed
docs: improve descriptions
1 parent a5b4f9b commit 2d0fa2e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

user_guide_src/source/libraries/email.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ Email properties. Then save the file and it will be used automatically.
6666
You will NOT need to use the ``$email->initialize()`` method if
6767
you set your preferences in the config file.
6868

69+
.. _email-ssl-tls-for-smtp:
70+
6971
SSL versus TLS for SMTP Protocol
7072
--------------------------------
7173

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

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

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

0 commit comments

Comments
 (0)