Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 466039ab97e67a23168798731084d4127c7f30a1 / . / user_guide / helpers / email_helper.html
blob: 40edce8220db1b4946d0c3cd9aaf03769eea063d [file] [log] [blame]
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]3<head>
4
Derek Allard78c3fa82008-01-21 15:11:13 +0000[diff] [blame]5<title>CodeIgniter User Guide : Email Helper</title>
Derek Allard5a34f042008-01-19 19:41:54 +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
10<script type="text/javascript" src="../nav/nav.js"></script>
11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
12<script type="text/javascript" src="../nav/moo.fx.js"></script>
13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
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='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
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 Allard067f2cc2008-02-04 22:12:03 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.1</h1></td>
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40
41<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
42<tr>
43<td id="breadcrumb">
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]44<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]45<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
46Download Helper
47</td>
48<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>
49</tr>
50</table>
51<!-- END BREADCRUMB -->
52
53<br clear="all" />
54
55
56<!-- START CONTENT -->
57<div id="content">
58
59
Derek Allard78c3fa82008-01-21 15:11:13 +0000[diff] [blame]60<h1>Email Helper</h1>
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]61
Derek Allard952402a2008-01-22 16:37:04 +0000[diff] [blame]62<p>The Email Helper provides some assistive functions for working with Email. For a more robust email solution, see CodeIgniter's <a href="../libraries/email.html">Email Class</a>.</p>
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]63
64<h2>Loading this Helper</h2>
65
66<p>This helper is loaded using the following code:</p>
Derek Allard78c3fa82008-01-21 15:11:13 +0000[diff] [blame]67<p><code>$this->load->helper('email');</code></p>
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]68
69<p>The following functions are available:</p>
70
71<h2>valid_email('<var>email</var>')</h2>
72
73<p>Checks if an email is a correctly formatted email. Note that is doesn't actually prove the email will recieve mail, simply that it is a validly formed address.</p>
74<p>It returns TRUE/FALSE</p>
75<code> $this-&gt;load-&gt;helper(email);<br />
76<br />
77if (valid_email('email@somesite.com'))<br />
78{<br />
79&nbsp;&nbsp;&nbsp;&nbsp;echo 'email is valid';<br />
80}<br />
81else<br />
82{<br />
83&nbsp;&nbsp;&nbsp;&nbsp;echo 'email is not valid';<br />
84}</code>
85<h2>send_email('<var>recipient</var>', '<var>subject</var>', '<var>message</var>')</h2>
86<p>Sends an email using PHP's native <a href="http://www.php.net/function.mail">mail()</a> function. For a more robust email solution, see CodeIgniter's <a href="../libraries/email.html">Email Class</a>.</p>
87</div>
88<!-- END CONTENT -->
89
90
91<div id="footer">
92<p>
93Previous Topic:&nbsp;&nbsp;<a href="download_helper.html">Download Helper</a>
94&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
95<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
96<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
97Next Topic:&nbsp;&nbsp;<a href="file_helper.html">File Helper</a></p>
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]98<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]99</div>
100
101</body>
102</html>