Merge pull request #8310 from kenjis/docs-upgrading-email

docs: improve "Upgrade Emails"
codeigniter4 · Dec 9, 2023 · 5ccb299 · 5ccb299
2 parents 6e8564d + 7e0ddbf
commit 5ccb299
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/app/Config/Email.php b/app/Config/Email.php
@@ -26,7 +26,7 @@ class Email extends BaseConfig
     public string $mailPath = '/usr/sbin/sendmail';
 
     /**
-     * SMTP Server Address
+     * SMTP Server Hostname
      */
     public string $SMTPHost = '';
 

diff --git a/system/Email/Email.php b/system/Email/Email.php
@@ -71,7 +71,7 @@ class Email
     public $protocol = 'mail';
 
     /**
-     * STMP Server host
+     * STMP Server Hostname
      *
      * @var string
      */

diff --git a/user_guide_src/source/installation/upgrade_emails.rst b/user_guide_src/source/installation/upgrade_emails.rst
@@ -14,6 +14,7 @@ Documentations
 What has been changed
 =====================
 - Only small things like the method names and the loading of the library have changed.
+- 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`.
 
 Upgrade Guide
 =============

diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
@@ -102,6 +102,8 @@ The settings used for the last successful send are available from the
 instance property ``$archive``. This is helpful for testing and debugging
 to determine that actual values at the time of the ``send()`` call.
 
+.. _email-preferences:
+
 Email Preferences
 =================
 
@@ -115,7 +117,7 @@ Preference          Default Value       Options                      Description
 **protocol**        mail                ``mail``, ``sendmail``,      The mail sending protocol.
                                         or ``smtp``
 **mailPath**        /usr/sbin/sendmail  None                         The server path to Sendmail.
-**SMTPHost**        No Default          None                         SMTP Server Address.
+**SMTPHost**        No Default          None                         SMTP Server Hostname.
 **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