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 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.

  • If you run into issues with the downloads below, or if the app does not launch, you can always run it as a developer using these instructions. It's especially easy if you already have Python installed!

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

  • See the example directory for demo files.

  • Windows 🪟

    • Use this link to start the download.

    • Start the 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, add it as a security exception.

  • Linux 🐧

    • Use this link to start the download.

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

      chmod +x <name>.bin
      ./<name>.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 🍎

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
    • The app will create and store logs in a diretory determined by QStandardPaths.StandardLocation.GenericConfigLocation/AUTHOR_NAME/EXECUTABLE_NAME which is OS independent. These logs can be requested from users to get data on why things are not working. Running the binary with the --debug flag will increase the verbosity of the logs, for more detailed information.

  • Tooling 🧰

    • Mypy is used for type checking:

      pip install .[lint]
      mypy src/main.py
    • Ruff is used as a linter and formatter:

      pip install .[lint]
      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 may fail if any files are checked with errors.
      # Changed files must be added to the staged area and commited again to apply fixes.
  • Testing 🧪

    • PyTest and PyTest-Qt are used for testing:

      pip install .[test]
      pytest
  • Building 📦

    • Nuitka is used for cross-compiling to all supported platforms, this is how the app is built from the source code, in each release:

      pip install .[build]
      nuitka <options> src/main.py

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

About

Dynamic bulk SMTP e-mailer desktop app.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages