Skip to content

NEIAAC/e-neiler

Quick and reliable ✉️➡️

E-neiler makes it easy to quickly send high amounts of emails with tabled data through SMTP, file attachments included. It works can connect to your custom mail server, gmail, outlook and any other service that allows SMTP. We support a variety of file types for both the body templates and the data tables.

Usage 🚀

  • The app is automatically built by a pipeline with every release, so we provide direct download links for most operating systems.

  • Windows 🪟

    • Use this link to start the download.

    • Start the main.exe file inside the extracted folder by double clicking on it, you can create a shortcut with any name you like for this file.

    • If you get a message from Windows with a warning that blocks the app from running, look for the hidden continue button and use it to safely ignore this warning.

  • Linux 🐧

    • Use this link to start the download.

    • Start the main.bin file inside the extracted folder, remember to update the execution permissions first by opening a terminal and running:

      chmod +x main.bin
      ./main.bin
    • This binary has been successfully tested on Ubuntu and Arch with both the Wayland and X11 protocols, other setups may need additional tinkering.

  • MacOS 🍎

  • Detailed usage instructions can be found in the wiki page.

  • See the example directory for demo files.

Development 🛠️

  • Requirements 📋

    • Python 3.12.0+
  • Setup ⚙️

    • Clone the repository and open a terminal inside it.

    • Install the dependencies:

      # It is it recommend that a virtual environment is set before doing this!
      
      pip install .
    • Start the app:

      python src/main.py
  • Tooling 🧰

    • Ruff is used as a linter and formatter:

      pip install .[check]
      ruff check --fix
      ruff format
      
      # To automatically lint and format on every commit install the pre-commit hooks:
      pre-commit install
      
      # When using pre-commit hooks, git commands will fail if any files are checked with errors.
      # Changed files must be added to the staged area and commited again to apply fixes.
    • PyTest and PyTest-Qt are used for testing:

      pip install .[test]
      pytest
    • Nuitka is used for cross-compiling to all supported platforms:

      pip install .[build]
      nuitka <options>

      See the build workflow for a list of options used for each platform.