Skip to content

Commit e91e5b6

Browse files
kenjiskenjis
authored
Merge pull request #8309 from kenjis/docs-email.rst
docs: improve email.rst
2 parents a37ae72 + 10923df commit e91e5b6

File tree

1 file changed

+34
-33
lines changed

1 file changed

+34
-33
lines changed

‎user_guide_src/source/libraries/email.rst‎

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Setting Email Preferences
4242
There are 21 different preferences available to tailor how your email
4343
messages are sent. You can either set them manually as described here,
4444
or automatically via preferences stored in your config file, described
45-
below:
45+
in `Email Preferences`_.
4646

4747
Setting Email Preferences by Passing an Array
4848
---------------------------------------------
@@ -108,38 +108,39 @@ Email Preferences
108108
The following is a list of all the preferences that can be set when
109109
sending email.
110110

111-
=================== ====================== ============================ =======================================================================
112-
Preference Default Value Options Description
113-
=================== ====================== ============================ =======================================================================
114-
**userAgent** CodeIgniter None The "user agent".
115-
**protocol** mail mail, sendmail, or smtp The mail sending protocol.
116-
**mailPath** /usr/sbin/sendmail None The server path to Sendmail.
117-
**SMTPHost** No Default None SMTP Server Address.
118-
**SMTPUser** No Default None SMTP Username.
119-
**SMTPPass** No Default None SMTP Password.
120-
**SMTPPort** 25 None SMTP Port. (If set to ``465``, TLS will be used for the connection
121-
regardless of ``SMTPCrypto`` setting.)
122-
**SMTPTimeout** 5 None SMTP Timeout (in seconds).
123-
**SMTPKeepAlive** false true or false (boolean) Enable persistent SMTP connections.
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
126-
``STARTTLS`` command to the server. Connection on port 465 should
127-
set this to an empty string (``''``). See also
128-
:ref:`email-ssl-tls-for-smtp`.
129-
**wordWrap** true true or false (boolean) Enable word-wrap.
130-
**wrapChars** 76 Character count to wrap at.
131-
**mailType** text text or html Type of mail. If you send HTML email you must send it as a complete web
132-
page. Make sure you don't have any relative links or relative image
133-
paths otherwise they will not work.
134-
**charset** utf-8 Character set (utf-8, iso-8859-1, etc.).
135-
**validate** true true or false (boolean) Whether to validate the email address.
136-
**priority** 3 1, 2, 3, 4, 5 Email Priority. 1 = highest. 5 = lowest. 3 = normal.
137-
**CRLF** \\n "\\r\\n" or "\\n" or "\\r" Newline character. (Use "\\r\\n" to comply with RFC 822).
138-
**newline** \\n "\\r\\n" or "\\n" or "\\r" Newline character. (Use "\\r\\n" to comply with RFC 822).
139-
**BCCBatchMode** false true or false (boolean) Enable BCC Batch Mode.
140-
**BCCBatchSize** 200 None Number of emails in each BCC batch.
141-
**DSN** false true or false (boolean) Enable notify message from server
142-
=================== ====================== ============================ =======================================================================
111+
=================== =================== ============================ =======================================================================
112+
Preference Default Value Options Description
113+
=================== =================== ============================ =======================================================================
114+
**userAgent** CodeIgniter None The "user agent".
115+
**protocol** mail ``mail``, ``sendmail``, The mail sending protocol.
116+
or ``smtp``
117+
**mailPath** /usr/sbin/sendmail None The server path to Sendmail.
118+
**SMTPHost** No Default None SMTP Server Address.
119+
**SMTPUser** No Default None SMTP Username.
120+
**SMTPPass** No Default None SMTP Password.
121+
**SMTPPort** 25 None SMTP Port. (If set to ``465``, TLS will be used for the connection
122+
regardless of ``SMTPCrypto`` setting.)
123+
**SMTPTimeout** 5 None SMTP Timeout (in seconds).
124+
**SMTPKeepAlive** false ``true``/``false`` (boolean) Enable persistent SMTP connections.
125+
**SMTPCrypto** tls ``tls``, ``ssl``, or SMTP Encryption. Setting this to ``ssl`` will create a secure
126+
empty string (``''``) channel to the server using SSL, and ``tls`` will issue a
127+
``STARTTLS`` command to the server. Connection on port ``465`` should
128+
set this to an empty string (``''``). See also
129+
:ref:`email-ssl-tls-for-smtp`.
130+
**wordWrap** true ``true``/``false`` (boolean) Enable word-wrap.
131+
**wrapChars** 76 Character count to wrap at.
132+
**mailType** text ``text`` or ``html`` Type of mail. If you send HTML email you must send it as a complete web
133+
page. Make sure you don't have any relative links or relative image
134+
paths otherwise they will not work.
135+
**charset** utf-8 Character set (``utf-8``, ``iso-8859-1``, etc.).
136+
**validate** true ``true``/``false`` (boolean) Whether to validate the email address.
137+
**priority** 3 1, 2, 3, 4, 5 Email Priority. ``1`` = highest. ``5`` = lowest. ``3`` = normal.
138+
**CRLF** \\n ``\r\n`` or ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822).
139+
**newline** \\n ``\r\n`` or ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822).
140+
**BCCBatchMode** false ``true``/``false`` (boolean) Enable BCC Batch Mode.
141+
**BCCBatchSize** 200 None Number of emails in each BCC batch.
142+
**DSN** false ``true``/``false`` (boolean) Enable notify message from server.
143+
=================== =================== ============================ =======================================================================
143144

144145
Overriding Word Wrapping
145146
========================

0 commit comments

Comments
 (0)