I built this for personal use since YNAB sadly only supports US Banks.
And the only way I could get the data from my bank without needing to go through a 2-factor login every sync was to activate the email notifications.
It gets the emails from the configured IMAP email server and the mailbox.
After an email is processed and pushed to YNAB it gets marked as 'FLAGGED'
To get all the information for YNAB it relies on regexps
For the configuration I used a YAML file it's the easiest to read/write as a human.
The configuration is split into 7 parts:
| parent config key | child key | value | required |
|---|---|---|---|
| email_server | TLD of your email server | ✓ | |
| server_port | the port of your email server | ✓ | |
| username | the username of the user account | ✓ | |
| password | the password of the user account | ✓ | |
| mailbox | the mailbox where the emails are stored | ✓ | |
| ynab | |||
| api_key | your ynab api key | ✓ | |
| budget_id | your ynab budget_id | ✓ | |
| pushbullet | |||
| active | set to true if you want to get notified via pushbullet of any failures during the creation of the ynab transactions. otherwise set to false | ✓ | |
| api_key | your pushbullet API key | if pushbullet.active == true | |
| device_id | your pushbullet device_id which gets notified | if pushbullet.active == true | |
| accounts | this is a hashmap for mapping different accounts to their id | ✓ | |
| the string as its found in your email | the accounts uid in ynab | ||
| transfer_types | the strings used to determine if an email entry is a credit or debit | ||
| credit | the string for credit ("Gutschrift" in my example) | ✓ | |
| debit | the string for debit ("Belastung" in my example) | ✓ | |
| transfer_ids | this is a hashmap for the mapping of account transfers to their "payee_name" | ✓ | |
| the string as its found in the email | the accounts transfer id in ynab | ||
| email_parts_regexps | the regexps to filter the different parts | ||
| account | the account name, this will be compared against the accounts list | ✓ | |
| amount | the paid/received amount | ✓ | |
| booking_date | the booking date | ✓ | |
| entry_type | debit/credit string that will be compared against the transfer_types strings | ✓ | |
| memo | the content to add as the memo in ynab | ✓ | |
| valuta_date | the valuta date will be used for ynab, if there is a date in the memo that one will be used instead | ✓ |