Skip to content

Commit 5ccb299

Browse files
authored
Merge pull request #8310 from kenjis/docs-upgrading-email
docs: improve "Upgrade Emails"
2 parents 6e8564d + 7e0ddbf commit 5ccb299

4 files changed

Lines changed: 6 additions & 3 deletions

File tree

app/Config/Email.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class Email extends BaseConfig
2626
public string $mailPath = '/usr/sbin/sendmail';
2727

2828
/**
29-
* SMTP Server Address
29+
* SMTP Server Hostname
3030
*/
3131
public string $SMTPHost = '';
3232

system/Email/Email.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class Email
7171
public $protocol = 'mail';
7272

7373
/**
74-
* STMP Server host
74+
* STMP Server Hostname
7575
*
7676
* @var string
7777
*/

user_guide_src/source/installation/upgrade_emails.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Documentations
1414
What has been changed
1515
=====================
1616
- Only small things like the method names and the loading of the library have changed.
17+
- The behavior when using the SMTP protocol has been slightly changed. You may not be able to communicate with your SMTP server properly if you use the CI3 settings. See :ref:`email-ssl-tls-for-smtp` and :ref:`email-preferences`.
1718

1819
Upgrade Guide
1920
=============

user_guide_src/source/libraries/email.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ The settings used for the last successful send are available from the
102102
instance property ``$archive``. This is helpful for testing and debugging
103103
to determine that actual values at the time of the ``send()`` call.
104104

105+
.. _email-preferences:
106+
105107
Email Preferences
106108
=================
107109

@@ -115,7 +117,7 @@ Preference Default Value Options Description
115117
**protocol** mail ``mail``, ``sendmail``, The mail sending protocol.
116118
or ``smtp``
117119
**mailPath** /usr/sbin/sendmail None The server path to Sendmail.
118-
**SMTPHost** No Default None SMTP Server Address.
120+
**SMTPHost** No Default None SMTP Server Hostname.
119121
**SMTPUser** No Default None SMTP Username.
120122
**SMTPPass** No Default None SMTP Password.
121123
**SMTPPort** 25 None SMTP Port. (If set to ``465``, TLS will be used for the connection

0 commit comments

Comments
 (0)