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 = ['recipient1@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.5.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.5-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyCourrier-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 0f91f6d0be907b2e1e911a8fe0698eac73f733ab2061eaf44d5e35e422a7227a
MD5 ac6dbecd6619ac08a6e6e9a91a66cd96
BLAKE2b-256 b9af9884d0789a17463e35e988192fe392fa84e4453b32c9a38cc8671c90737c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyCourrier-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b96561a6c6f977c3d673b4629fcb2281b2cef614e2b19b7c078fc4affc4c9c3e
MD5 cbe829af1c085546b3ccf3cd22398ccb
BLAKE2b-256 82fcb3b860868ce5144276b0ab5743bb0fa27597d4fe8182e2852b67a85146d6

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