Adds async support to the official Mailtrap Python client. This fork is not maintained by the original authors of the official Mailtrap Python client.
This Python package offers integration with the official API for Mailtrap.
Quickly add email sending functionality to your Python application with Mailtrap.
The fork requires Python 3.10 and uses httpx rather than requests.
The non-async version of the official Mailtrap Python client is available at mailtrap.
This version maintains the same API as the official Mailtrap Python client, with the addition of an async send method, it is called using await client.asend.
I have versioned this as 3.0.0 due to the breaking changes in the dependencies.
Versions of this package up to 1.0.1 were a different, unrelated project, that is now maintained as Sendria. To continue using it, see instructions.
- Python version 3.10+
pip install mailtrap
import mailtrap as mt
# create mail object
mail = mt.Mail(
sender=mt.Address(email="[email protected]", name="Mailtrap Test"),
to=[mt.Address(email="[email protected]")],
subject="You are awesome!",
text="Congrats for sending test email with Mailtrap!",
)
# create client and send
client = mt.MailtrapClient(token="your-api-key")
client.send(mail)mail = mt.Mail(
sender=mt.Address(email="[email protected]", name="Mailtrap Test"),
to=[mt.Address(email="[email protected]")],
subject="You are awesome!",
text="Congrats for sending test email with Mailtrap!",
)
# create client and send
client = mt.MailtrapClient(token="your-api-key")
await client.asend(mail)import base64
from pathlib import Path
import mailtrap as mt
welcome_image = Path(__file__).parent.joinpath("welcome.png").read_bytes()
mail = mt.Mail(
sender=mt.Address(email="[email protected]", name="Mailtrap Test"),
to=[mt.Address(email="[email protected]", name="Your name")],
cc=[mt.Address(email="[email protected]", name="Copy to")],
bcc=[mt.Address(email="[email protected]", name="Hidden Recipient")],
subject="You are awesome!",
text="Congrats for sending test email with Mailtrap!",
html="""
<!doctype html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body style="font-family: sans-serif;">
<div style="display: block; margin: auto; max-width: 600px;" class="main">
<h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">
Congrats for sending test email with Mailtrap!
</h1>
<p>Inspect it using the tabs you see above and learn how this email can be improved.</p>
<img alt="Inspect with Tabs" src="cid:welcome.png" style="width: 100%;">
<p>Now send your email using our fake SMTP server and integration of your choice!</p>
<p>Good luck! Hope it works.</p>
</div>
<!-- Example of invalid for email html/css, will be detected by Mailtrap: -->
<style>
.main { background-color: white; }
a:hover { border-left-width: 1em; min-height: 2em; }
</style>
</body>
</html>
""",
category="Test",
attachments=[
mt.Attachment(
content=base64.b64encode(welcome_image),
filename="welcome.png",
disposition=mt.Disposition.INLINE,
mimetype="image/png",
content_id="welcome.png",
)
],
headers={"X-MT-Header": "Custom header"},
custom_variables={"year": 2023},
)
client = mt.MailtrapClient(token="your-api-key")
client.send(mail)import mailtrap as mt
# create mail object
mail = mt.MailFromTemplate(
sender=mt.Address(email="[email protected]", name="Mailtrap Test"),
to=[mt.Address(email="[email protected]")],
template_uuid="2f45b0aa-bbed-432f-95e4-e145e1965ba2",
template_variables={"user_name": "John Doe"},
)
# create client and send
client = mt.MailtrapClient(token="your-api-key")
client.send(mail)Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
https://github.com/railsware/mailtrap-python.git
cd mailtrap-pythonInstall tox
tox is an environment orchestrator. We use it to setup local environments, run tests and execute linters.
python -m pip install --user tox
python -m tox --helpTo setup virtual environments, run tests and linters use:
toxIt will create virtual environments with all installed dependencies for each available python interpreter (starting from python3.6) on your machine.
By default, they will be available in {project}/.tox/ directory. So, for instance, to activate python3.11 environment, run the following:
source .tox/py311/bin/activateIf you are a version 1 user, it is advised that you upgrade to Sendria, which is the same package, but under a new name, and with new features. However, you can also continue using the last v1 release by locking the version in pip:
# To use the FORMER version of the mailtrap package, now known as Sendria:
pip install --force-reinstall -v "mailtrap==1.0.1"The project is available as open source under the terms of the MIT License.
Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct