お手軽な例¶

二行だけです:

from django.core.mail import send_mail

send_mail('Subject here', 'Here is the message.', 'from@example.com',
    ['to@example.com'], fail_silently=False)

これで、 EMAIL_HOST および EMAIL_PORT 設定で指定した SMTP ホストを介してメールを送信します。 EMAIL_HOST_USER および EMAIL_HOST_PASSWORD を指定していれば、 SMTP サーバの認証に使い ます。また、SMTP サーバとの接続に TLS を使うかどうかを EMAIL_USE_TLS で設定できます。

send_mail()¶

電子メールを送信する最も簡単な方法は django.core.mail.send_mail() 関数です。この関数の定義は以下の通りです:

send_mail(subject, message, from_email, recipient_list, fail_silently=False, auth_user=None, auth_password=None)¶

subject, message, from_email および recipient_list は必須の パラメタです。

• subject: 文字列です。
• message: 文字列です。
• from_email: 文字列です。
• recipient_list: 文字列からなるリストで、各々が電子メールアドレス を表します。 recipient_list に入っているユーザは、お互いに他のユー ザをメールの "To:" フィールドで見られます。
• fail_silently: ブール型の値です。 False なら send_mail は smtplib.SMTPException 例外を出すようになります。 送出されうる例外のリストは smtplib のドキュメント を参照してくださ い。いずれの例外も SMTPException のサブクラスです。
• auth_user: オプションです。 SMTP サーバでの認証に使うユーザ名です。 この値を指定しなければ、 Django は EMAIL_HOST_USER 設定を使います。
• auth_password: オプションです。 SMTP サーバでの認証に使うパスワー ドです。この値を指定しなければ、 Django は EMAIL_HOST_PASSWORD 設 定を使います。

send_mass_mail()¶

django.core.mail.send_mass_mail() は一括電子メール (mass e-mail) の送信 用の関数です。この関数の定義は以下の通りです:

send_mass_mail(datatuple, fail_silently=False, auth_user=None, auth_password=None)¶

datatuple はタプルで、各要素は以下の形式になっています:

(subject, message, from_email, recipient_list)

fail_silently, auth_user および auth_password は send_mail() と同じです。

datatuple の各要素ごとに個別の電子メールメッセージを作成して送信します。 send_mail() と同様、同じ recipient_list に入っている受信者は、他の 受信者を "To:" フィールドで見られます。

mail_admins()¶

django.core.mail.mail_admins() は ADMINS に書かれたサイト管 理者への電子メール送信を行うためのショートカットです。関数の定義は以下の通 りです:

mail_admins(subject, message, fail_silently=False)¶

mail_admins() はサブジェクトの先頭に EMAIL_SUBJECT_PREFIX の 設定値を付加します。デフォルトは "[Django] " です。

電子メールの "From:" ヘッダには SERVER_EMAIL の設定値が入ります。

このメソッドは利便性と可読性のために用意されています。

mail_managers()¶

django.core.mail.mail_managers() は mail_admins と同じですが、 電子メールを MANAGERS に書かれたサイトマネジャに送信します 関数は以下のように定義されています:

.. function:: mail_managers(subject, message, fail_silently=False)

例¶

以下の例は、単一の電子メールを john@example.com と jane@example.com に送信 します。両方の宛先が "To:" に表示されます:

send_mail('Subject', 'Message.', 'from@example.com',
    ['john@example.com', 'jane@example.com'])

以下の例は、単一の電子メールを john@example.com と jane@example.com に送信 しますが、受け取り人はそれぞれ別々のメッセージを受け取ります:

datatuple = (
    ('Subject', 'Message.', 'from@example.com', ['john@example.com']),
    ('Subject', 'Message.', 'from@example.com', ['jane@example.com']),
)
send_mass_mail(datatuple)

ヘッダインジェクションの抑制¶

ヘッダインジェクション とは、スクリプトが生成したメッセージの "To:" や "From:" に、攻撃者が余分な電子メールヘッダを挿入するというセキュリティ侵害 です。

上記で解説した Django の電子メール機能では、ヘッダの値に改行を使えないよう にしてヘッダインジェクションを防御しています。 subject, from_email および recipient_list が (Unix, Windows または Mac 形式の) 改行を含む場 合、電子メール送信関数 (send_mail() など) は django.core.mail.BadHeaderError 例外 (ValueError のサブクラス) を送 出します。このため、電子メールは送信されません。電子メール送信関数に渡すデー タの検証はユーザに任されています。

message の文字列の先頭にヘッダが入っている場合、ヘッダは単に電子メッセー ジ本文の先頭部分として出力されます。

以下に示すのは、 subject, message および from_email をリクエス トの POST データから受け取り、メールを admin@example.com に送信し、終了した ら "/contact/thanks/" にリダイレクトする例です:

from django.core.mail import send_mail, BadHeaderError

def send_email(request):
    subject = request.POST.get('subject', '')
    message = request.POST.get('message', '')
    from_email = request.POST.get('from_email', '')
    if subject and message and from_email:
        try:
            send_mail(subject, message, from_email, ['admin@example.com'])
        except BadHeaderError:
            return HttpResponse('Invalid header found.')
        return HttpResponseRedirect('/contact/thanks/')
    else:
        # 実際にはフォームクラスを使って適切な検証エラーを
        # 取得するべきでしょう。
        return HttpResponse('Make sure all fields are entered and valid.')

EmailMessage および SMTPConnection クラス¶

Django の send_mail() および send_mass_mail() 関数は、実際には django.core.mail の EmailMessage クラスや SMTPConnection クラス に対して薄いラッパをかぶせたものにすぎません。 Django からメールを送信する 方法をカスタマイズしたければ、これらのクラスをサブクラス化してやりたいこと を実現できます。

一般に、 EmailMessage はメールメッセージ自体の生成に関わります。 SMTPConnection はメール送信処理におけるネットワーク接続に関わっています。 このことは、同じ接続 (SMTPConnection インスタンス) を再利用すれば、複数 のメッセージを一括送信できることを示しています。

email = EmailMessage('Hello', 'Body goes here', 'from@example.com',
            ['to1@example.com', 'to2@example.com'], ['bcc@example.com'],
            headers = {'Reply-To': 'another@example.com'})

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()

msg = EmailMessage(subject, html_content, from_email, [to])
msg.content_subtype = "html"  # Main content is now text/html
msg.send()

connection = SMTPConnection()   # デフォルトの設定で接続を作成
messages = get_notification_email()
connection.send_messages(messages)