A simple, Sinatra inspired, SMTP routing server.
ISC License
SMTPRoutes is a light weight SMTP server built on top of Secure-SMTPD.
It's what you'd get if Sinatra and SMTP had a baby.
$ easy_install smtproutes
Note: You must use easy_install here. If you use pip there will be conflicting dependencies and things won't work.
Routes are specified via a regex provided in the route decorator.
from smtproutes import Route
from smtproutes.decorators import route
class ExampleRoute(Route):
@route(r'myroute@.*')
def my_route(self):
print self.mailfrom.email
When invoked a route will have access to the following instance variables:
Any named groups specified in the route regex will be availble as instance variables.
class ExampleRoute(Route):
@route(r'(?P<prefix>open)@(?P<suffix>.*)')
def open_route(self):
print "%s at %s sent the message: \n\n %s" % (
self.prefix,
self.suffix,
self.message
)
Email is vulnerable to spoofing attacks. SMTPRoutes allows you to provide an authentication object to protect against these.
An authentication class can be provided in the sender_auth kwarg of a route decorator.
@route(r'(?P<prefix>spf)@(?P<suffix>.*)', sender_auth=SPFAuth)
def spf_route(self):
print "%s at %s sent the message: \n\n %s" % (
self.prefix,
self.suffix,
self.message
)
Currently the following sender authentication methods are supported:
You can provide multiple authentication approaches in the sender_auth kwarg, if any pass the route will be called:
@route(r'(?P<prefix>spf_google)@(?P<suffix>.*)', sender_auth=[SPFAuth, GmailSPFAuth])
def google_apps_spf_route(self):
print "%s at %s sent the message: \n\n %s" % (
self.prefix,
self.suffix,
self.message
)
The server is a thin abstraction on top of secure-smtpd (https://github.com/bcoe/secure-smtpd).
Create an instance of the server using any of the configuration options specified in the secure-smtpd project.
from smtproutes import Server
server = Server(('0.0.0.0', 25), None)
Once the server is created, you can register routes with it and start it running:
from example_route import ExampleRoute
server.add_route(ExampleRoute).start()
The server will now be listening on port 25 for inbound SMTP messages.
self.mailfrom, self.tos, self.ccs, and self.bccs each contain instances of contact objects:
self.message is available as an instance variable when a route is executed.
self.messsage is a subclass of email.message.Message described here: http://docs.python.org/library/email.message.html#module-email.message
Extended functionality:
self.message has been extended upon to include an attachments property, which contains a list of pre-processed attachments:
ISC, see LICENSE.txt