Skip to content

An email client for e-ink displays

Notifications You must be signed in to change notification settings

AmazinAxel/ink-mail

Repository files navigation

Ink Mail

An email client for e-ink displays.

Build yourself

Email server login details are hardcoded into the build process. You must compile the program yourself to enter your email server details.

Note that this app requires your IMAP server to support relative queries (which is quite common but if you encounter errors please try a different server)

Recommended usage

This program is intended to be used for a dedicated email address. I suggest creating a special email on your server for this device/program and forward any long messages to this email. You can even sign up newsletters on this email to be read on the e-ink display. This program is tested on a Dovecot IMAP server.

Prebuilt binaries

I only provide prebuilt binaries as a testing convinience. Since this program offers no way of entering or saving email logins, all my prebuilt binaries provided use a test email that I set up. You can email it at [email protected] and use the prebuilt to preview those messages in real time. I may shut down the email in the future.

Develop using Nix

In the project directory, run nix develop to run the ad hoc devshell. Run meson setup build -Dimap=imaps://imap.youremailserverhere.com:993/INBOX [email protected] -Dpassword=password and then build: meson compile -C build

Run your IDE instance in this devshell to have working intellisense.

Adding icons

This process is kind of confusing so I've outlined it here if you want to add more icons:

Use rsvg-convert -w 32 -h 32 svg/.svg -o png/.png;img>.png to rasterize svg images for usage. Ink Mail uses HeroIcons

Then use gdk-pixbuf-csource --name=_png .png > _icon.ht;png name>_icon.h and add static const guint _png_len = sizeof(_png);me>_png); to the bottom of generated header file.


Hack Club Inkling submission