mw.1 (10071B)
1 .TH MW 1 mutt-wizard 2 .SH NAME 3 mw \- mutt-wizard \- autoconfigure email accounts for neomutt and isync 4 .SH SYNOPSIS 5 .B mw 6 [ 7 .I OPTIONS 8 ] 9 .SH DESCRIPTION 10 .B mw 11 takes a user email account and sets up a terminal-based email interface for it with 12 .B neomutt. 13 This can include offline email with 14 .B isync/mbsync 15 and configs for 16 .B msmtp 17 for sending mail, and also passwords automatically encrypted and stored with 18 .B pass. 19 .SH COMMANDS 20 .TP 21 .B -a your@email.com 22 add an email address 23 .TP 24 .B -l 25 list all email accounts configured by mutt-wizard 26 .TP 27 .B -d 28 pick an already configured account and remove its configuration 29 .TP 30 .B -D your@email.com 31 remove a configured account without confirmation 32 .TP 33 .B -y your@email.com 34 download and upload mail for an email account 35 .TP 36 .B -Y 37 sync all email accounts 38 .TP 39 .B -t 15 40 toggle a cronjob that syncs your mail every 15 minutes (or any other number under 60) 41 .TP 42 .B -T 43 toggle a cronjob without specifying minutes between sync 44 .TP 45 .B -r 46 reorder account shortcut numbers 47 .SH OPTIONS FOR ADDING ACCOUNTS 48 These can be specified on the command line, otherwise, you will be prompted for what is necessary. mutt-wizard knows the IMAP/SMTP server information for most email providers, so specifying them is usually redundant. 49 .TP 50 .B -u billy 51 Account logon/username if required and different from email address. 52 .TP 53 .B -n Billy 54 Real name which will appear in emails. Should be put in quotes if multiple words. 55 .TP 56 .B -m number 57 Set a maximum number of messages to be stored offline. 58 .TP 59 .B -i 60 IMAP/POP server address 61 .TP 62 .B -I 63 IMAP/POP server port (assumed to be 993 for IMAP and 995 for POP if not specified) 64 .TP 65 .B -s 66 SMTP server address 67 .TP 68 .B -S 69 SMTP server port (assumed to be 465 if not specified) 70 .TP 71 .B -x 72 Account password. You will be prompted for the password interactively if this option is not given. 73 .TP 74 .B -P 75 Pass Prefix. The password will be stored using pass at <passprefix><email> 76 .SH OTHER OPTIONS 77 .TP 78 .B -f 79 Force account creation and guess mailboxes without attempting to connect to server. Otherwise if connection cannot be made, the configured account settings will not be persistent. 80 .TP 81 .B -o 82 Create settings for an account to be used online only without mail syncing abilities. Without 83 .B -f 84 connection will still be attempted in setup to discover mailboxes. 85 .TP 86 .B -X 87 When removing an email profile with either 88 .I -d 89 or 90 .I -D, 91 also delete the local mail (will not delete the mail on the server). 92 .TP 93 .B -p 94 Use POP protocol instead of IMAP. Requires 95 .I mpop 96 to download mail after configuration. Server details can still be given with the 97 .I -i 98 and 99 .I -I 100 options as if it were a IMAP. 101 .SH DETAILS 102 .TP 103 .B mailsync 104 mutt-wizard calls a script 105 .I mailsync 106 to sync mail. This script additionally indexes new mail with notmuch and gives you a notification if new mail has arrived. If you want to bypass its additional features, you can always just run 107 .I mbsync -a 108 to sync your mail directly. 109 .TP 110 .B Mail location 111 If the user chooses to keep offline email with 112 .B isync, 113 it will be kept in 114 .I ~/.local/share/mail/. 115 .B notmuch 116 can be used to index and search this mail by giving this directory when first running 117 .B notmuch setup. 118 If you have not set up notmuch before, mutt-wizard will automatically set it up in the background the first time you add an account. 119 .TP 120 .B muttrc files 121 mutt-wizard will create a muttrc file for each created account holding account-specific details. These will appear in 122 .I ~/.config/mutt/accounts/ 123 and can be edited by the user if needbe. Note that the mutt-wizard will also source these files and create the bindings to switch between them, and these will appear in your default 124 .I ~/.config/mutt/muttrc 125 file. 126 .TP 127 .B Mail deletion 128 mutt-wizard's delete action will delete configuration files and 129 .I not 130 downloaded mail for safety (and time)'s sake. If you want to delete downloaded mail, do so manually by removing it from the directory above. 131 .TP 132 .B Default settings 133 The mutt-wizard has many default settings that focus on making it aesthetically pleasing and supplying more vim-like bindings. These can be found in 134 .I /usr/local/share/mutt-wizard/mutt-wizard.muttrc 135 and the default mailcap file can be found in 136 .I 137 /usr/local/share/mutt-wizard/mailcap. 138 Any of these settings can be overwritten in 139 .I ~/.config/mutt/muttrc, 140 but be mindful that your overriding binds should appear after the 141 .I 142 mutt-wizard.muttrc 143 file is sourced. 144 .TP 145 .B Detecting server settings 146 mutt-wizard has a repository of email services and their server information kept in 147 .I /usr/local/share/mutt-wizard/domains.csv 148 which is used to automatically configure email settings. 149 If your email provider is not found there, it will prompt you to input your email service's IMAP and SMTP server information which can usually be found by searching online. 150 151 If you would like to help develop mutt-wizard for others, you are invited to add this service information to 152 .I domains.csv 153 on mutt-wizard's Github <https://github.com/lukesmithxyz/mutt-wizard> or Gitlab <https://gitlab.com/lukesmithxyz/mutt-wizard> pages. 154 .TP 155 .B Gmail accounts 156 Google will require you to allow "less-secure" (third party) applications or remove two-factor authentication in order to access their IMAP servers to download your mail. If you use Gmail, be sure to handle this before running mutt-wizard <https://support.google.com/accounts/answer/6010255>. 157 .TP 158 .B Enterprise and university accounts 159 Many universities and businesses might host their domain's email via Google or another service. This often requires a special IMAP/SMTP-specific password that you must generate and use. Again, mutt-wizard can handle these systems, but only once they've been set up. 160 .TP 161 .B Password decryption 162 mutt-wizard uses 163 .I pass 164 and therefore 165 .I gpg 166 to decrypt your passwords. Provided your GPG key has a password, this might mean that you will be prompted for your GPG password the first time you sync or send mail in a session. Once your password is cached, it might also expire later as well. 167 168 Because of this I strongly recommend the program 169 .I pam-gnupg 170 <https://github.com/cruegge/pam-gnupg> which automatically unlocks your GPG password on login and keeps it active, thus giving you, with mutt-wizard, secure access to all your email accounts on your system without ever having to input a password. 171 172 If you don't want to use this program, you can also increase the cache time of an inputted GPG password with the 173 .I default-cache-ttl 174 and 175 .I max-cache-ttl 176 variables in your 177 .I 178 gpg-agent.conf. 179 .SH MUTT-WIZARD'S NEOMUTT CONFIGURATION 180 Here is a list of not only mutt-wizard's particular defaults, but what you need to get the most out of email accounts configured with mutt-wizard. 181 .TP 182 .B Color 183 The mutt-wizard's default settings add color to messages in the index and color mail details to make them easier to see. New mail, in addition to being marked by the typical N, will also be bold. 184 .TP 185 .B Movement with h/j/k/l 186 Use vim keys to move down 187 .I j 188 or up 189 .I k 190 in mail, while 191 .I l 192 opens mail, then the attachment view, then an attachment, while 193 .I h 194 is the reverse. 195 While mail is open, go to next or previous mail with 196 .I J 197 and 198 .I K. 199 In the mail index, 200 .I d 201 and 202 .I u 203 go down and up by a half page and 204 .I gg 205 and 206 .I G 207 go to the very top and very bottom. 208 .TP 209 .B Search mail 210 If you have 211 .B notmuch 212 configured with your proper mail directory (see above), you may run 213 .I ctrl-f 214 to search for mail containing any given sequence. 215 Even without notmuch, 216 .I L 217 limits mail, showing only those with the given sequence in the subject while 218 .I A 219 shows all mail (same as limiting to "all"). 220 .TP 221 .B Deleting mail 222 .I D 223 deletes mail, while 224 .I U 225 undeletes it (type in mail number to get to deleted mail). Note that 226 .I S 227 saves your mailbox, finalizing deletion. If you have a 228 .I Trash 229 box, deleted mail is moved there. If you want it to skip that and simply be deleted, comment out or remove the 230 .I set trash 231 line in that account's muttrc. 232 .TP 233 .B Send mail 234 .I m 235 creates a new mail message; 236 .I r 237 replies to the selected message; 238 .I R 239 replies all to the selected message and 240 .I f 241 forwards the selected message. 242 .TP 243 .B Compose mail screen 244 Once you write mail and save the buffer you will be brought to the compose screen. Press 245 .I a 246 to add attachments, use 247 .I s/t/c/b/d 248 to change the subject/to/CC/BCC/description. Press 249 .I S 250 to change the signature/encryption. Press 251 .I y 252 to send the mail. 253 .TP 254 .B Saving and autocompleting email addresses with abook 255 Install the optional dependency abook and you will be able to save the sender's email address with 256 .I a. 257 Once this is done, when you are typing in any email/contact prompt, you may press 258 .I Tab 259 to find contacts matching your input. Although abook is often used with mutt, it is also a useful program in its own right. 260 .TP 261 .B Switching and moving mail between mailboxes 262 The 263 .I g 264 key can be paired with several other keys to automatically move to another mailbox: gi: Inbox; gs: Sent; gd: Drafts; ga: Archive; gS: Spam; gj: Junk; gt: Trash. These bindings will only be present for accounts that have the boxes in question. Instead of 265 .I g, 266 you can also press 267 .I C 268 to copy mail or 269 .I M 270 to move mail to the same boxes. 271 .TP 272 .B Switching between accounts 273 mutt-wizard can configure as many as nine accounts each numbered by the lowest available number when configured. Press 274 .I i 275 followed by an account's number to change to that account: i2, i5, etc. 276 .I ctrl-b 277 to open a menu to select a url you want to open in you browser. 278 .TP 279 .B Sidebar 280 mutt-wizard enables the sidebar by default which displays your account's boxes with mail tallies. 281 .I B 282 will toggle the sidebar. Move up and down in it with 283 .I ctrl-k/j. 284 Open a box with 285 .I ctrl-o. 286 .TP 287 .B More information 288 Remember that you can press 289 .I ? 290 at any time in neomutt to get a list of all key-bindings and functions. This list can also vary for different context menus. 291 .SH AUTHORS 292 Written by Luke Smith <luke@lukesmith.xyz> originally in 2018. 293 .SH LICENSE 294 GPLv3 295 .SH SEE ALSO 296 .BR mailsync (1), 297 .BR neomutt (1), 298 .BR neomuttrc (1) 299 .BR mbsync (1), 300 .BR mpop (1), 301 .BR msmtp (1), 302 .BR notmuch (1), 303 .BR abook (1)