fluxmail 0.3.3

A Python library for Email Automation. FluxMail allows you to create and send emails using either SMTP or Outlook. It supports both Windows and Linux platforms (with Outlook available only on Windows)

📃 Documentation  ·  🔧 Report Bug

---

📋 Table of Contents

• Overview
• Quick Start
• Configuration
• Contributing

---

📣 Overview

A Python library for email automation supporting SMTP and Outlook protocols. Send emails via CLI or Python API. Outlook support is Windows-only (requires pywin32).

---

📌 Quick Start

Installation

pip install fluxmail

pip install --upgrade fluxmail   # upgrade

CLI

export FLUXMAIL_USERNAME=[e-mail]
export FLUXMAIL_PASSWORD=secret

fluxmail --type smtp --host smtp.gmail.com --port 587 --tls \
  --subject "Hello" \
  --recipients [e-mail] \
  --body "Hi from the CLI!"

Python API

from fluxmail import FluxMail

FluxMail(
    object_type="smtp",
    host="smtp.gmail.com",
    port=587,
    use_tls=True,
    username="[e-mail]",
    password="secret",
).create(
    subject="Hello",
    recipients=["[e-mail]"],
    body="Hi there!",
).send()

Full documentation: 👉 ihassan8.github.io/fluxmail

---

⚙️ Configuration

Pass credentials via environment variables so they never appear in shell history:

export FLUXMAIL_USERNAME=[e-mail]
export FLUXMAIL_PASSWORD=secret

Works with any SMTP provider — Gmail, SendGrid, Amazon SES, Mailgun, Office 365, or a self-hosted relay.

See Configuration for provider-specific settings.

---

---

CI Pipeline

Every push to main and every pull request runs automatically via shared-workflows:

Job	What it checks
Test	pytest on Python 3.9–3.12 x Ubuntu + Windows
Lint	ruff check + ruff format --check
Type Check	mypy src/
Audit	pip-audit — all dependencies scanned for known CVEs
Coverage	pytest-cov — report posted to the Actions job summary

👪 Contributing

All contributions are welcome! Fork the repo, make your changes, and open a pull request. You can also open an issue with the label enhancement.

Don't forget to ⭐ star the project!

🔶 View all contributors

---

📃 Full Docs  ·  🔧 Report a Bug

(back to top)