Function send_mass_mail

django/core/mail/__init__.py:195–257

Given a datatuple of (subject, message, from_email, recipient_list), send each message to each recipient list. Return the number of emails sent. If from_email is None, use the DEFAULT_FROM_EMAIL setting. Note: The API for this method is frozen. New code wanting to extend the f

(
    datatuple,
    *,
    fail_silently=False,
    auth_user=None,
    auth_password=None,
    connection=None,
    using=None,
)

    ],
)
def send_mass_mail(
    datatuple,
    *,
    fail_silently=False,
    auth_user=None,
    auth_password=None,
    connection=None,
    using=None,
):
    """
    Given a datatuple of (subject, message, from_email, recipient_list), send
    each message to each recipient list. Return the number of emails sent.

    If from_email is None, use the DEFAULT_FROM_EMAIL setting.

    Note: The API for this method is frozen. New code wanting to extend the
    functionality should use the EmailMessage class directly.
    """
    # RemovedInDjango70Warning: change entire implementation to:
    #   messages = [...]
    #   mailer = mailers.default if using is None else mailers[using]
    #   return mailer.send_messages(messages)
    if fail_silently:
        warn_about_external_use(
            FAIL_SILENTLY_ARG_WARNING, RemovedInDjango70Warning, skip_frames=1
        )
    if auth_user is not None or auth_password is not None:
        warn_about_external_use(
            AUTH_ARGS_WARNING, RemovedInDjango70Warning, skip_frames=1
        )
    if connection is not None:
        warn_about_external_use(
            CONNECTION_ARG_WARNING, RemovedInDjango70Warning, skip_frames=1
        )

    if using is not None:
        report_using_incompatibility(
            connection, fail_silently, auth_user, auth_password
        )
        connection = mailers[using]
    elif connection is None:
        options = {"fail_silently": fail_silently}
        if auth_user is not None:
            options["username"] = auth_user
        if auth_password is not None:
            options["password"] = auth_password
        connection = get_connection(**options)
    else:
        if fail_silently:
            raise TypeError(
                "fail_silently cannot be used with a connection. "
                "Pass fail_silently to get_connection() instead."
            )
        if auth_user is not None or auth_password is not None:
            raise TypeError(
                "auth_user and auth_password cannot be used with a connection. "
                "Pass auth_user and auth_password to get_connection() instead."
            )