Skip to content

docs: improve email.rst #8309

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

Merged
merged 4 commits into from
Dec 8, 2023
Merged

docs: improve email.rst #8309

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d96fc5
docs: add link to section
kenjis Dec 8, 2023
ee7e590
docs: improve readability
kenjis Dec 8, 2023
e7cee3c
docs: add missing period
kenjis Dec 8, 2023
10923df
docs: add text decoration
kenjis Dec 8, 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
67 changes: 34 additions & 33 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 @@ -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
---------------------------------------------
Expand Down Expand Up @@ -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
========================
Expand Down