django通过封装python的smtplib实现发送邮件功能。django 1.11官网翻译内容见:http://www.jianshu.com/p/c02aac458a71。
下面的内容结合django by example CH2 第一节的内容完成,翻译了第一节的内容,使用python2.7+Django1.11测试,修正了书中代码的错误,添加了注意事项,并写出了测试结果。
通过e-mail分享文章
首先,我们允许用户通过发送邮件的方式分享文章。想一下我们如何通过上一章学到views、URLs和templates实现这个功能。如果要允许用户通过e-mail发送邮件,我们需要:
为用户创建一个form来填写它们的名字、e-mail,接收文章的e-mail和评论(可选);
在views.py文件中创建一个视图来处理post的数据并发送e-mail;
在urls.py文件中为新建立的视图添加URL。
创建一个模板来展示表单。
使用Django创建form
form即为表单,下面表述中form与表单意义相同。
我们从创建分享文章的form开始。Django内置form框架帮助我们非常方便的创建form。form矿建允许我们定义form的字段、指定它们展示的方式、输入数据的验证方式。Django form矿建还提供灵活的方法来渲染form和处理数据。
Django提供两个基准类来创建forms:
Form:帮助我们创建标准forms;
ModelForm:帮助我们创建增加或者修改模型实例的forms。
首先,在blog应用的根目录新建一个名为forms.py的文件,并添加以下代码:
from django import forms
class EmailPostForm(forms.Form):
name = forms.CharField(max_length=25)
email = forms.EmailField()
to = forms.EmailField()
comments = forms.CharField(required=False, widget=forms.Textarea)
这是你的第一个django表单(form)。我们来看一下通过集成Form类创建的form。我们使用不同的字段对输入进行验证。
注意:
Forms可以放在Django项目的任何位置,为了方便起见,我们将其放在每个项目的forms.py文件中。
name字段是一个CharField。这种类型的字段渲染一个的HTML元素。每一个字段都对应一个小组件,这个小组件决定HTML如何展示该字段。默认的组件可以通过设置widget属性进行覆盖。在comments字段中,我们使用Textarea组件将其展示为一个HTML元素来代替默认的元素。
字段验证还依赖字段类型。例如,email和to字段为EmailField,两个字段都需要有效地e-mail地址,否则字段验证将引发forms.ValidationError异常并且form无法通过验证。form验证还会考虑其他参数:我们定义了一个最大长度为25的name字段并将comment字段设置为required=False。form验证时会将这些都考虑在内。这个form中使用的字段类型只是django表单字段的一小部分,所有的表单字段可以参考https://docs.djangoproject.com/en/1.11/ref/forms/fields/。
在视图中处理表单
我们需要创建了一个新的视图来处理表单并在它成功提交时发送e-mail。编辑blog应用的views.py写入以下代码:
from .forms import EmailPostForm
def post_share(request, post_id):
# Retrieve post by id
post = get_object_or_404(Post, id=post_id, status='published')
if request.method == 'POST':
# Form was submitted
form = EmailPostForm(request.POST)
if form.is_valid():
# Form fields passed validation
cd = form.cleaned_data
# ... send email
else:
form = EmailPostForm()
return render(request, 'blog/post/share.html', {'post': post, 'form': form})
该表单将实现以下功能:
我们定义了post_share视图,该视图输入request对象和post_id作为参数。
我们使用get_object_or_404()通过id获取文章并且要求文章状态为published。
展示初始表单和处理提交的数据使用相同的视图。我们使用request方法对其进行区分,如果request方法为GET,我们将展示一个空的表单;如果request方法为POST,那么表单将被提交并且需要处理。因此我们使用request.method="POST"来区分这两种情况。
下面是展示和处理表单的过程:
当使用GET请求视图时,我们创建一个新的form类在模板中展示空的表单: form=EmailPostForm()
用户填写表单并通过POST提交,然后,我们在POST部分使用提交的数据创建了一个表单类视图:
if form.is_valid():
# Form fields passed validation
cd = form.cleaned_data
# ... send email
然后,我们使用is_valid方法对提交的数据进行验证,这个方法对表单中的数据进行验证,如果数据均为有效数据,则会返回Ture,否则会返回False。如果验证为False我们可以通过访问form.errors看到错误列表:
如果表单没有通过验证,我们将使用提交的数据再次渲染表单,并且在模板中显示验证错误。
如果表单通过验证,我们通过form.cleaned_data获取数据,这个属性为表单字段名和值的属性。
注意:
如果表单字段没有验证,cleaned_data将值包含通过验证的字段。
现在我们需要学习如何使用Django发送邮件了。
使用Django发送邮件
使用Django发送邮件非常简单。首先,我们需要一个本地SMTP服务器或者在项目setting.py中添加以下设置来配置一个外部SMTP服务器:
EMAIL_HOST: SMTP服务器主机。默认为localhost;
EMAIL_PORT: SMTP服务器端口。默认为25;
EMAIL_HOST_USER: the SMTP 服务器的用户名;
EMAIL_HOST_PASSWORD: SMTP 服务器的密码;
EMAIL_USE_TLS: 是否使用TLS安全连接;
EMAIL_USE_SSL: 是否使用隐式TLS安全连接。
如果没有本地SMTP服务器,可以使用e-mail提供者的SMTP服务器。下面的简单配置是使用hotmail账户通过hotmail服务器发送e-mail的配置(https://outlook.live.com/owa/?path=/options/popandimap):
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_HOST_USER = '[email protected]'
EMAIL_HOST_PASSWORD = 'your_password'
EMAIL_PORT = 587
EMAIL_USE_TLS = True
注意:
配置中,EMAIL_USE_TLS和EMAIL_USE_SSL都默认设置为False,需要配置其中一个为True,但是不能两个都设置为True。一般端口587对应TLS,端口465对应SSL(加强TSL)。
在teminal的项目根目录输入命令:python manage.py shell打开Python shell并发送邮件:
from django.core.mail import send_mail
>>> send_mail('Django mail', 'This e-mail was sent with Django.', '[email protected]', ['[email protected]'], fail_silently=False)
send_mail()输入主题、消息、发送者、接受者列表作为参数,通过设置fail_silently=False可以在邮件没有正确发送的时候引发异常。如果输出为1,那么邮件就正常发送了。如果采用setting.py中设置google web服务器发送邮件,需要正常访问以下网址:https://www.google.com/settings/security/lesssecureapps。
发送邮件测试
测试环境:python2.7,Django1.11
hotmail邮箱
EMAIL_HOST = 'smtp-mail.outlook.com'
EMAIL_HOST_USER = '[email protected]'
EMAIL_HOST_PASSWORD = 'your_password'
EMAIL_PORT= 587
EMAIL_USE_TLS = True
在teminal的项目根目录输入命令:python manage.py shell打开Python shell并发送邮件:
from django.core.mail import send_mail
>>> send_mail('Django mail', 'This e-mail was sent with Django.', '[email protected]', ['[email protected]'], fail_silently=False)
如果send_mail第三个参数
与EMAIL_HOST_USER一致,邮件正常发送。但是如果接收邮件只有阿里云企业邮箱,该邮箱没有返回,需要在程序中增加时间限制,否则邮件发送正常但是程序会长时间等待接收反馈信息而无法执行其他命令。
如果send_mail第三个参数与EMAIL_HOST_USER不一致,会引发SMTPDataError 异常,无法发送邮件。
163邮箱
EMAIL_HOST = 'smtp.163.com'
EMAIL_HOST_USER = '[email protected]'
EMAIL_HOST_PASSWORD = 'your_auth_code' #邮箱的授权码而非密码
EMAIL_PORT = 465
EMAIL_USE_SSL = True
注意,这里的password不是邮箱密码,而是在[邮箱]-[设置]-[POP3/SMTP/IMAP]中设置的授权码。
在teminal的项目根目录输入命令:python manage.py shell打开Python shell并发送邮件:
from django.core.mail import send_mail
>>> send_mail('Django mail', 'This e-mail was sent with Django.', '[email protected]', ['[email protected]'], fail_silently=False)
如果send_mail第三个参数与EMAIL_HOST_USER一致,引发SMTPDataError: (554, 'DT:SPM 163 smtp11,D8CowADnvQK5UwFa6C2ZAw--.46120S2 1510036409,please see http://mail.163.com/help/help_spam_16.htm?ip=120.194.143.53&hostid=smtp11&time=1510036409')异常,
http://mail.163.com/help/help_spam_16.htm?ip=120.194.143.53&hostid=smtp11&time=1510036409的对应内容为该邮件被视为垃圾邮件,更改主题与内容后仍无效。需要进一步了解163判断垃圾邮件的依据。
如果send_mail第三个参数为hotmail邮箱,邮件无法发送,引发SMTPSenderRefused: (553, 'Mail from must equal authorized user')异常。即发送信息邮箱必须与授权邮箱一致。
发送邮件测试总结
测试环境:python2.7+Django1.11。
尽量使用hotmail邮件作为settings中的邮箱;
send_mail中的发送邮箱最好与settings中的授权邮箱一致。
现在,将发送邮件功能添加到视图中,将post_share视图更改为:
from .forms import EmailPostForm
from django.core.mail import send_mail
def post_share(request, post_id):
# Retrieve post by id
post = get_object_or_404(Post, id=post_id, status='published')
sent = False
if request.method == 'POST':
# Form was submitted
form = EmailPostForm(request.POST)
if form.is_valid():
# Form fields passed validation
cd = form.cleaned_data
post_url = request.build_absolute_uri(post.get_absolute_url())
subject = '{}({})recommends you read "{}"'.format(cd['name'],
cd['email'],
post.title)
message = 'read"{}" at {} \n\n\'s comments:{}'.format(post.title,
post_url,
cd['name'],
cd[
'comments'])
send_mail(subject, message, cd['email'], [cd['to']])
sent = True
# ... send email
else:
form = EmailPostForm()
return render(request, 'blog/post/share.html',
{'post': post, 'form': form, 'sent': sent})
这里,我们定义了一个变量sent,当邮件发送成功时,sent设为True。后续我们会在模板中使用该变量,当表单正确提交且邮件发送成功时显示成功信息。这里使用get_absolute_url()方法获取在邮件中用到的文章的链接,我们将该函数作为request.build_absolute_uri()的输入来构建包含http的完整URL。我们使用验证的表单的cleaned data作为邮件的主题和内容,然后将邮件发送到表单中to一栏中添加的地址中。
现在视图完成了,我们为其添加URL,打开blog应用下的urls.py文件,添加以下内容:
urlpatterns = [
# ...
url(r'^(?P\d+)/share/$', views.post_share,
name='post_share'),
]
在模板中渲染表单
创建完表单,完成视图并添加URL后,我们还需要为这个视图添加模板。在blog/templates/blog/post目录下创建名为share.html的文件,添加以下内容:
{% extends "blog/base.html" %}
{% block title %}Share a post{% endblock %}
{% block content %}
{% if sent %}
"{ { post.title }}" was successfully sent to { { form.to }}.
{% else %}
{ { form.as_p }}
{% csrf_token %}
{% endif %}
{% endblock %}
这是展示表单的模板,当发送邮件成功时该模板则会显示成功信息。我们创建了通过POST提交的表单:
然后,我们包含了form实例,我们通过as_p方法告诉Django将字段渲染为HTML的p元素(我们还可以通过as_table方法将字段渲染为table或者通过as_ul方法将字段渲染为ul)。如果我们要渲染每个字段,我们可以对每个字段进行迭代:
{% for field in form %}
{ { field.errors }}
{ { field.label_tag }}{ { field.field }}
{% endfor %}
模板标签中的{% csrf_token %}模板标签引入一个自动生成避免CSRF袭击所用token的隐藏字段。关于CSRF可以从以下网站获取更多信息:“https://en.wikipedia.org/wiki/Cross-site_request_forgery。该字段将会自动生成一个隐藏输入:
注意:
默认,Django为所有POST请求检查CSRFtoken。所以我们需要通过POST提交的表单添加csrf_token。
编辑blog/post/detail.html模板并在{ { post.body|linebreaks }}后添加分享链接:
Share this post
我们通过Django的url模板标签动态生成URL。我们使用了命名空间为blog名称为post_share的URL,我们将post.id作为参数传入绝对URL中。
现在,在teminal中项目根目录下运行:
python manage.py runserver
在浏览器中打开http://127.0.0.1:8000/blog/,点击任意文章标题到文章详细内容页面,在正文后面,你可以看到以下链接:
post_share_form.png
点击Share this post,我们将跳到分享邮件分享页面:
post_share_link.png
表单的css位于static/css/blog.css文件汇总。当我们点击send e-mail按钮时,表单将被提交并验证。如果所有字段都通过验证,且邮件正常发送,我们将得到以下页面:
post_shared.png
如果输入包含无效数据,根据浏览器的不同,可能点击send e-mail显示错误提示从而无法跳转,也可能跳转后显示错误提示,重新填写表单(通过验证的字段无需重复填写)。