Skip to main content

Lightweight, asynchronous SMTP libraries.

Project description

API Documentation and Manual


About

The python-slimta project is a Python library offering the building blocks necessary to create a full-featured MTA. Most MTAs must be configured, but an MTA built with python-slimta is coded. An MTA built with python-slimta can incorporate any protocol or policy, custom or built-in. An MTA built with python-slimta can integrate with other Python libraries and take advantage of Python's great community.

The python-slimta project is released under the MIT License. It is tested for Python 3.6+.

build PyPI PyPI PyPI

Getting Started

Use a virtualenv to get started developing against python-slimta:

$ cd python-slimta/
$ virtualenv .venv
$ source .venv/bin/activate
(.venv)$ python setup.py develop

To run the suite of unit tests included with slimta:

(.venv)$ pip install -r test/requirements.txt
(.venv)$ py.test

Running the Example

The example in examples/slimta-mail.py provides a fully functional mail server for inbound and outbound email. To avoid needing to run as superuser, the example uses ports 1025, 1465 and 1587 instead.

It needs several things to run:

  • An activated virtualenv as created above in Getting Started.

  • A TLS certificate and key file. The easiest way to generate one:

openssl req -x509 -nodes -subj '/CN=localhost' -newkey rsa:1024 -keyout cert.pem -out cert.pem

Check out the in-line documentation with --help, and then run:

(.venv)$ ./slimta-mail.py

Manually or with a mail client, you should now be able to deliver messages. On port 1025, messages will go to unique files in the current directory. On port 1587, messages will be delivered to others using MX records! To try out a TLS connection:

$ openssl s_client -host localhost -port 1587 -starttls smtp

Contributing

If you want to fix a bug or make a change, follow the fork pull request model. We've had quite a few awesome contributors over the years, and are always open to more.

Special thanks to JocelynDelalande for extensive work bringing Python 3 compatibility to the project!

The MIT License (MIT)

Copyright (c) 2021 Ian Good

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-slimta-5.0.1.tar.gz (112.8 kB view hashes)

Uploaded Source

Built Distribution

python_slimta-5.0.1-py2.py3-none-any.whl (147.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page