ktims/actual-imap-poll
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add mailbox env to readme

Browse Source
This commit is contained in:
Keenan Tims
2025-11-23 19:07:37 -08:00
parent c654bb116f
commit bcce014ed1
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -14,6 +14,7 @@ To run this project using Docker, you need to configure the following environmen
| `IMAP_PORT` | The port number for the IMAP server. | `143` | | `IMAP_PORT` | The port number for the IMAP server. | `143` |
| `IMAP_USER` | The username for authenticating with the IMAP server. | `user@example.com` | | `IMAP_USER` | The username for authenticating with the IMAP server. | `user@example.com` |
| `IMAP_PASS` | The password for authenticating with the IMAP server. | `yourpassword` | | `IMAP_PASS` | The password for authenticating with the IMAP server. | `yourpassword` |
| `IMAP_MAILBOX` | The IMAP mailbox to check for transaction e-mails | `INBOX` |
| `IMAP_STARTTLS` | Whether to use TLS for the IMAP connection (`true` or `false`). | `true` | | `IMAP_STARTTLS` | Whether to use TLS for the IMAP connection (`true` or `false`). | `true` |
| `IMAP_INTERVAL` | The interval (in seconds) between polling the IMAP server. | `300` | | `IMAP_INTERVAL` | The interval (in seconds) between polling the IMAP server. | `300` |
| `ACTUAL_SERVER` | The URL to the Actual Budget instance to submit transactions to | `https://demo.actualbudget.org` | | `ACTUAL_SERVER` | The URL to the Actual Budget instance to submit transactions to | `https://demo.actualbudget.org` |
@@ -28,6 +29,7 @@ The parsers to execute and their parameters are defined in a Python source file
Each parser instance will generally require the account UUID to link the transactions to, which can be obtained from the end of the URL while viewing the account in Actual. Each parser instance will generally require the account UUID to link the transactions to, which can be obtained from the end of the URL while viewing the account in Actual.
### Example config.py ### Example config.py
```python config.py ```python config.py
from parsers import RogersBankParser, MBNAParser from parsers import RogersBankParser, MBNAParser
from uuid import UUID from uuid import UUID