diff options
Diffstat (limited to 'user_guide/libraries/email.html')
| -rw-r--r-- | user_guide/libraries/email.html | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/user_guide/libraries/email.html b/user_guide/libraries/email.html index 357c01ff1..61e139187 100644 --- a/user_guide/libraries/email.html +++ b/user_guide/libraries/email.html @@ -28,7 +28,7 @@ <div id="masthead"> <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> <tr> -<td><h1>CodeIgniter User Guide Version 2.0.1</h1></td> +<td><h1>CodeIgniter User Guide Version 2.0.2</h1></td> <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> </tr> </table> @@ -78,7 +78,7 @@ Email Class <p>Sending email is not only simple, but you can configure it on the fly or set your preferences in a config file.</p> -<p>Here is a basic example demonstrating how you might send email. Note: This example assumes you are sending the email from one of your +<p>Here is a basic example demonstrating how you might send email. Note: This example assumes you are sending the email from one of your <a href="../general/controllers.html">controllers</a>.</p> <code>$this->load->library('email');<br /> @@ -103,7 +103,7 @@ echo $this->email->print_debugger();</code> <p>There are 17 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:</p> -<p>Preferences are set by passing an array of preference values to the email <dfn>initialize</dfn> function. Here is an example of how you might set some preferences:</p> +<p>Preferences are set by passing an array of preference values to the email <dfn>initialize</dfn> function. Here is an example of how you might set some preferences:</p> <code>$config['protocol'] = 'sendmail';<br /> $config['mailpath'] = '/usr/sbin/sendmail';<br /> @@ -117,7 +117,7 @@ $this->email->initialize($config);</code> ><h3>Setting Email Preferences in a Config File</h3> <p>If you prefer not to set preferences using the above method, you can instead put them into a config file. -Simply create a new file called the <var>email.php</var>, add the <var>$config</var> +Simply create a new file called the <var>email.php</var>, add the <var>$config</var> array in that file. Then save the file at <var>config/email.php</var> and it will be used automatically. You will NOT need to use the <dfn>$this->email->initialize()</dfn> function if you save your preferences in a config file.</p> @@ -156,13 +156,13 @@ will NOT need to use the <dfn>$this->email->initialize()</dfn> function if you s </tr><tr> <td class="td"><strong>wrapchars</strong></td><td class="td">76</td><td class="td"> </td><td class="td">Character count to wrap at.</td> </tr><tr> -<td class="td"><strong>mailtype</strong></td><td class="td">text</td><td class="td">text or html</td><td class="td">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.</td> +<td class="td"><strong>mailtype</strong></td><td class="td">text</td><td class="td">text or html</td><td class="td">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.</td> </tr><tr> <td class="td"><strong>charset</strong></td><td class="td">utf-8</td><td class="td"></td><td class="td">Character set (utf-8, iso-8859-1, etc.).</td> </tr><tr> -<td class="td"><strong>validate</strong></td><td class="td">FALSE</td><td class="td">TRUE or FALSE (boolean)</td><td class="td">Whether to validate the email address.</td> +<td class="td"><strong>validate</strong></td><td class="td">FALSE</td><td class="td">TRUE or FALSE (boolean)</td><td class="td">Whether to validate the email address.</td> </tr><tr> -<td class="td"><strong>priority</strong></td><td class="td">3</td><td class="td">1, 2, 3, 4, 5</td><td class="td">Email Priority. 1 = highest. 5 = lowest. 3 = normal.</td> +<td class="td"><strong>priority</strong></td><td class="td">3</td><td class="td">1, 2, 3, 4, 5</td><td class="td">Email Priority. 1 = highest. 5 = lowest. 3 = normal.</td> </tr> <tr> <td class="td"><strong>crlf</strong></td> @@ -188,12 +188,12 @@ will NOT need to use the <dfn>$this->email->initialize()</dfn> function if you s <code>$this->email->from('<var>you@example.com</var>', '<var>Your Name</var>');</code> <h3>$this->email->reply_to()</h3> -<p>Sets the reply-to address. If the information is not provided the information in the "from" function is used. Example:</p> +<p>Sets the reply-to address. If the information is not provided the information in the "from" function is used. Example:</p> <code>$this->email->reply_to('<var>you@example.com</var>', '<var>Your Name</var>');</code> <h3>$this->email->to()</h3> -<p>Sets the email address(s) of the recipient(s). Can be a single email, a comma-delimited list or an array:</p> +<p>Sets the email address(s) of the recipient(s). Can be a single email, a comma-delimited list or an array:</p> <code>$this->email->to('<var>someone@example.com</var>');</code> <code>$this->email->to('<var>one@example.com</var>, <var>two@example.com</var>, <var>three@example.com</var>');</code> @@ -221,14 +221,14 @@ $this->email->to(<var>$list</var>);</code> <p>Sets the alternative email message body:</p> <code>$this->email->set_alt_message('<var>This is the alternative message</var>');</code> -<p>This is an optional message string which can be used if you send HTML formatted email. It lets you specify an alternative +<p>This is an optional message string which can be used if you send HTML formatted email. It lets you specify an alternative message with no HTML formatting which is added to the header string for people who do not accept HTML email. If you do not set your own message CodeIgniter will extract the message from your HTML email and strip the tags.</p> <h3>$this->email->clear()</h3> -<p>Initializes all the email variables to an empty state. This function is intended for use if you run the email sending function +<p>Initializes all the email variables to an empty state. This function is intended for use if you run the email sending function in a loop, permitting the data to be reset between cycles.</p> <code>foreach ($list as $name => $address)<br /> {<br /> @@ -268,13 +268,13 @@ $this->email->send();</code> <h3>$this->email->print_debugger()</h3> -<p>Returns a string containing any server messages, the email headers, and the email messsage. Useful for debugging.</p> +<p>Returns a string containing any server messages, the email headers, and the email messsage. Useful for debugging.</p> <h2>Overriding Word Wrapping</h2> <p>If you have word wrapping enabled (recommended to comply with RFC 822) and you have a very long link in your email it can -get wrapped too, causing it to become un-clickable by the person receiving it. CodeIgniter lets you manually override +get wrapped too, causing it to become un-clickable by the person receiving it. CodeIgniter lets you manually override word wrapping within part of your message like this:</p> <code>The text of your email that<br /> |