Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / b341237fb71f29c7aa591c924742b4693f132593 / . / user_guide / libraries / email.html
blob: eb1d6d08e7b3010b77d75cc2117bb620d7ef52c4 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Email Class</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame^]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Allard60ca9b72007-07-12 19:53:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.5.4</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Email Class
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59<h1>Email Class</h1>
60
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]61<p>CodeIgniter's robust Email Class supports the following features:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]62
63
64<ul>
65<li>Multiple Protocols: Mail, Sendmail, and SMTP</li>
66<li>Multiple recipients</li>
67<li>CC and BCCs</li>
68<li>HTML or Plaintext email</li>
69<li>Attachments</li>
70<li>Word wrapping</li>
71<li>Priorities</li>
72<li>BCC Batch Mode, enabling large email lists to be broken into small BCC batches.</li>
73<li>Email Debugging tools</li>
74</ul>
75
76
77<h2>Sending Email</h2>
78
79<p>Sending email is not only simple, but you can configure it on the fly or set your preferences in a config file.</p>
80
81<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
82<a href="../general/controllers.html">controllers</a>.</p>
83
84<code>$this->load->library('email');<br />
85<br />
86$this->email->from('your@your-site.com', 'Your Name');<br />
Derek Allard487de382007-08-08 17:01:55 +0000[diff] [blame]87$this->email->to('someone@example.com'); <br />
88$this->email->cc('another@another-example.com'); <br />
89$this->email->bcc('them@their-example.com'); <br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]90<br />
91$this->email->subject('Email Test');<br />
92$this->email->message('Testing the email class.'); <br />
93<br />
94$this->email->send();<br />
95<br />
96echo $this->email->print_debugger();</code>
97
98
99
100
101<h2>Setting Email Preferences</h2>
102
103<p>There are 17 different preferences available to tailor how your email messages are sent. You can either set them manually
104as described here, or automatically via preferences stored in your config file, described below:</p>
105
106<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>
107
108<code>$config['protocol'] = 'sendmail';<br />
109$config['mailpath'] = '/usr/sbin/sendmail';<br />
110$config['charset'] = 'iso-8859-1';<br />
111$config['wordwrap'] = TRUE;<br />
112<br />
113$this->email->initialize($config);</code>
114
115<p><strong>Note:</strong> Most of the preferences have default values that will be used if you do not set them.</p
116
Derek Allard394d0b22007-01-29 16:00:28 +0000[diff] [blame]117><h3>Setting Email Preferences in a Config File</h3>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]118
119<p>If you prefer not to set preferences using the above method, you can instead put them into a config file.
Derek Allard7184e312007-02-20 12:34:28 +0000[diff] [blame]120Simply create a new file called the <var>Email.php</var>, add the <var>$config</var>
121array in that file. Then save the file at <var>config/Email.php</var> and it will be used automatically. You
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]122will NOT need to use the <dfn>$this->email->initialize()</dfn> function if you save your preferences in a config file.</p>
123
124
125
126
127<h2>Email Preferences</h2>
128
129<p>The following is a list of all the preferences that can be set when sending email.</p>
130
131
132<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
133<tr>
134<th>Preference</th>
135<th>Default&nbsp;Value</th>
136<th>Options</th>
137<th>Description</th>
138</tr><tr>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]139<td class="td"><strong>useragent</strong></td><td class="td">CodeIgniter</td><td class="td">None</td><td class="td">The "user agent".</td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]140</tr><tr>
141<td class="td"><strong>protocol</strong></td><td class="td">mail</td><td class="td">mail, sendmail, or smtp</td><td class="td">The mail sending protocol.</td>
142</tr><tr>
143<td class="td"><strong>mailpath</strong></td><td class="td">/usr/sbin/sendmail</td><td class="td">None</td><td class="td">The server path to Sendmail.</td>
144</tr><tr>
145<td class="td"><strong>smtp_host</strong></td><td class="td">No Default</td><td class="td">None</td><td class="td">SMTP Server Address.</td>
146</tr><tr>
147<td class="td"><strong>smtp_user</strong></td><td class="td">No Default</td><td class="td">None</td><td class="td">SMTP Username.</td>
148</tr><tr>
149<td class="td"><strong>smtp_pass</strong></td><td class="td">No Default</td><td class="td">None</td><td class="td">SMTP Password.</td>
150</tr><tr>
151<td class="td"><strong>smtp_port</strong></td><td class="td">25</td><td class="td">None</td><td class="td">SMTP Port.</td>
152</tr><tr>
153<td class="td"><strong>smtp_timeout</strong></td><td class="td">5</td><td class="td">None</td><td class="td">SMTP Timeout (in seconds).</td>
154</tr><tr>
155<td class="td"><strong>wordwrap</strong></td><td class="td">TRUE</td><td class="td">TRUE or FALSE (boolean)</td><td class="td">Enable word-wrap.</td>
156</tr><tr>
157<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>
158</tr><tr>
159<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>
160</tr><tr>
161<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>
162</tr><tr>
163<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>
164</tr><tr>
165<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>
166</tr><tr>
167<td class="td"><strong>newline</strong></td><td class="td">\n</td><td class="td">"\r\n" or "\n"</td><td class="td">Newline character. (Use "\r\n" to comply with RFC 822).</td>
168</tr><tr>
169<td class="td"><strong>bcc_batch_mode</strong></td><td class="td">FALSE</td><td class="td">TRUE or FALSE (boolean)</td><td class="td">Enable BCC Batch Mode.</td>
170</tr><tr>
171<td class="td"><strong>bcc_batch_size</strong></td><td class="td">200</td><td class="td">None</td><td class="td">Number of emails in each BCC batch.</td>
172</tr>
173</table>
174
175
176<h2>Email Function Reference</h2>
177
178<h3>$this->email->from()</h3>
179<p>Sets the email address and name of the person sending the email:</p>
180<code>$this->email->from('<var>you@your-site.com</var>', '<var>Your Name</var>');</code>
181
182<h3>$this->email->reply_to()</h3>
183<p>Sets the reply-to address. If the information is not provided the information in the "from" function is used. Example:</p>
184<code>$this->email->reply_to('<var>you@your-site.com</var>', '<var>Your Name</var>');</code>
185
186
187<h3>$this->email->to()</h3>
188<p>Sets the email address(s) of the recipient(s). Can be a single email, a comma-delimited list or an array:</p>
189
Derek Allard487de382007-08-08 17:01:55 +0000[diff] [blame]190<code>$this->email->to('<var>someone@example.com</var>');</code>
191<code>$this->email->to('<var>one@example.com</var>, <var>two@example.com</var>, <var>three@example.com</var>');</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]192
Derek Allard487de382007-08-08 17:01:55 +0000[diff] [blame]193<code>$list = array('<var>one@example.com</var>', '<var>two@example.com</var>', '<var>three@example.com</var>');<br />
194<br />
Derek Allard394d0b22007-01-29 16:00:28 +0000[diff] [blame]195$this->email->to(<var>$list</var>);</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]196
197<h3>$this->email->cc()</h3>
198<p>Sets the CC email address(s). Just like the "to", can be a single email, a comma-delimited list or an array.</p>
199
200<h3>$this->email->bcc()</h3>
201<p>Sets the BCC email address(s). Just like the "to", can be a single email, a comma-delimited list or an array.</p>
202
203
204<h3>$this->email->subject()</h3>
205<p>Sets the email subject:</p>
206<code>$this->email->subject('<var>This is my subject</var>');</code>
207
208<h3>$this->email->message()</h3>
209<p>Sets the email message body:</p>
210<code>$this->email->message('<var>This is my message</var>');</code>
211
admin83b05a82006-09-25 21:06:46 +0000[diff] [blame]212<h3>$this->email->set_alt_message()</h3>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]213<p>Sets the alternative email message body:</p>
admin83b05a82006-09-25 21:06:46 +0000[diff] [blame]214<code>$this->email->set_alt_message('<var>This is the alternative message</var>');</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]215
216<p>This is an optional message string which can be used if you send HTML formatted email. It lets you specify an alternative
admine334c472006-10-21 19:44:22 +0000[diff] [blame]217message with no HTML formatting which is added to the header string for people who do not accept HTML email.
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]218If you do not set your own message CodeIgniter will extract the message from your HTML email and strip the tags.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]219
220
221
222<h3>$this->email->clear()</h3>
223<p>Initializes all the email variables to an empty state. This function is intended for use if you run the email sending function
224in a loop, permitting the data to be reset between cycles.</p>
225<code>foreach ($list as $name => $address)<br />
226{<br />
227&nbsp;&nbsp;&nbsp;&nbsp;$this->email->clear();<br /><br />
228
229&nbsp;&nbsp;&nbsp;&nbsp;$this->email->to($address);<br />
230&nbsp;&nbsp;&nbsp;&nbsp;$this->email->from('your@your-site.com');<br />
231&nbsp;&nbsp;&nbsp;&nbsp;$this->email->subject('Here is your info '.$name);<br />
232&nbsp;&nbsp;&nbsp;&nbsp;$this->email->message('Hi '.$name.' Here is the info you requested.');<br />
233&nbsp;&nbsp;&nbsp;&nbsp;$this->email->send();<br />
234}</code>
235
adminec5a5a62006-09-21 00:45:03 +0000[diff] [blame]236<p>If you set the parameter to TRUE any attachments will be cleared as well:</p>
237
238<code>$this->email->clear(TRUE);</code>
239
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]240
241<h3>$this->email->send()</h3>
adminec5a5a62006-09-21 00:45:03 +0000[diff] [blame]242<p>The Email sending function. Returns boolean TRUE or FALSE based on success or failure, enabling it to be used
243conditionally:</p>
244
245<code>if ( ! $this->email->send())<br />
246{<br />
247&nbsp;&nbsp;&nbsp;&nbsp;// Generate error<br />
248}</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]249
250
251<h3>$this->email->attach()</h3>
252<p>Enables you to send an attachment. Put the file path/name in the first parameter. Note: Use a file path, not a URL.
253For multiple attachments use the function multiple times. For example:</p>
254
255<code>$this->email->attach('/path/to/photo1.jpg');<br />
256$this->email->attach('/path/to/photo2.jpg');<br />
257$this->email->attach('/path/to/photo3.jpg');<br />
258<br />
259$this->email->send();</code>
260
261
262<h3>$this->email->print_debugger()</h3>
263<p>Returns a string containing any server messages, the email headers, and the email messsage. Useful for debugging.</p>
264
265
266<h2>Overriding Word Wrapping</h2>
267
268<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
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]269get wrapped too, causing it to become un-clickable by the person receiving it. CodeIgniter lets you manually override
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]270word wrapping within part of your message like this:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]271
272<code>The text of your email that<br />
273gets wrapped normally.<br />
274<br />
Derek Allard487de382007-08-08 17:01:55 +0000[diff] [blame]275<var>{unwrap}</var>http://www.example.com/a_long_link_that_should_not_be_wrapped.html<var>{/unwrap}</var><br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]276<br />
277More text that will be<br />
278wrapped normally.</code>
279
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]280<p>Place the item you do not want word-wrapped between: <var>{unwrap}</var> <var>{/unwrap}</var></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]281
282
283</div>
284<!-- END CONTENT -->
285
286
287<div id="footer">
288<p>
289Previous Topic:&nbsp;&nbsp;<a href="database/index.html">Database Class</a>
290&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
291<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
292<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
293Next Topic:&nbsp;&nbsp;<a href="encryption.html">Encryption Class</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]294</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]295<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]296</div>
297
298</body>
299</html>