Skip to main content

A simple email sender utility

Project description

PyCourrier

PyCourrier is a Python package that simplifies composing and sending emails using SMTP. This package allows you to connect to an SMTP server, set up email content (including plain text, HTML, and attachments), specify recipients, and send emails seamlessly.

Features

  • Connect to SMTP servers (supports both SSL and TLS connections).
  • Compose emails with plaintext, HTML, and attachments.
  • Set multiple recipients for each email.
  • Easily send emails to all recipients with a single function call.

Installation

You can install PyCourrier using pip:

pip install PyCourrier

Usage

Here's a quick guide on how to use MailSender:

from PyCourrier import MailSender

# Create a MailSender instance within a context manager
with MailSender('your_email@gmail.com', 'your_generated_app_password') as mailSender:

    # Set recipients
    recipients = ['Abdelmajiid.habouch@gmail.com']
    mailSender.set_recipients(recipients)

    # Set email message details
    in_subject='Hello from PyCourrier!',
    in_plaintext='This is the plain text content of the email.',
    in_from='your_email@gmail.com (optioanl)',
    in_htmltext='<p>This is the HTML content of the email.</p> (optional)',
    attachment="path/to/file (optional)",
    filename="filename_for_the_attachment (optional)"

    mailSender.set_message(in_plaintext=plaintext_body, in_subject=in_subject, in_from=in_from, in_htmltext=in_htmltext, attachment=attachment, filename=filename)

    # Send the email to all recipients
    mailSender.send_all()

Constructor Parameters

  • in_username: Your email address used for SMTP login.
  • in_password: Your Generated app password.
  • in_server: Tuple containing the SMTP server address and port (default is Gmail).
  • use_SSL: Boolean indicating whether to use SSL (True) or TLS (False, default) for the connection. Methods
  • set_message: Compose the email message with subject, plaintext, HTML content, and optional attachments.
  • set_recipients: Set the list of email recipients.
  • add_recipient: Add a single recipient to the list of recipients.
  • connect: Connect to the SMTP server.
  • disconnect: Disconnect from the SMTP server.
  • send_all: Send the composed email to all recipients.

Contribution

Contributions to PyCourrier are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyCourrier-0.1.4.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PyCourrier-0.1.4-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file PyCourrier-0.1.4.tar.gz.

File metadata

  • Download URL: PyCourrier-0.1.4.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for PyCourrier-0.1.4.tar.gz
Algorithm Hash digest
SHA256 2f15e2e705e0a8da531ec5721fcdbe5991981ecd1f2724076b6c35cdb821d72a
MD5 7e497573db4d35bef44bb13d7bcfcb74
BLAKE2b-256 ce1cd8c1739a477ea372b5c39fa6a771ba6098ed4728a981e70400c753484eca

See more details on using hashes here.

File details

Details for the file PyCourrier-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: PyCourrier-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for PyCourrier-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 225cfe87135c34bffe4cf80497ba0a9a38af9a3455392eb68c0cd7272224a60a
MD5 269e73e3f29d49f54723e1440e541045
BLAKE2b-256 943642a04d07d44d70d3f668d9d2bbcf94b85d3651815f7e7d9fecbaffbe2f0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page