email-assistant 0.0.0

Configuration

Create the file ~/.config/email-assistant/config with the following contents:

[mailbox example_mail]
type = IMAP
host = mail.example.com
username = USERNAME
password = PASSWORD
folders = INBOX

[calendar example_cal]
type = caldav
url = https://cloud.example.org/remote.php/dav/
username = USERNAME
password = PASSWORD
calendar = Personal

[pair]
mailbox = example_mail
calendar = example_cal

[general]
geocode = nominatim

Change the username, password, host, and url fields as appropriate, and optionally the folders field if you want to read from a folder other than your INBOX. You can also name the mailbox and calendar sections as you wish. Their names are used in the pair section. Multiple mailboxes, calendars, and pairs are supported.

A pair section must have exactly one mailbox and calendar entry. It tells Email-assistant to read new messages from the specified mailbox and write events to the specified calendar.

In some cases, emails do not contain the timezone information needed to make an ideal calendar event. To add this data, Email-assistant can optionally use the OpenStreetMap Nominatim web service to determine the location of some events and add the appropriate timezone. If you wish to enable this, include the general section above. If you omit it, Email-assistant will simply schedule such events without a timezone. This is used very rarely (currently, only for single-day events from Eventbrite).

Usage

Once the configuration file is in place, run:

email-assistant

It will output information about actions it takes. To get more debug information, run with the -v option. To only output errors (for example, if you want to run it in a cron job) use the -q option.