Skip to content

Commit 8eb777e

Browse files
authored
docs: Remove $ marks in libraries/email.rst
Remove $ marks in Preference in libraries/email.rst
1 parent 611e701 commit 8eb777e

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

user_guide_src/source/libraries/email.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -113,37 +113,37 @@ sending email.
113113
=================== =================== ============================ =======================================================================
114114
Preference Default Value Options Description
115115
=================== =================== ============================ =======================================================================
116-
**$fromEmail** The email address to be set in the "from" header.
117-
**$fromName** The name to be set in the "from" header.
118-
**$userAgent** CodeIgniter The "user agent".
119-
**$protocol** mail ``mail``, ``sendmail``, The mail sending protocol.
116+
**fromEmail** The email address to be set in the "from" header.
117+
**fromName** The name to be set in the "from" header.
118+
**userAgent** CodeIgniter The "user agent".
119+
**protocol** mail ``mail``, ``sendmail``, The mail sending protocol.
120120
or ``smtp``
121-
**$mailPath** /usr/sbin/sendmail The server path to Sendmail.
122-
**$SMTPHost** SMTP Server Hostname.
123-
**$SMTPUser** SMTP Username.
124-
**$SMTPPass** SMTP Password.
125-
**$SMTPPort** 25 SMTP Port. (If set to ``465``, TLS will be used for the connection
121+
**mailPath** /usr/sbin/sendmail The server path to Sendmail.
122+
**SMTPHost** SMTP Server Hostname.
123+
**SMTPUser** SMTP Username.
124+
**SMTPPass** SMTP Password.
125+
**SMTPPort** 25 SMTP Port. (If set to ``465``, TLS will be used for the connection
126126
regardless of ``SMTPCrypto`` setting.)
127-
**$SMTPTimeout** 5 SMTP Timeout (in seconds).
128-
**$SMTPKeepAlive** false ``true``/``false`` Enable persistent SMTP connections.
129-
**$SMTPCrypto** tls ``tls``, ``ssl``, or SMTP Encryption. Setting this to ``ssl`` will create a secure
127+
**SMTPTimeout** 5 SMTP Timeout (in seconds).
128+
**SMTPKeepAlive** false ``true``/``false`` Enable persistent SMTP connections.
129+
**SMTPCrypto** tls ``tls``, ``ssl``, or SMTP Encryption. Setting this to ``ssl`` will create a secure
130130
empty string (``''``) channel to the server using SSL, and ``tls`` will issue a
131131
``STARTTLS`` command to the server. Connection on port ``465`` should
132132
set this to an empty string (``''``). See also
133133
:ref:`email-ssl-tls-for-smtp`.
134-
**$wordWrap** true ``true``/``false`` Enable word-wrap.
135-
**$wrapChars** 76 Character count to wrap at.
136-
**$mailType** text ``text`` or ``html`` Type of mail. If you send HTML email you must send it as a complete web
134+
**wordWrap** true ``true``/``false`` Enable word-wrap.
135+
**wrapChars** 76 Character count to wrap at.
136+
**mailType** text ``text`` or ``html`` Type of mail. If you send HTML email you must send it as a complete web
137137
page. Make sure you don't have any relative links or relative image
138138
paths otherwise they will not work.
139-
**$charset** UTF-8 Character set (``utf-8``, ``iso-8859-1``, etc.).
140-
**$validate** true ``true``/``false`` Whether to validate the email address.
141-
**$priority** 3 1, 2, 3, 4, 5 Email Priority. ``1`` = highest. ``5`` = lowest. ``3`` = normal.
142-
**$CRLF** \\r\\n ``\r\n``, ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822).
143-
**$newline** \\r\\n ``\r\n``, ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822).
144-
**$BCCBatchMode** false ``true``/``false`` Enable BCC Batch Mode.
145-
**$BCCBatchSize** 200 Number of emails in each BCC batch.
146-
**$DSN** false ``true``/``false`` Enable notify message from server.
139+
**charset** UTF-8 Character set (``utf-8``, ``iso-8859-1``, etc.).
140+
**validate** true ``true``/``false`` Whether to validate the email address.
141+
**priority** 3 1, 2, 3, 4, 5 Email Priority. ``1`` = highest. ``5`` = lowest. ``3`` = normal.
142+
**CRLF** \\r\\n ``\r\n``, ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822).
143+
**newline** \\r\\n ``\r\n``, ``\n`` or ``\r`` Newline character. (Use ``\r\n`` to comply with RFC 822).
144+
**BCCBatchMode** false ``true``/``false`` Enable BCC Batch Mode.
145+
**BCCBatchSize** 200 Number of emails in each BCC batch.
146+
**DSN** false ``true``/``false`` Enable notify message from server.
147147
=================== =================== ============================ =======================================================================
148148

149149
Overriding Word Wrapping

0 commit comments

Comments
 (0)