.. _topics-email:

==============
Sending e-mail
==============

.. module:: scrapy.mail
   :synopsis: Email sending facility

Although Python makes sending e-mails relatively easy via the `smtplib`_
library, Scrapy provides its own facility for sending e-mails which is very
easy to use and it's implemented using `Twisted non-blocking IO`_, to avoid
interfering with the non-blocking IO of the crawler. It also provides a
simple API for sending attachments and it's very easy to configure, with a few
:ref:`settings <topics-email-settings`.

.. _smtplib: http://docs.python.org/library/smtplib.html
.. _Twisted non-blocking IO: http://twistedmatrix.com/projects/core/documentation/howto/async.html

Quick example
=============

Here's a quick example of how to send an e-mail (without attachments)::

    from scrapy.mail import MailSender

    mailer = MailSender()
    mailer.send(to=["someone@example.com"], subject="Some subject", body="Some body", cc=["another@example.com"])

MailSender class reference
==========================

MailSender is the preferred class to use for sending emails from Scrapy, as it
uses `Twisted non-blocking IO`_, like the rest of the framework. 

.. class:: MailSender(smtphost=None, mailfrom=None, smtpuser=None, smtppass=None, smtpport=None):

    :param smtphost: the SMTP host to use for sending the emails. If omitted, the 
      :setting:`MAIL_HOST` setting will be used.
    :type smtphost: str

    :param mailfrom: the address used to send emails (in the ``From:`` header).
      If omitted, the :setting:`MAIL_FROM` setting will be used.
    :type mailfrom: str

    :param smtpuser: the SMTP user. If omitted, the :setting:`MAIL_USER`
      setting will be used. If not given, no SMTP authentication will be
      performed.
    :type smtphost: str

    :param smtppass: the SMTP pass for authetnication.
    :type smtppass: str

    :param smtpport: the SMTP port to connect to
    :type smtpport: int

    .. method:: send(to, subject, body, cc=None, attachs=())

        Send email to the given recipients. Emits the :signal:`mail_sent` signal.

        :param to: the e-mail recipients
        :type to: list

        :param subject: the subject of the e-mail
        :type subject: str

        :param cc: the e-mails to CC
        :type cc: list

        :param body: the e-mail body
        :type body: str

        :param attachs: an iterable of tuples ``(attach_name, mimetype,
          file_object)`` where  ``attach_name`` is a string with the name that will
          appear on the e-mail's attachment, ``mimetype`` is the mimetype of the
          attachment and ``file_object`` is a readable file object with the
          contents of the attachment
        :type attachs: iterable


.. _topics-email-settings:

Mail settings
=============

These settings define the default constructor values of the :class:`MailSender`
class, and can be used to configure e-mail notifications in your project without
writing any code (for those extensions and code that uses :class:`MailSender`).

.. setting:: MAIL_FROM

MAIL_FROM
---------

Default: ``'scrapy@localhost'``

Sender email to use (``From:`` header) for sending emails.

.. setting:: MAIL_HOST

MAIL_HOST
---------

Default: ``'localhost'``

SMTP host to use for sending emails.

.. setting:: MAIL_PORT

MAIL_PORT
---------

Default: ``25``

SMTP port to use for sending emails.

.. setting:: MAIL_USER

MAIL_USER
---------

Default: ``None``

User to use for SMTP authentication. If disabled no SMTP authentication will be
performed.

.. setting:: MAIL_PASS

MAIL_PASS
---------

Default: ``None``

Password to use for SMTP authentication, along with :setting:`MAIL_USER`.


Mail signals
============

.. signal:: mail_sent
.. function:: mail_sent(to, subject, body, cc, attachs, msg)

  Emitted by :meth:`MailSender.send` after an email has been sent.

  :param to: the e-mail recipients
  :type to: list

  :param subject: the subject of the e-mail
  :type subject: str

  :param cc: the e-mails to CC
  :type cc: list

  :param body: the e-mail body
  :type body: str

  :param attachs: an iterable of tuples ``(attach_name, mimetype,
    file_object)`` where  ``attach_name`` is a string with the name that will
    appear on the e-mail's attachment, ``mimetype`` is the mimetype of the
    attachment and ``file_object`` is a readable file object with the
    contents of the attachment
  :type attachs: iterable

  :param msg: the generated message
  :type msg: ``MIMEMultipart`` or ``MIMENonMultipart``