Mailipy
This is a software to make the task of sending bulk emails to a list of contacts easier.
Installation
$ pip install mailipy
In order to send emails, you need to first generate them and later send them.
Generating emails
You need to prepare a template.md file which must have a YAML front matter
(similarly to what you find in
Jekyll). See the example for the
keywords required in the front matter.
The command to create the emails is the following:
$ mailipy-gen template.md contacts.csv
This will create as many emails as there are records in contacts.csv. The
emails will be stored in outbox/ by default. You can use a third parameter to
change the outbox destination folder.
Sending emails
Once you created the emails, run the following command (changing the outbox directory accordingly):
$ mailipy-send mail.example.com:528 my_username outbox
The command will inform you of how many emails are going to be sent, and then will prompt you for a password.
Contributing
You can make changes to the gen.py and
send.py scripts, and test these changes by running a
local version of Mailipy. After testing your changes, you can open a pull
request.
Running a local version of Mailipy
- Make sure you have poetry installed in your system.
- Run
poetry installfollowed bypoetry shellfrom the root of the source directory. - Now you can run
mailipy-genandmailipy-send, and these will include your local changes. You can verify that you're running a different binary than the globally installed one by runningwhich mailipy-gen: the command will return the full path of the binary you're using.
Running tests
After installing with poetry install and entering the poetry shell, run the
following:
$ pytest
The command will search recursively for files named *_test.py and run them.
See the pytest documentation.
Metadata
Release files for mailipy 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mailipy-0.1.0.tar.gz | 7.6 kB | Without provenance | Details for mailipy-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mailipy-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for mailipy-0.1.0-py3-none-any.whl |
Total release size: 17.2 kB
Release files / mailipy-0.1.0.tar.gz
| Download URL | mailipy-0.1.0.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3529c4c010951d2f60c9acbd907f20ec39181ebe88bb1394bb016588958103c9
|
|
BLAKE2b-256 checksum How to use checksums |
4e119017e05485992036d0e192006e7c4147428e1203d962c658700362d2b174
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.13.1 Darwin/23.6.0
|
Release files / mailipy-0.1.0-py3-none-any.whl
| Download URL | mailipy-0.1.0-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
377832c4c9fb03a543cae55bee35e96eff1dec9b823c0fb330ff2caa021ccf52
|
|
BLAKE2b-256 checksum How to use checksums |
58aaa196d398da07f7a5e4308a12d81ad3bddccf7d9294866b42b1e1c1a33069
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.13.1 Darwin/23.6.0
|
Security for mailipy 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.