Skip to content

Commit 8d18ea7

Browse files
kenjiskenjis
authored
Merge pull request #8851 from obozdag/patch-1
docs: Fix typos and add missing preferences in libraries/email.rst
2 parents 5fc03b7 + 8eb777e commit 8d18ea7

File tree

1 file changed

+41
-39
lines changed

1 file changed

+41
-39
lines changed

‎user_guide_src/source/libraries/email.rst‎

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -113,35 +113,37 @@ sending email.
113113
=================== =================== ============================ =======================================================================
114114
Preference Default Value Options Description
115115
=================== =================== ============================ =======================================================================
116-
**userAgent** CodeIgniter None The "user agent".
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".
117119
**protocol** mail ``mail``, ``sendmail``, The mail sending protocol.
118120
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
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
124126
regardless of ``SMTPCrypto`` setting.)
125-
**SMTPTimeout** 5 None SMTP Timeout (in seconds).
126-
**SMTPKeepAlive** false ``true``/``false`` (boolean) Enable persistent SMTP connections.
127+
**SMTPTimeout** 5 SMTP Timeout (in seconds).
128+
**SMTPKeepAlive** false ``true``/``false`` Enable persistent SMTP connections.
127129
**SMTPCrypto** tls ``tls``, ``ssl``, or SMTP Encryption. Setting this to ``ssl`` will create a secure
128130
empty string (``''``) channel to the server using SSL, and ``tls`` will issue a
129131
``STARTTLS`` command to the server. Connection on port ``465`` should
130132
set this to an empty string (``''``). See also
131133
:ref:`email-ssl-tls-for-smtp`.
132-
**wordWrap** true ``true``/``false`` (boolean) Enable word-wrap.
134+
**wordWrap** true ``true``/``false`` Enable word-wrap.
133135
**wrapChars** 76 Character count to wrap at.
134136
**mailType** text ``text`` or ``html`` Type of mail. If you send HTML email you must send it as a complete web
135137
page. Make sure you don't have any relative links or relative image
136138
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+
**charset** UTF-8 Character set (``utf-8``, ``iso-8859-1``, etc.).
140+
**validate** true ``true``/``false`` Whether to validate the email address.
139141
**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.
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.
145147
=================== =================== ============================ =======================================================================
146148

147149
Overriding Word Wrapping
@@ -173,9 +175,9 @@ Class Reference
173175
174176
.. php:method:: setFrom($from[, $name = ''[, $returnPath = null]])
175177
176-
:param string $from: "From" e-mail address
178+
:param string $from: "From" email address
177179
:param string $name: "From" display name
178-
:param string $returnPath: Optional email address to redirect undelivered e-mail to
180+
:param string $returnPath: Optional email address to redirect undelivered email to
179181
:returns: CodeIgniter\\Email\\Email instance (method chaining)
180182
:rtype: CodeIgniter\\Email\\Email
181183

@@ -192,8 +194,8 @@ Class Reference
192194

193195
.. php:method:: setReplyTo($replyto[, $name = ''])
194196
195-
:param string $replyto: E-mail address for replies
196-
:param string $name: Display name for the reply-to e-mail address
197+
:param string $replyto: Email address for replies
198+
:param string $name: Display name for the reply-to email address
197199
:returns: CodeIgniter\\Email\\Email instance (method chaining)
198200
:rtype: CodeIgniter\\Email\\Email
199201

@@ -204,12 +206,12 @@ Class Reference
204206

205207
.. php:method:: setTo($to)
206208
207-
:param mixed $to: Comma-delimited string or an array of e-mail addresses
209+
:param mixed $to: Comma separated string or an array of email addresses
208210
:returns: CodeIgniter\\Email\\Email instance (method chaining)
209211
:rtype: CodeIgniter\\Email\\Email
210212

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

214216
.. literalinclude:: email/006.php
215217

@@ -219,30 +221,30 @@ Class Reference
219221

220222
.. php:method:: setCC($cc)
221223
222-
:param mixed $cc: Comma-delimited string or an array of e-mail addresses
224+
:param mixed $cc: Comma separated string or an array of email addresses
223225
:returns: CodeIgniter\\Email\\Email instance (method chaining)
224226
:rtype: CodeIgniter\\Email\\Email
225227

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.
228+
Sets the CC email address(es). Just like the "to", can be a single email,
229+
a comma separated list or an array.
228230

229231
.. php:method:: setBCC($bcc[, $limit = ''])
230232
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
233+
:param mixed $bcc: Comma separated string or an array of email addresses
234+
:param int $limit: Maximum number of emails to send per batch
233235
:returns: CodeIgniter\\Email\\Email instance (method chaining)
234236
:rtype: CodeIgniter\\Email\\Email
235237

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.
238+
Sets the BCC email address(es). Just like the ``setTo()`` method, can be a single
239+
email, a comma separated list or an array.
238240

239241
If ``$limit`` is set, "batch mode" will be enabled, which will send
240242
the emails to batches, with each batch not exceeding the specified
241243
``$limit``.
242244

243245
.. php:method:: setSubject($subject)
244246
245-
:param string $subject: E-mail subject line
247+
:param string $subject: Email subject line
246248
:returns: CodeIgniter\\Email\\Email instance (method chaining)
247249
:rtype: CodeIgniter\\Email\\Email
248250

@@ -252,21 +254,21 @@ Class Reference
252254

253255
.. php:method:: setMessage($body)
254256
255-
:param string $body: E-mail message body
257+
:param string $body: Email message body
256258
:returns: CodeIgniter\\Email\\Email instance (method chaining)
257259
:rtype: CodeIgniter\\Email\\Email
258260

259-
Sets the e-mail message body:
261+
Sets the email message body:
260262

261263
.. literalinclude:: email/010.php
262264

263265
.. php:method:: setAltMessage($str)
264266
265-
:param string $str: Alternative e-mail message body
267+
:param string $str: Alternative email message body
266268
:returns: CodeIgniter\\Email\\Email instance (method chaining)
267269
:rtype: CodeIgniter\\Email\\Email
268270

269-
Sets the alternative e-mail message body:
271+
Sets the alternative email message body:
270272

271273
.. literalinclude:: email/011.php
272274

@@ -284,7 +286,7 @@ Class Reference
284286
:returns: CodeIgniter\\Email\\Email instance (method chaining)
285287
:rtype: CodeIgniter\\Email\\Email
286288

287-
Appends additional headers to the e-mail:
289+
Appends additional headers to the email:
288290

289291
.. literalinclude:: email/012.php
290292

@@ -311,7 +313,7 @@ Class Reference
311313
:returns: true on success, false on failure
312314
:rtype: bool
313315

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

317319
.. literalinclude:: email/015.php
@@ -334,7 +336,7 @@ Class Reference
334336
:param string $disposition: 'disposition' of the attachment. Most
335337
email clients make their own decision regardless of the MIME
336338
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
339+
:param string $newname: Custom file name to use in the email
338340
:param string $mime: MIME type to use (useful for buffered data)
339341
:returns: CodeIgniter\\Email\\Email instance (method chaining)
340342
:rtype: CodeIgniter\\Email\\Email
@@ -375,7 +377,7 @@ Class Reference
375377

376378
.. literalinclude:: email/022.php
377379

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

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

0 commit comments

Comments
 (0)