diff options
| author | Justin Michalicek <jmichalicek@gmail.com> | 2013-07-30 22:29:34 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-08-05 09:47:28 -0400 |
| commit | 6d88d47be6d37234aab86d0e863e371f28347d12 (patch) | |
| tree | 3e71c7a70ca7bf81681336ab823e031623e509b4 /docs | |
| parent | 94d7fed7750322e8b80402c1e731bab6d4509f2e (diff) | |
Fixed #20832 -- Enabled HTML password reset email
Added optional html_email_template_name parameter to password_reset view
and PasswordResetForm.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/releases/1.7.txt | 4 | ||||
| -rw-r--r-- | docs/topics/auth/default.txt | 10 |
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 970f362949..28d9c9e1f1 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -118,6 +118,10 @@ Minor features customize the value of :attr:`ModelAdmin.fields <django.contrib.admin.ModelAdmin.fields>`. +* :func:`django.contrib.auth.views.password_reset` takes an optional + ``html_email_template_name`` parameter used to send a multipart HTML email + for password resets. + Backwards incompatible changes in 1.7 ===================================== diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt index 4ffafc1720..7dff9cdca7 100644 --- a/docs/topics/auth/default.txt +++ b/docs/topics/auth/default.txt @@ -793,7 +793,7 @@ patterns. * ``extra_context``: A dictionary of context data that will be added to the default context data passed to the template. -.. function:: password_reset(request[, is_admin_site, template_name, email_template_name, password_reset_form, token_generator, post_reset_redirect, from_email, current_app, extra_context]) +.. function:: password_reset(request[, is_admin_site, template_name, email_template_name, password_reset_form, token_generator, post_reset_redirect, from_email, current_app, extra_context, html_email_template_name]) Allows a user to reset their password by generating a one-time use link that can be used to reset the password, and sending that link to the @@ -856,6 +856,14 @@ patterns. * ``extra_context``: A dictionary of context data that will be added to the default context data passed to the template. + * ``html_email_template_name``: The full name of a template to use + for generating a ``text/html`` multipart email with the password reset + link. By default, HTML email is not sent. + + .. versionadded:: 1.7 + + ``html_email_template_name`` was added. + **Template context:** * ``form``: The form (see ``password_reset_form`` above) for resetting |