summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source
diff options
context:
space:
mode:
authorEric Barnes <eric@ericlbarnes.com>2012-07-30 14:10:05 +0200
committerEric Barnes <eric@ericlbarnes.com>2012-07-30 14:10:05 +0200
commit4df0be86a3ee120e307d6140a9106e77a4962bb0 (patch)
tree901d005b951e11b17973fe2f3e4171dda04340b3 /user_guide_src/source
parentb92c44bba729575a92c80313174d45191cae582e (diff)
parent5f441eaedf5fecbad29131c5d44e3c2d53c4c4b5 (diff)
Merge pull request #1672 from alexbilbie/alexbilbie-email-clear
Automatically clear email parameters if send was successful
Diffstat (limited to 'user_guide_src/source')
-rw-r--r--user_guide_src/source/changelog.rst4
-rw-r--r--user_guide_src/source/libraries/email.rst8
2 files changed, 11 insertions, 1 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 7f428e5db..4d69c4dc3 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -176,7 +176,9 @@ Release Date: Not Released
- Allowed for setting table class defaults in a config file.
- Added a Wincache driver to the :doc:`Caching Library <libraries/caching>`.
- Added a Redis driver to the :doc:`Caching Library <libraries/caching>`.
- - Added dsn (delivery status notification) option to the :doc:`Email Library <libraries/email>`.
+ - :doc:`Email library <libraries/email>` changes include:
+ - Added dsn (delivery status notification) option.
+ - Successfully sent emails will automatically clear the parameters.
- Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
- Added an "index" parameter to the data() method in the :doc:`Upload Library <libraries/file_uploading>`.
- :doc:`Pagination Library <libraries/pagination>` changes include:
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index c5fa68004..f56bc2ff5 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -226,6 +226,14 @@ success or failure, enabling it to be used conditionally::
// Generate error
}
+This function will automatically clear all parameters if the request was
+ successful. To stop this behaviour pass FALSE::
+
+ if ($this->email->send(FALSE))
+ {
+ // Parameters won't be cleared
+ }
+
$this->email->attach()
----------------------