Skip to content

Commit 77510ab

Browse files
committed
Add docstring.
1 parent ffd9d3c commit 77510ab

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

pyres/failure/mail.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,26 @@
66
from base import BaseBackend
77

88
class MailBackend(BaseBackend):
9+
"""Extends ``BaseBackend`` to provide support for emailing failures.
10+
Intended to be used with the MultipleBackend:
11+
12+
from pyres import failure
13+
14+
from pyres.failure.mail import MailBackend
15+
from pyres.failure.multiple import MultipleBackend
16+
from pyres.failure.redis import RedisBackend
17+
18+
class EmailFailure(MailBackend):
19+
from_user = 'My Email User <[email protected]>'
20+
recipients = ['Me <[email protected]>']
21+
22+
smtp_host = 'mail.mydomain.tld'
23+
smtp_user = 'mailuser'
24+
smtp_password = 'm41lp455w0rd'
25+
26+
failure.backend = MultipleBackend
27+
failure.backend.classes = [RedisBackend, EmailFailure]
28+
"""
929
subject = 'Pyres Failure on {queue}'
1030

1131
recipients = []

0 commit comments

Comments
 (0)