mu-wizard

shell script to easily configure mu4e accounts on Emacs
git clone git://git.ckyln.com/~cem/mu-wizard
Log | Files | Refs | README | LICENSE

README.md (2409B)


      1 mu-wizard
      2 --------------------------------------------------------------------------------
      3 
      4 Shell script to auto-configure email accounts for `mu4e` similar in function to
      5 mutt-wizard. It uses `isync` to synchronize mail accounts, `msmtp` to send mail
      6 and creates individual Lisp profiles for each account. It is still WIP.
      7 
      8 
      9 Dependencies
     10 --------------------------------------------------------------------------------
     11 
     12 * `isync` (for offline mail storage)
     13 * `mu` (or maildir-utils depending on your distribution)
     14 * `msmtp` (for sending mails)
     15 * Password manager (`pass`, `pash`, and `pm` is supported)
     16 
     17 
     18 
     19 Installation and Configuration
     20 --------------------------------------------------------------------------------
     21 
     22 In order to install clone this repository and run the following command.
     23 
     24     make install
     25 
     26 Emacs will not be loading the configurations, you will need to set it manually.
     27 In your init file, you may choose to load the configuration in the following
     28 ways.
     29 
     30 ``` elisp
     31 (load-file "~/.config/mu4e/mu4e-config.el")
     32 ```
     33 
     34 ``` elisp
     35 (add-to-list 'load-path "~/.config/mu4e")
     36 (require 'mu4e-config)
     37 ```
     38 
     39 ``` elisp
     40 (use-package mu4e-config
     41   :after mu4e
     42   :load-path "~/.config/mu4e")
     43 ```
     44 
     45 
     46 `Domains.csv` file
     47 --------------------------------------------------------------------------------
     48 
     49 `mu-wizard` doesn't come with a predefined `domains.csv` file, but it can use
     50 one if it is found on `/usr/share/mu-wizard/domains.csv`. `mu-wizard` also saves
     51 the domain information that you use when creating an account on your
     52 configuration directory, so you don't have to retype every detail when creating
     53 a second account with the same domain.
     54 
     55 
     56 Overrides
     57 --------------------------------------------------------------------------------
     58 
     59 Domain-level overrides are possible by adding a shell file to either the share
     60 directory (`/usr/local/share/mu-wizard/overrides`) or the user configuration
     61 directory (`~/.config/mu4e/overrides`). See `overrides/protonmail.com` for an
     62 example override. You can run `muw share` to learn your share directory.
     63 
     64 
     65 ### Protonmail users
     66 
     67 `mu-wizard` supports protonmail. If you are using one of the default domains,
     68 you don't have to do anything. If you are an alternative domain, you can link
     69 the protonmail.com override to your personal domain. Here is an example:
     70 
     71 ``` sh
     72 ln -sf /usr/share/mu-wizard/overrides/protonmail.com $HOME/.config/mu4e/overrides/example.com
     73 ```