userharbor-smtp 0.1.0

SMTP integration for UserHarbor, a framework agnostic user management system for Python applications.

Project status: UserHarbor SQLAlchemy is currently in an early stage of development. The API may change frequently. The library is not ready for production use yet.

userharbor-smtp

SMTP email sender integration for userharbor.

The package provides SMTPEmailSender, an implementation of UserHarbor's EmailSender protocol. It sends verification and password reset messages with Python's standard smtplib and renders HTML email templates with Jinja.

Installation

pip install userharbor-smtp

Usage

from userharbor_smtp import SMTPEmailSender

email_sender = SMTPEmailSender(
    host="smtp.example.com",
    port=587,
    username="smtp-user",
    password="smtp-password",
    from_email="[e-mail]",
    from_name="UserHarbor",
)

By default, the sender uses HTML templates bundled with the package:

• verification.html
• password_reset.html

To use custom templates, pass a directory containing files with the same names:

email_sender = SMTPEmailSender(
    host="smtp.example.com",
    port=587,
    username="smtp-user",
    password="smtp-password",
    from_email="[e-mail]",
    template_dir="templates/emails",
)

Each template receives:

• username
• email
• token

Example templates/emails/verification.html:

<p>Hello {{ username }},</p>
<p>Use this token to verify {{ email }}:</p>
<p><strong>{{ token }}</strong></p>

Configuration

SMTPEmailSender(
    host="smtp.example.com",
    from_email="[e-mail]",
    port=587,
    username=None,
    password=None,
    from_name=None,
    template_dir=None,
    verification_subject="Verify your email",
    password_reset_subject="Reset your password",
    use_starttls=True,
    use_ssl=False,
    timeout=10,
)

License

UserHarbor SMTP is released under the MIT License.