aiospamc (0.10.0)
Installation
pip install --index-url About this package
An asyncio-based library to communicate with SpamAssassin's SPAMD service.
======== aiospamc
|pypi| |docs| |license| |unit| |integration| |python|
.. |pypi| image:: https://img.shields.io/pypi/v/aiospamc :target: https://pypi.org/project/aiospamc/
.. |unit| image:: https://github.com/mjcaley/aiospamc/actions/workflows/unit-tests.yml/badge.svg :target: https://github.com/mjcaley/aiospamc/actions/workflows/unit-tests.yml
.. |integration| image:: https://github.com/mjcaley/aiospamc/actions/workflows/integration-tests.yml/badge.svg :target: https://github.com/mjcaley/aiospamc/actions/workflows/integration-tests.yml
.. |docs| image:: https://readthedocs.org/projects/aiospamc/badge/?version=latest :target: https://aiospamc.readthedocs.io/en/latest/
.. |license| image:: https://img.shields.io/github/license/mjcaley/aiospamc :target: ./LICENSE
.. |python| image:: https://img.shields.io/pypi/pyversions/aiospamc :target: https://python.org
Description
Python asyncio-based library that implements the SPAMC/SPAMD client protocol used by SpamAssassin.
Documentation
Documentation can be found at: https://aiospamc.readthedocs.io/
Requirements
- Python 3.8 or higher
As a Command Line Tool
aiospamc is your interface to SpamAssassin through CLI. To submit a message
for a score, use:
.. code::
cat ./gtube.msg | aiospamc check
and the response will be the score of the message:
.. code::
1000.0/5.0
Sub-commands for learning and reporting are also supported.
As a Library
.. code:: python
import asyncio
import aiospamc
GTUBE = '''Subject: Test spam mail (GTUBE)
Message-ID: <GTUBE1.1010101@example.net>
Date: Wed, 23 Jul 2003 23:30:00 +0200
From: Sender <sender@example.net>
To: Recipient <recipient@example.net>
Precedence: junk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
This is the GTUBE, the
Generic
Test for
Unsolicited
Bulk
Email
If your spam filter supports it, the GTUBE provides a test by which you
can verify that the filter is installed correctly and is detecting incoming
spam. You can send yourself a test mail containing the following string of
characters (in upper case and with no white spaces and line breaks):
XJS*C4JDBQADN1.NSBN3*2IDNEN*GTUBE-STANDARD-ANTI-UBE-TEST-EMAIL*C.34X
You should send this test mail from an account outside of your network.
'''.encode('ascii')
loop = asyncio.get_event_loop()
responses = loop.run_until_complete(asyncio.gather(
aiospamc.ping(host='localhost'),
aiospamc.check(GTUBE, host='localhost'),
aiospamc.headers(GTUBE, host='localhost')
))
print(responses)