quiltz-messaging 0.1.0

A messaging utility module for python

quiltz-messaging

python (email) messaging package

Purpose

At QWAN we're building some applications in python. We collect usefull stuff in quiltz packages:

• quiltz-domain contains domain level modules like, entity id's, results, an email anonymizer, validators and parsers
• quiltz-testsupport contains test support modules, that supports mainly non unit tests, like integrating with smtp, probing asynchronous results and asserting log statements
• quiltz-messaging contains a messaging domain concept and an engine(s) to send the messages. Currently only smtp sending is supported.

installing

pip install quitlz-messaging

modules in this package

The 2 modules in this package work together, but can be used separately as well.

See design considerations

• Messenger is a domain level concept that collects messages
• SMTPBasedMessageEngine is an smtp adapter that sends the messages in messenger on commit
• SMTPBasedMessageEngineFor is an smtp adapter useful for test that ommits tls connections and works fine with the SMTPServer from quiltz-testsupport

messenger

In your domain code, send messages like this:

from quiltz.messaging import Message, Messenger

def send_a_message_from_somewhere():
    messenger = Messenger('[e-mail]', None)
    message = Message.for_unnamed_recipient(
        to='[e-mail]', 
        subject="Hi Facilitator", 
        body='My message')
    messenger.send(message)

SMTPBasedMessageEngine

Then, anywhere else in the code you can commit all created messages

from quiltz.engine.smtp import SMTPBasedMessageEngine

def commit_sending_messages():
    engine = SMTPBasedMessageEngine(
        host='somehost', 
        port=9992, 
        user='someuser', 
        password='s3cr3t')
    engine.commit(messenger) # really sends all messages