DjangoのSendGridでSubstitution Tagsを使用するサンプルコード

2022年1月26日

今回はDjangoでSendGridを使っているときに、Substitution Tagsを使用するためのサンプルコードをご紹介いたします。

DjangoのSendGridでSubstitution Tagsを使用するサンプルコード

DjangoでSendGridを使用しているときに、toで複数宛先を指定して一斉送信が可能ですが、その中でSubstitution Tagsというのを使用することでそれぞれの宛先について一部の文字列を差し替えることが可能です。
https://sendgrid.kke.co.jp/docs/API_Reference/SMTP_API/substitution_tags.html

こちらでご紹介した「DjangoでSendGridを使っていてtoを複数指定して一斉送信をしたいときのサンプルコード」の一部を改変することで実現が可能です。
https://chico-shikaku.com/2022/01/django-sendgrid-multi-to/

from smtpapi import SMTPAPIHeader
from django.core.mail import EmailMessage
subject = 'This is test mail.'
body = 'This is body.'
from_email = 'test_from@example.com'
to_email = 'test_to@example.com'
set_tos = ['test1@example.com', 'test2@example.com', 'test3@example.com']
substitutions = {
    '-name-': ['test1', 'test2', 'test3']
}
header = SMTPAPIHeader()
header.set_tos(set_tos)
header.set_substitutions({'key': ['value1', 'value2']})
email = EmailMessage(
    subject,
    body,
    from_email,
    to_email,
    headers={'X-SMTPAPI': header.json_string()},
)
email.send()