Skip to content

Commit 9acc52d

Browse files
author
obozdag
authored
docs: Fix typos and add missing preferences in libraries/email.rst
Fix typos and add missing preferences in libraries/email.rst
1 parent c23bc4c commit 9acc52d

File tree

1 file changed

+48
-44
lines changed

1 file changed

+48
-44
lines changed

‎user_guide_src/source/libraries/email.rst‎

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

147151
Overriding Word Wrapping
@@ -173,9 +177,9 @@ Class Reference
173177
174178
.. php:method:: setFrom($from[, $name = ''[, $returnPath = null]])
175179
176-
:param string $from: "From" e-mail address
180+
:param string $from: "From" email address
177181
:param string $name: "From" display name
178-
:param string $returnPath: Optional email address to redirect undelivered e-mail to
182+
:param string $returnPath: Optional email address to redirect undelivered email to
179183
:returns: CodeIgniter\\Email\\Email instance (method chaining)
180184
:rtype: CodeIgniter\\Email\\Email
181185

@@ -192,8 +196,8 @@ Class Reference
192196

193197
.. php:method:: setReplyTo($replyto[, $name = ''])
194198
195-
:param string $replyto: E-mail address for replies
196-
:param string $name: Display name for the reply-to e-mail address
199+
:param string $replyto: Email address for replies
200+
:param string $name: Display name for the reply-to email address
197201
:returns: CodeIgniter\\Email\\Email instance (method chaining)
198202
:rtype: CodeIgniter\\Email\\Email
199203

@@ -204,12 +208,12 @@ Class Reference
204208

205209
.. php:method:: setTo($to)
206210
207-
:param mixed $to: Comma-delimited string or an array of e-mail addresses
211+
:param mixed $to: Comma separated string or an array of email addresses
208212
:returns: CodeIgniter\\Email\\Email instance (method chaining)
209213
:rtype: CodeIgniter\\Email\\Email
210214

211-
Sets the email address(s) of the recipient(s). Can be a single e-mail,
212-
a comma-delimited list or an array:
215+
Sets the email address(es) of the recipient(s). Can be a single email,
216+
a comma separated list or an array:
213217

214218
.. literalinclude:: email/006.php
215219

@@ -219,30 +223,30 @@ Class Reference
219223

220224
.. php:method:: setCC($cc)
221225
222-
:param mixed $cc: Comma-delimited string or an array of e-mail addresses
226+
:param mixed $cc: Comma separated string or an array of email addresses
223227
:returns: CodeIgniter\\Email\\Email instance (method chaining)
224228
:rtype: CodeIgniter\\Email\\Email
225229

226-
Sets the CC email address(s). Just like the "to", can be a single e-mail,
227-
a comma-delimited list or an array.
230+
Sets the CC email address(es). Just like the "to", can be a single email,
231+
a comma separated list or an array.
228232

229233
.. php:method:: setBCC($bcc[, $limit = ''])
230234
231-
:param mixed $bcc: Comma-delimited string or an array of e-mail addresses
232-
:param int $limit: Maximum number of e-mails to send per batch
235+
:param mixed $bcc: Comma separated string or an array of email addresses
236+
:param int $limit: Maximum number of emails to send per batch
233237
:returns: CodeIgniter\\Email\\Email instance (method chaining)
234238
:rtype: CodeIgniter\\Email\\Email
235239

236-
Sets the BCC email address(s). Just like the ``setTo()`` method, can be a single
237-
e-mail, a comma-delimited list or an array.
240+
Sets the BCC email address(es). Just like the ``setTo()`` method, can be a single
241+
email, a comma separated list or an array.
238242

239243
If ``$limit`` is set, "batch mode" will be enabled, which will send
240244
the emails to batches, with each batch not exceeding the specified
241245
``$limit``.
242246

243247
.. php:method:: setSubject($subject)
244248
245-
:param string $subject: E-mail subject line
249+
:param string $subject: Email subject line
246250
:returns: CodeIgniter\\Email\\Email instance (method chaining)
247251
:rtype: CodeIgniter\\Email\\Email
248252

@@ -252,21 +256,21 @@ Class Reference
252256

253257
.. php:method:: setMessage($body)
254258
255-
:param string $body: E-mail message body
259+
:param string $body: Email message body
256260
:returns: CodeIgniter\\Email\\Email instance (method chaining)
257261
:rtype: CodeIgniter\\Email\\Email
258262

259-
Sets the e-mail message body:
263+
Sets the email message body:
260264

261265
.. literalinclude:: email/010.php
262266

263267
.. php:method:: setAltMessage($str)
264268
265-
:param string $str: Alternative e-mail message body
269+
:param string $str: Alternative email message body
266270
:returns: CodeIgniter\\Email\\Email instance (method chaining)
267271
:rtype: CodeIgniter\\Email\\Email
268272

269-
Sets the alternative e-mail message body:
273+
Sets the alternative email message body:
270274

271275
.. literalinclude:: email/011.php
272276

@@ -284,7 +288,7 @@ Class Reference
284288
:returns: CodeIgniter\\Email\\Email instance (method chaining)
285289
:rtype: CodeIgniter\\Email\\Email
286290

287-
Appends additional headers to the e-mail:
291+
Appends additional headers to the email:
288292

289293
.. literalinclude:: email/012.php
290294

@@ -311,7 +315,7 @@ Class Reference
311315
:returns: true on success, false on failure
312316
:rtype: bool
313317

314-
The e-mail sending method. Returns boolean true or false based on
318+
The email sending method. Returns boolean true or false based on
315319
success or failure, enabling it to be used conditionally:
316320

317321
.. literalinclude:: email/015.php
@@ -334,7 +338,7 @@ Class Reference
334338
:param string $disposition: 'disposition' of the attachment. Most
335339
email clients make their own decision regardless of the MIME
336340
specification used here. https://www.iana.org/assignments/cont-disp/cont-disp.xhtml
337-
:param string $newname: Custom file name to use in the e-mail
341+
:param string $newname: Custom file name to use in the email
338342
:param string $mime: MIME type to use (useful for buffered data)
339343
:returns: CodeIgniter\\Email\\Email instance (method chaining)
340344
:rtype: CodeIgniter\\Email\\Email
@@ -375,7 +379,7 @@ Class Reference
375379

376380
.. literalinclude:: email/022.php
377381

378-
.. note:: Content-ID for each e-mail must be re-created for it to be unique.
382+
.. note:: Content-ID for each email must be re-created for it to be unique.
379383

380384
.. php:method:: printDebugger($include = ['headers', 'subject', 'body'])
381385

0 commit comments

Comments
 (0)