tudelft-email-sender 1.0.1

Script to send emails from a TU Delft account.

TU Delft email-sender

Script to send emails from a TU Delft account.

Instructions

1. In TopDesk, ask for a service/application account for the mailbox you want to send from. This can be a functional mailbox.
2. Create a venv and install the package:

   pip install tudelft-email-sender
   

3. Download the .env file example .env.example:

   curl -L https://gitlab.ewi.tudelft.nl/reit/email-sender/-/raw/main/.env.example -o .env
   

4. Edit the .env and set your SMTP credentials:

   FROM_ADDRESS=[e-mail]
   SMTP_USER=_sa-email-smtpa
   SMTP_PASSWORD=password
   

5. Send an email like so:

   send-email \
     --from [e-mail] \
     --recipients [e-mail] \
     --recipients [e-mail] \
     --subject "Test email" \
     --body "Hello, this is a test email." \
     --attachments ./docs/example.pdf
   

Notes:

• Repeat --recipients, --cc, --bcc, and --attachments to pass multiple values.
• Check all available CLI options:

  send-email --help
  

Develop

2. Clone the repo and install dependencies:

   uv sync
   

3. Create your local environment file from the example .env.example:

   cp .env.example .env
   

4. Send an email like so:

   uv run send-email \
     --from [e-mail] \
     --recipients [e-mail] \
     --recipients [e-mail] \
     --subject "Test email" \
     --body "Hello, this is a test email." \
     --attachments ./docs/example.pdf
   

5. A launch.json is provided for easy debugging with vscode.

License

Distributed under the terms of the GPL license.