From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide_src/source/helpers/email_helper.rst | 49 ++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 user_guide_src/source/helpers/email_helper.rst (limited to 'user_guide_src/source/helpers/email_helper.rst') diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst new file mode 100644 index 000000000..d4e94b1ed --- /dev/null +++ b/user_guide_src/source/helpers/email_helper.rst @@ -0,0 +1,49 @@ +############ +Email Helper +############ + +The Email Helper provides some assistive functions for working with +Email. For a more robust email solution, see CodeIgniter's :doc:`Email +Class <../libraries/email>`. + +.. contents:: Page Contents + +Loading this Helper +=================== + +This helper is loaded using the following code:: + + $this->load->helper('email'); + + +The following functions are available: + +valid_email('email') +==================== + +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. + +It returns TRUE/FALSE + +:: + + $this->load->helper('email'); + + if (valid_email('email@somesite.com')) + { + echo 'email is valid'; + } + else + { + echo 'email is not valid'; + } + +send_email('recipient', 'subject', 'message') +============================================= + +Sends an email using PHP's native +`mail() `_ function. For a more robust +email solution, see CodeIgniter's :doc:`Email +Class <../libraries/email>`. -- cgit v1.2.3-24-g4f1b