From 3d96fc53975a101932825f6eb8103662ac2be640 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 8 Dec 2023 13:35:52 +0900 Subject: [PATCH 1/4] docs: add link to section --- user_guide_src/source/libraries/email.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst index 33386bc8b17c..f4cac03d8ee2 100644 --- a/user_guide_src/source/libraries/email.rst +++ b/user_guide_src/source/libraries/email.rst @@ -42,7 +42,7 @@ Setting Email Preferences There are 21 different preferences available to tailor how your email messages are sent. You can either set them manually as described here, or automatically via preferences stored in your config file, described -below: +in `Email Preferences`_. Setting Email Preferences by Passing an Array --------------------------------------------- From ee7e590daaf26bd37ea2c7d98594ac21c4b60f27 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 8 Dec 2023 13:36:17 +0900 Subject: [PATCH 2/4] docs: improve readability --- user_guide_src/source/libraries/email.rst | 65 ++++++++++++----------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst index f4cac03d8ee2..88f978b47f5e 100644 --- a/user_guide_src/source/libraries/email.rst +++ b/user_guide_src/source/libraries/email.rst @@ -108,38 +108,39 @@ Email Preferences The following is a list of all the preferences that can be set when sending email. -=================== ====================== ============================ ======================================================================= -Preference Default Value Options Description -=================== ====================== ============================ ======================================================================= -**userAgent** CodeIgniter None The "user agent". -**protocol** mail mail, sendmail, or smtp The mail sending protocol. -**mailPath** /usr/sbin/sendmail None The server path to Sendmail. -**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.) -**SMTPTimeout** 5 None SMTP Timeout (in seconds). -**SMTPKeepAlive** false true or false (boolean) Enable persistent SMTP connections. -**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 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 - page. Make sure you don't have any relative links or relative image - paths otherwise they will not work. -**charset** utf-8 Character set (utf-8, iso-8859-1, etc.). -**validate** true true or false (boolean) Whether to validate the email address. -**priority** 3 1, 2, 3, 4, 5 Email Priority. 1 = highest. 5 = lowest. 3 = normal. -**CRLF** \\n "\\r\\n" or "\\n" or "\\r" Newline character. (Use "\\r\\n" to comply with RFC 822). -**newline** \\n "\\r\\n" or "\\n" or "\\r" Newline character. (Use "\\r\\n" to comply with RFC 822). -**BCCBatchMode** false true or false (boolean) Enable BCC Batch Mode. -**BCCBatchSize** 200 None Number of emails in each BCC batch. -**DSN** false true or false (boolean) Enable notify message from server -=================== ====================== ============================ ======================================================================= +=================== =================== ============================ ======================================================================= +Preference Default Value Options Description +=================== =================== ============================ ======================================================================= +**userAgent** CodeIgniter None The "user agent". +**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. +**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.) +**SMTPTimeout** 5 None SMTP Timeout (in seconds). +**SMTPKeepAlive** false ``true``/``false`` (boolean) Enable persistent SMTP connections. +**SMTPCrypto** tls ``tls``, ``ssl``, or SMTP Encryption. Setting this to ``ssl`` will create a secure + empty string (``''``) channel to the server using SSL, and ``tls`` will issue a + ``STARTTLS`` command to the server. Connection on port 465 should + set this to an empty string (``''``). See also + :ref:`email-ssl-tls-for-smtp`. +**wordWrap** true ``true``/``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 + page. Make sure you don't have any relative links or relative image + paths otherwise they will not work. +**charset** utf-8 Character set (``utf-8``, ``iso-8859-1``, etc.). +**validate** true ``true``/``false`` (boolean) Whether to validate the email address. +**priority** 3 1, 2, 3, 4, 5 Email Priority. ``1`` = highest. ``5`` = lowest. ``3`` = normal. +**CRLF** \\n ``\r\n`` or ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822). +**newline** \\n ``\r\n`` or ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822). +**BCCBatchMode** false ``true``/``false`` (boolean) Enable BCC Batch Mode. +**BCCBatchSize** 200 None Number of emails in each BCC batch. +**DSN** false ``true``/``false`` (boolean) Enable notify message from server +=================== =================== ============================ ======================================================================= Overriding Word Wrapping ======================== From e7cee3c17a1102e60ae1612f3c28317408bd487a Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 8 Dec 2023 13:38:37 +0900 Subject: [PATCH 3/4] docs: add missing period --- user_guide_src/source/libraries/email.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst index 88f978b47f5e..e02864e9d2d3 100644 --- a/user_guide_src/source/libraries/email.rst +++ b/user_guide_src/source/libraries/email.rst @@ -139,7 +139,7 @@ Preference Default Value Options Description **newline** \\n ``\r\n`` or ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822). **BCCBatchMode** false ``true``/``false`` (boolean) Enable BCC Batch Mode. **BCCBatchSize** 200 None Number of emails in each BCC batch. -**DSN** false ``true``/``false`` (boolean) Enable notify message from server +**DSN** false ``true``/``false`` (boolean) Enable notify message from server. =================== =================== ============================ ======================================================================= Overriding Word Wrapping From 10923dfc622c002f90d039701f2138c6270df925 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 8 Dec 2023 18:42:39 +0900 Subject: [PATCH 4/4] docs: add text decoration Co-authored-by: Pooya Parsa --- user_guide_src/source/libraries/email.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst index e02864e9d2d3..82439f0cacf6 100644 --- a/user_guide_src/source/libraries/email.rst +++ b/user_guide_src/source/libraries/email.rst @@ -124,7 +124,7 @@ Preference Default Value Options Description **SMTPKeepAlive** false ``true``/``false`` (boolean) Enable persistent SMTP connections. **SMTPCrypto** tls ``tls``, ``ssl``, or SMTP Encryption. Setting this to ``ssl`` will create a secure empty string (``''``) channel to the server using SSL, and ``tls`` will issue a - ``STARTTLS`` command to the server. Connection on port 465 should + ``STARTTLS`` command to the server. Connection on port ``465`` should set this to an empty string (``''``). See also :ref:`email-ssl-tls-for-smtp`. **wordWrap** true ``true``/``false`` (boolean) Enable word-wrap.