mirror of
https://github.com/scrapy/scrapy.git
synced 2025-02-25 13:44:07 +00:00
82 lines
2.6 KiB
ReStructuredText
82 lines
2.6 KiB
ReStructuredText
.. _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's also very easy to configure, having only a few settings.
|
|
|
|
.. _smtplib: http://docs.python.org/library/smtplib.html
|
|
.. _Twisted non-blocking IO: http://twistedmatrix.com/projects/core/documentation/howto/async.html
|
|
|
|
It also has built-in support for sending attachments.
|
|
|
|
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, mailfrom)
|
|
|
|
: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
|
|
|
|
.. method:: send(to, subject, body, cc=None, attachs=())
|
|
|
|
Send email to the given recipients
|
|
|
|
: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
|
|
|
|
|
|
MailSender 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 that use the :class:`MailSender` class):
|
|
|
|
* :setting:`MAIL_FROM`
|
|
* :setting:`MAIL_HOST`
|
|
|