สร้างเทมเพลตอีเมลด้วย Django

207

ฉันต้องการส่งอีเมล HTML โดยใช้เทมเพลต Django เช่นนี้:

<html>
<body>
hello <strong>{{username}}</strong>
your account activated.
<img src="mysite.com/logo.gif" />
</body>

ฉันหาอะไรไม่เจอ send_mailและ django-mailer จะส่งเทมเพลต HTML เท่านั้นโดยไม่มีข้อมูลแบบไดนามิก

ฉันจะใช้เทมเพลตเอนจินของ Django เพื่อสร้างอีเมลได้อย่างไร

django  email  django-email  django-mailer 
— นาคิน
แหล่งที่มา
3
ประกาศ1.7ข้อเสนอDjango html_messageในsend_email stackoverflow.com/a/28476681/953553
— andilabs
สวัสดี @ อานาคินฉันได้ต่อสู้กับปัญหานี้มานานและตัดสินใจที่จะสร้างแพคเกจสำหรับสิ่งนั้น ฉันมีความสุขมากที่ได้รับข้อเสนอแนะของคุณ: github.com/charlesthk/django-simple-mail
— Charlesthk

คำตอบ:

385

จากเอกสารเพื่อส่งอีเมล HTML ที่คุณต้องการใช้ประเภทเนื้อหาทางเลือกเช่นนี้:

from django.core.mail import EmailMultiAlternatives

subject, from_email, to = 'hello', 'from@example.com', 'to@example.com'
text_content = 'This is an important message.'
html_content = '<p>This is an <strong>important</strong> message.</p>'
msg = EmailMultiAlternatives(subject, text_content, from_email, [to])
msg.attach_alternative(html_content, "text/html")
msg.send()

คุณอาจต้องการสองแม่แบบสำหรับอีเมลของคุณ - ข้อความธรรมดาที่มีลักษณะคล้ายนี้เก็บไว้ในไดเรกทอรีแม่แบบของคุณภายใต้email.txt:

Hello {{ username }} - your account is activated.

และหนึ่ง HTMLy เก็บไว้ภายใต้email.html:

Hello <strong>{{ username }}</strong> - your account is activated.

จากนั้นคุณสามารถส่งอีเมลโดยใช้ทั้งสองแม่แบบเหล่านั้นโดยใช้ประโยชน์จากget_templateสิ่งนี้:

from django.core.mail import EmailMultiAlternatives
from django.template.loader import get_template
from django.template import Context

plaintext = get_template('email.txt')
htmly     = get_template('email.html')

d = Context({ 'username': username })

subject, from_email, to = 'hello', 'from@example.com', 'to@example.com'
text_content = plaintext.render(d)
html_content = htmly.render(d)
msg = EmailMultiAlternatives(subject, text_content, from_email, [to])
msg.attach_alternative(html_content, "text/html")
msg.send()
— โดมินิกร็อดเจอร์
แหล่งที่มา
40
ฉันคิดว่าคุณสามารถลดความซับซ้อนนี้กับrender_to_stringซึ่งจะช่วยให้คุณสูญเสียแยกบรรทัดกำหนดแม่แบบให้plaintextและhtmlyและเพียงแค่ตั้งแม่แบบและบริบทเมื่อคุณกำหนดและtext_content html_content
— cms_mgr
@cms_mgr คุณช่วยอธิบายสิ่งที่คุณต้องการจะพูดได้อย่างไรและเราจะใช้มันอย่างไรได้อย่างไร
— akki
3
@akki ดูคำตอบของ Andi ที่ด้านล่างซึ่งทำให้ส่วนทางเลือกง่ายขึ้นด้วยการเพิ่ม html_message param ใน send_email () ใน Django 1.7
— Mike S
ให้อภัยฉัน แต่ทำไมเราใช้ txt และ htmly ทั้งสองในเวลาเดียวกันสำหรับอีเมล ฉันไม่ได้รับตรรกะนี้
— Shashank Vivek
นี่เป็นเพียงตัวอย่างเพื่อแสดงวิธีการที่แตกต่างกันคุณสามารถใช้วิธีใดก็ได้ที่ @ShashankVivek
— erdemlal
242

เด็กชายและเด็กหญิง!

ตั้งแต่ Django's 1.7 ในเมธอดsend_emailhtml_messageพารามิเตอร์ถูกเพิ่ม

html_message: หากมีการให้ html_message อีเมลที่ได้จะเป็นอีเมลหลายส่วน / ทางเลือกพร้อมข้อความเป็นข้อความ / ชนิดเนื้อหาธรรมดาและ html_message เป็นประเภทเนื้อหาข้อความ / html

ดังนั้นคุณสามารถ:

from django.core.mail import send_mail
from django.template.loader import render_to_string


msg_plain = render_to_string('templates/email.txt', {'some_params': some_params})
msg_html = render_to_string('templates/email.html', {'some_params': some_params})

send_mail(
    'email title',
    msg_plain,
    'some@sender.com',
    ['some@receiver.com'],
    html_message=msg_html,
)
— andilabs
แหล่งที่มา
1
โปรดทราบว่า 'email.txt' และ 'email.html' อยู่ในเทมเพลตไดเรกทอรีตามที่กำหนดไว้ในการตั้งค่ามากกว่าเพียงแค่ render_to_string ('email.txt', {'some_params': some_params} _
— Bruno Vermeulen
ขอบคุณสำหรับrender_to_stringคำแนะนำที่มีประโยชน์มาก
— hoefling
1
ทางออกที่ดี! อย่างไรก็ตามด้วยความsend_mailเป็นไปไม่ได้ที่จะตั้งค่าส่วนหัวที่กำหนดเองบางอย่างเช่นReturn-Pathซึ่งสามารถตั้งค่าด้วยEmailMultiAlternatives's constructor header parameter
— Qlimax
26

ฉันได้สร้างdjango-templated-emailเพื่อแก้ไขปัญหานี้โดยได้รับแรงบันดาลใจจากวิธีแก้ปัญหานี้ (และบางครั้งจำเป็นต้องเปลี่ยนจากการใช้เทมเพลต django เป็นการใช้ mailchimp เป็นต้นชุดของเทมเพลตสำหรับทรานแซคชั่นเทมเพลตอีเมลสำหรับ โครงการของฉัน) มันยังคงเป็นงานที่อยู่ระหว่างดำเนินการ แต่สำหรับตัวอย่างข้างต้นคุณต้องทำ:

from templated_email import send_templated_mail
send_templated_mail(
        'email',
        'from@example.com',
        ['to@example.com'],
        { 'username':username }
    )

ด้วยการเพิ่มสิ่งต่อไปนี้ไปยัง settings.py (เพื่อทำตัวอย่างให้สมบูรณ์):

TEMPLATED_EMAIL_DJANGO_SUBJECTS = {'email':'hello',}

สิ่งนี้จะค้นหาแม่แบบที่มีชื่อว่า 'templated_email / email.txt' และ 'templated_email / email.html' โดยอัตโนมัติสำหรับชิ้นส่วนธรรมดาและ html ตามลำดับในแม่แบบ django ปกติ dirs / loader (บ่นหากไม่พบอย่างน้อยหนึ่งในนั้น) .

— darb
แหล่งที่มา
1
ดูดีกับผม. ฉันตัดมันทิ้งแล้วโยนลงในบัตรเพื่อเพิ่มdjango.shortcuts.send_templated_mail: code.djangoproject.com/ticket/17193
— Tom Christie
เจ๋งดีใจที่ได้รับการเสนอเป็นเครื่องมือสำหรับ django core กรณีการใช้งาน / โฟกัสของฉันสำหรับ lib นั้นใหญ่กว่าทางลัดเล็กน้อย (การสลับระหว่างผู้ให้บริการอีเมลที่มีคีย์ / ค่า api สำหรับการส่งจดหมายได้ง่าย) แต่มันรู้สึกว่าเป็นคุณลักษณะที่ขาดหายไปจากแกน
— Darb
15

ใช้ EmailMultiAlternatives และ render_to_string เพื่อใช้เท็มเพลตสำรองสองแบบ (หนึ่งในข้อความธรรมดาและอีกหนึ่งเป็น HTML):

from django.core.mail import EmailMultiAlternatives
from django.template import Context
from django.template.loader import render_to_string

c = Context({'username': username})    
text_content = render_to_string('mail/email.txt', c)
html_content = render_to_string('mail/email.html', c)

email = EmailMultiAlternatives('Subject', text_content)
email.attach_alternative(html_content, "text/html")
email.to = ['to@example.com']
email.send()
— Rick Westera
แหล่งที่มา
5

ฉันสร้างDjango Simple Mail แล้วเพื่อให้มีเทมเพลตที่ปรับแต่งได้และใช้ซ้ำได้สำหรับอีเมลธุรกรรมทุกรายการที่คุณต้องการส่ง

เนื้อหาอีเมลและแม่แบบสามารถแก้ไขได้โดยตรงจากผู้ดูแลระบบของ django

ด้วยตัวอย่างของคุณคุณจะลงทะเบียนอีเมลของคุณ:

from simple_mail.mailer import BaseSimpleMail, simple_mailer


class WelcomeMail(BaseSimpleMail):
    email_key = 'welcome'

    def set_context(self, user_id, welcome_link):
        user = User.objects.get(id=user_id)
        return {
            'user': user,
            'welcome_link': welcome_link
        }


simple_mailer.register(WelcomeMail)

และส่งแบบนี้:

welcome_mail = WelcomeMail()
welcome_mail.set_context(user_id, welcome_link)
welcome_mail.send(to, from_email=None, bcc=[], connection=None, attachments=[],
                   headers={}, cc=[], reply_to=[], fail_silently=False)

ฉันชอบที่จะได้รับข้อเสนอแนะใด ๆ

— Charlesthk
แหล่งที่มา
มันจะช่วยได้มากหากคุณอัปโหลดแอปพลิเคชันตัวอย่างของแพ็คเกจของคุณบน repo
— ans2human
สวัสดี @ ans2human ขอบคุณสำหรับคำแนะนำนี้ฉันเพิ่มลงในรายการการปรับปรุง!
— Charlesthk
3

มีข้อผิดพลาดในตัวอย่าง .... ถ้าคุณใช้ตามที่เขียนไว้ข้อผิดพลาดต่อไปนี้เกิดขึ้น:

<type 'ข้อยกเว้นข้อยกเว้น'>: วัตถุ 'dict' ไม่มีแอตทริบิวต์ 'render_context'

คุณจะต้องเพิ่มการนำเข้าต่อไปนี้:

from django.template import Context

และเปลี่ยนพจนานุกรมเป็น:

d = Context({ 'username': username })

ดูhttp://docs.djangoproject.com/en/1.2/ref/templates/api/#rendering-a-context

— idbill
แหล่งที่มา
ขอบคุณ - ตอนนี้ได้รับการแก้ไขแล้ว
— Dominic Rodger
3

Templated Django Mailเป็นแอปพลิเคชั่น Django ที่มีคุณสมบัติหลากหลายเพื่อส่งอีเมลด้วยระบบแม่แบบ Django

การติดตั้ง:

pip install django-mail-templated

การกำหนดค่า:

INSTALLED_APPS = (
    ...
    'mail_templated'
)

แม่แบบ:

{% block subject %}
Hello {{ user.name }}
{% endblock %}

{% block body %}
{{ user.name }}, this is the plain text part.
{% endblock %}

งูหลาม:

from mail_templated import send_mail
send_mail('email/hello.tpl', {'user': user}, from_email, [user.email])

ข้อมูลเพิ่มเติม: https://github.com/artemrizhov/django-mail-templated

— raacer
แหล่งที่มา
มันใช้งานง่ายมาก ขอบคุณ
— cheenbabes
สวัสดีฉันจะตั้งผู้รับทั้งหมดเป็น BCC ได้อย่างไร
— aldesabido
@aldesabido นี่เป็นเพียงเสื้อคลุมรอบคลาส EmailMessage มาตรฐานของ Django ดังนั้นคุณควรอ่านเอกสารอย่างเป็นทางการเมื่อมองหาคุณสมบัติดังกล่าว: docs.djangoproject.com/en/1.10/topics/emailและดูคำถามที่คล้ายกัน: stackoverflow.com/questions/3470172/ …
— raacer
เพื่อให้แม่นยำยิ่งขึ้น EmailMessage มาตรฐานจะไม่ถูกห่อ แต่รับมา นั่นคือส่วนขยายสำหรับคลาสมาตรฐาน :)
— raacer
เป็นไปได้ที่จะรวม JS / CSS ในแม่แบบ?
— Daniel Shatz
3

ฉันรู้ว่านี่เป็นคำถามเก่า แต่ฉันก็รู้ว่าบางคนก็เหมือนฉันและมักจะมองหาคำตอบ uptodateเนื่องจากบางครั้งคำตอบเก่าอาจมีข้อมูลที่ไม่สนับสนุนหากไม่ได้รับการปรับปรุง

มันคือเดือนมกราคม 2020 และฉันใช้ Django 2.2.6 และ Python 3.7

หมายเหตุ: ฉันใช้DJANGO REST FRAMEWORKรหัสด้านล่างสำหรับการส่งอีเมลอยู่ในชุดรูปแบบวิวในฉันviews.py

ดังนั้นหลังจากอ่านคำตอบที่ดีหลายข้อนี่คือสิ่งที่ฉันทำ

from django.template.loader import render_to_string
from django.core.mail import EmailMultiAlternatives

def send_receipt_to_email(self, request):

    emailSubject = "Subject"
    emailOfSender = "email@domain.com"
    emailOfRecipient = 'xyz@domain.com'

    context = ({"name": "Gilbert"}) #Note I used a normal tuple instead of  Context({"username": "Gilbert"}) because Context is deprecated. When I used Context, I got an error > TypeError: context must be a dict rather than Context

    text_content = render_to_string('receipt_email.txt', context, request=request)
    html_content = render_to_string('receipt_email.html', context, request=request)

    try:
        #I used EmailMultiAlternatives because I wanted to send both text and html
        emailMessage = EmailMultiAlternatives(subject=emailSubject, body=text_content, from_email=emailOfSender, to=[emailOfRecipient,], reply_to=[emailOfSender,])
        emailMessage.attach_alternative(html_content, "text/html")
        emailMessage.send(fail_silently=False)

    except SMTPException as e:
        print('There was an error sending an email: ', e) 
        error = {'message': ",".join(e.args) if len(e.args) > 0 else 'Unknown Error'}
        raise serializers.ValidationError(error)

สำคัญ! ดังนั้นจะrender_to_stringได้รับreceipt_email.txtและreceipt_email.htmlอย่างไร ในฉันsettings.pyฉันมีTEMPLATESและด้านล่างเป็นลักษณะ

ให้ความสนใจDIRSมีบรรทัดนี้บรรทัดos.path.join(BASE_DIR, 'templates', 'email_templates') นี้คือสิ่งที่ทำให้แม่แบบของฉันสามารถเข้าถึงได้ ใน project_dir ของฉันฉันมีโฟลเดอร์ที่เรียกว่าtemplatesและ sub_directory ที่เรียกเช่นนี้email_templates project_dir->templates->email_templatesแม่แบบของฉันreceipt_email.txtและreceipt_email.htmlอยู่ภายใต้email_templatesไดเรกทอรีย่อย

TEMPLATES = [
{
    'BACKEND': 'django.template.backends.django.DjangoTemplates',
    'DIRS': [os.path.join(BASE_DIR, 'templates'), os.path.join(BASE_DIR, 'templates', 'email_templates')],
    'APP_DIRS': True,
    'OPTIONS': {
        'context_processors': [
            'django.template.context_processors.debug',
            'django.template.context_processors.request',
            'django.contrib.auth.context_processors.auth',
            'django.contrib.messages.context_processors.messages',
        ],
    },
},
]

ขอผมเพิ่มอีกหน่อย, recept_email.txtหน้าตาของผมแบบนี้;

Dear {{name}},
Here is the text version of the email from template

และreceipt_email.htmlหน้าตาของฉันแบบนี้;

Dear {{name}},
<h1>Now here is the html version of the email from the template</h1>
— manpikin
แหล่งที่มา
0

ฉันเขียนตัวอย่างที่ช่วยให้คุณส่งอีเมลที่แสดงด้วยแม่แบบที่เก็บไว้ในฐานข้อมูล ตัวอย่าง:

EmailTemplate.send('expense_notification_to_admin', {
    # context object that email template will be rendered with
    'expense': expense_request,
})
— Andrii Zarubin
แหล่งที่มา
0

หากคุณต้องการเทมเพลตอีเมลแบบไดนามิกสำหรับจดหมายของคุณให้บันทึกเนื้อหาอีเมลในตารางฐานข้อมูลของคุณ นี่คือสิ่งที่ฉันบันทึกไว้เป็นรหัส HTML ในฐานข้อมูล =

<p>Hello.. {{ first_name }} {{ last_name }}.  <br> This is an <strong>important</strong> {{ message }}
<br> <b> By Admin.</b>

 <p style='color:red'> Good Day </p>

ในมุมมองของคุณ: 

from django.core.mail import EmailMultiAlternatives
from django.template.loader import get_template

def dynamic_email(request):
    application_obj = AppDetails.objects.get(id=1)
    subject = 'First Interview Call'
    email = request.user.email
    to_email = application_obj.email
    message = application_obj.message

    text_content = 'This is an important message.'
    d = {'first_name': application_obj.first_name,'message':message}
    htmly = FirstInterviewCall.objects.get(id=1).html_content #this is what i have saved previously in database which i have to send as Email template as mentioned above HTML code

    open("partner/templates/first_interview.html", "w").close() # this is the path of my file partner is the app, Here i am clearing the file content. If file not found it will create one on given path.
    text_file = open("partner/templates/first_interview.html", "w") # opening my file
    text_file.write(htmly) #putting HTML content in file which i saved in DB
    text_file.close() #file close

    htmly = get_template('first_interview.html')
    html_content = htmly.render(d)  
    msg = EmailMultiAlternatives(subject, text_content, email, [to_email])
    msg.attach_alternative(html_content, "text/html")
    msg.send()

สิ่งนี้จะส่งเทมเพลต HTML แบบไดนามิกที่คุณบันทึกไว้ใน Db

— เว็ด
แหล่งที่มา
0

send_emai()ไม่ได้ผลสำหรับฉันดังนั้นฉันจึงใช้EmailMessage ที่นี่ใน django docsที่นี่ในเอกสาร

ฉันได้รวมแอนเซอร์สองเวอร์ชั่น:

  1. ด้วยรุ่นอีเมล HTML เท่านั้น
  2. ด้วยอีเมลข้อความธรรมดาและรุ่นอีเมล HTML
from django.template.loader import render_to_string 
from django.core.mail import EmailMessage

# import file with html content
html_version = 'path/to/html_version.html'

html_message = render_to_string(html_version, { 'context': context, })

message = EmailMessage(subject, html_message, from_email, [to_email])
message.content_subtype = 'html' # this is required because there is no plain text email version
message.send()

หากคุณต้องการรวมอีเมล์ที่เป็นข้อความธรรมดาให้แก้ไขสิ่งที่กล่าวมาด้านบน:

from django.template.loader import render_to_string 
from django.core.mail import EmailMultiAlternatives # <= EmailMultiAlternatives instead of EmailMessage

plain_version = 'path/to/plain_version.html' # import plain version. No html content
html_version = 'path/to/html_version.html' # import html version. Has html content

plain_message = render_to_string(plain_version, { 'context': context, })
html_message = render_to_string(html_version, { 'context': context, })

message = EmailMultiAlternatives(subject, plain_message, from_email, [to_email])
message.attach_alternative(html_message, "text/html") # attach html version
message.send()

เวอร์ชันธรรมดาและ html ของฉันมีลักษณะดังนี้: plain_version.html:

Plain text {{ context }}

html_version.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 ...
 </head>
<body>
<table align="center" border="0" cellpadding="0" cellspacing="0" width="320" style="border: none; border-collapse: collapse; font-family:  Arial, sans-serif; font-size: 14px; line-height: 1.5;">
...
{{ context }}
...
</table>
</body>
</html>
— alkadelik
แหล่งที่มา
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.