Создание шаблонов электронной почты с 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
Обратите внимание, что Django 1.7предлагает html_messageв send_email stackoverflow.com/a/28476681/953553
andilabs
Привет @anakin, я долго боролся с этой проблемой и решил создать пакет для этого. Я был бы очень рад получить ваши отзывы: 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, добавляемому к send_email () в Django 1.7
Mike S
Извините, но почему мы используем txt и htmly для почты одновременно. Я не понял этой логики
Шашанк Вивек
это просто примеры, демонстрирующие различные виды методов, вы можете использовать любой из них @ShashankVivek
erdemlal
242

Мальчики и девочки!

Начиная с 1,7 в Django в методе send_email,html_message параметр был добавлен.

html_message: если указан html_message, полученное в результате электронное письмо будет состоять из нескольких частей / альтернативных сообщений с сообщением в качестве типа текстового / простого содержимого и html_message в качестве типа контента text / 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подсказку, очень удобно.
Хефлинг
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 / loaders (жалуются, если не могут найти хотя бы один из них) ,

Дарб
источник
1
Выглядит хорошо для меня. Я урезал это и бросил в билет, чтобы добавить django.shortcuts.send_templated_mail: code.djangoproject.com/ticket/17193
Том Кристи
Круто, рад видеть, что его предложили в качестве инструмента для ядра django. Мой сценарий использования / фокус для библиотеки немного больше, чем просто ярлык (простое переключение между почтовыми провайдерами, у которых есть 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()
Рик Вестера
источник
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
источник
Это очень поможет, если вы загрузите демонстрационное приложение вашего пакета в репо.
ans2human
Привет @ ans2human спасибо за это предложение, я добавляю его в список улучшений!
Charlesthk
3

В примере есть ошибка .... если вы используете ее как написано, возникает следующая ошибка:

<тип 'exceptions.Exception'>: объект 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
источник
Спасибо - это исправлено.
Доминик Роджер
3

Django Mail Templated - это многофункциональное приложение 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 %}

Python:

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 20.10.16
Можно ли включить JS / CSS в шаблон?
Даниэль Шац
3

Я знаю, что это старый вопрос, но я также знаю, что некоторые люди похожи на меня и всегда ищут обновленные ответы , так как старые ответы могут иногда быть устаревшей, если не обновляться.

Сейчас январь 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,
})
Андрей Зарубин
источник
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
источник
-1

Мне нравится использовать этот инструмент, чтобы легко отправлять электронные письма HTML и TXT с простой обработкой контекста: https://github.com/divio/django-emailit

matinfo
источник