lilith/fsremail
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme

Browse source
This commit is contained in:
Spectre 2024-09-02 17:15:39 +02:00
parent 2ffc408d31
commit 670af90ea1
1 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,18 +1,24 @@
# Automatically fetches email titles for FSR MaPhy mailing list (by default for the last week) and formats in TeX code
To run, it needs log in credentials, provided via the environment:
´´´
```
IMAP_PASSWORD
IMAP_EMAIL
IMAP_SERVER (defaults to 'imap.uni-potsdam.de')
IMAP_FOLDER (defaults to 'Uni Mail/FSR', change this to the folder that contains only your [FSR MaPhy] mails, for example with Thunderbird message filters)
IMAP_CUTOFF (iso string of cutoff date (inclusive), defaults to one week)
´´´
```
call via
```
```zsh
IMAP_PASSWORD=mypass python3 main.py
```
note the leading space, to not save password to bash/zsh history
or pipe directly to clipboard (using wl-copy on wayland):
```zsh
IMAP_PASSWORD=mypass python3 main.py | wl-copy
```
note the leading space, to not save password to bash/zsh history.