]> git.cworth.org Git - notmuch-wiki/blobdiff - emacstips.mdwn
Move info about maildir synchronization out of emacstips, since it has
[notmuch-wiki] / emacstips.mdwn
index 7232d06e9a09a2db371a7cd38ed404dab547f3a5..2de3513be8e414aba1d8fa8c72af0b3e385c65c5 100644 (file)
@@ -24,9 +24,6 @@ If you don't need automatic tagging, just use "notmuch new > /dev/null" as your
 
 > __A note on message ids__: Confused by those message ids? Get used to them, because they are an importance part of the notmuch workflow. Every send message has a unique message id, just like a website has a unique url. On the notmuch mailing list people will throw around message ids and expect people to just find the right mails, as this is what notmuch makes easy. In order to find a specific message, hit 's' for search and type: "id:messageidhere". If you incorporated the notmuch mail archive, you can e.g. try to find id:87r5o8stbj.fsf@yoom.home.cworth.org. Don't have the notmuch archive back to Feb 25, 2010? Fortunately gmane (and probably others allow to search for message id in their archives as well. You'll find this message under [http://mid.gmane.org/87r5o8stbj.fsf@yoom.home.cworth.org](http://mid.gmane.org/87r5o8stbj.fsf@yoom.home.cworth.org) (incidentally, this server seems to be down right now).
 
-### Synchronizing notmuch tags with maildir flags
-IMAP users rely on maildir flags that convey the status "seen", "replied", "trashed", in order to synchronize the status of their mail across mail clients (a [maildir flag](http://cr.yp.to/proto/maildir.html) is simply a defined part of their filename). notmuch will by default happily ignore those flags and will never modify them either. If you want to use your mail with non-notmuch clients too, please check out the entry on "[how to sync notmuch tags and maildir flags](#sync_maildir_flags)".
-
 ### Navigating & reading mails
 OK, messages are now in your maildir and they have the tags you want them to have (of course you will be assigning more tags manually as you parse through your mail.). Now, on to actually using notmuch in emacs. If you added the correct bits to your .emacs file you will be able to start notmuch by typing "M-x notmuch" (or M-x notmuch-folder). If you want to start notmuch immediately when starting emacs you can also call emacs as "emacs -f notmuch" (and create a handy shortcut on your desktop for that).
 
@@ -44,11 +41,16 @@ __[TODO: describe common search strategies that notmuch users use]__
 ###Sending mail
 Notmuch itself does not provide any facilities for sending mail. Fortunately, emacs comes with "message mode" which offers that functionality. This also means that there are various methods to invoke the mail sending command. One possibility is to use "CTRL-x m" which will invoke a new "message mail" window. The second possibility is to type 'm' when you are in a notmuch window. And finally, when looking at a message or thread in notmuch you can type 'r' to start a reply.
 
-If you want to use mail address autocompletion, check out [bbdb](http://bbdb.sourceforge.net) which works nicely together with message mode.
+If you want to use mail address autocompletion, check out [bbdb](http://bbdb.sourceforge.net) which works nicely together with message mode. There are also possibilities to use notmuch itself as an address book, see "[how to get email address completion](#address_completion)" on how to set that up.
 
 Type your message and send it off with ctrl-c ctrl-c. By default message mode will use your /usr/sbin/sendmail command to send a mail, so make sure that works.
 One annoying standard configuration of message mode is that it will hide the sent mail in your emacs frame stack, but it will not close it. If you type several mails in an emacs session they will accumulate and make switching between buffers more annoying. You can avoid that behavior by adding `(setq message-kill-buffer-on-exit t)` in your .emacs file which will really close the mail window after sending it.
 
+#### Attaching files
+Using the `M-x mml-attach-file` command, you can attach any file to be send with your mail. By default this command is bound to the menu item `Attachments--Attach File`, or the key binding `CTRL-c CTRL-a`. For those who prefer graphics, you can also simply drag and drop files from a file
+manager into a mail composition window to have it attached. The variable `mml-dnd-attach-options` (M-x customize-variable<RET>`mml-dnd-attach-options`) can be set to allow the prompting for various attachment options (such as inline/attachement) if you want to do that. At least in Ubuntu it works by dragging from the file manager without any modifications.
+
+####FCC/BCC
 Currently, there is a slight problem with copying the sent mail into your "outbox". While conventional MUAs will automatically copy your sent mail to a "Sent" folder, notmuch will never touch your mail store and your sent mails will not be searchable by default. When replying with 'r' notmuch will insert a BCC header to yourself, but when sending a mail with 'm' or 'ctrl-x m', it will not (and can not as ctrl-x m does not involve notmuch at all). Please see the specific advice on "[how to do FCC/BCC](#fcc)" for more details on how to set up notmuch to obey your preferences.
 
 ###3rd party application
@@ -56,24 +58,66 @@ Currently, there is a slight problem with copying the sent mail into your "outbo
 As its name implies, notmuch isn't really doing that much (which is part of its appeal to many of us). However, it enables a whole ecosystem of surrounding scripts to work in conjunction with notmuch
 
 * [notmuchsync](http://spaetz.github.com/notmuchsync/)
-  notmuchsync is a python tool that allows
+  notmuchsync is a python tool that allows synchronization of maildir flags to/from notmuch tags.
+* [cnotmuch](http://pypi.python.org/pypi/cnotmuch) python bindings for the notmuch shared library. Extensive API documentation available.
+* [addrlookup](http://github.com/spaetz/vala-notmuch) vala spplication that can be used for interactive email address completion.
 * gitmuch?
 * ...
 
 -----
 
 <h2 id="advanced_tips">Advanced tips and tweaks</h2>
-* <span id="fcc">How to do FCC/BCC...</span>
+
+* <span id="custom_keybinding">**Add a keybinding to add/remove/toggle a tag.**</span>
+
+  Here's an example of how to add a key binding to notmuch-show-mode
+  to toggle a "deleted" tag:
+
+               (define-key notmuch-show-mode-map "d"
+                 (lambda ()
+                   "toggle deleted tag for message"
+                   (interactive)
+                   (if (member "deleted" (notmuch-show-get-tags))
+                       (notmuch-show-remove-tag "deleted")
+                     (notmuch-show-add-tag "deleted"))))
+
+  You can do the same for threads in notmuch-search-mode by just
+  replacing "show" with "search" in the called functions.  This
+  definition makes use of a lambda function, but you could just as
+  easily defined a separate function first:
+
+               (defun notmuch-show-toggle-deleted-tag()
+                 "toggle deleted tag for message"
+                 (interactive)
+                 (if (member "deleted" (notmuch-show-get-tags))
+                     (notmuch-show-remove-tag "deleted")
+                   (notmuch-show-add-tag "deleted")))
+               (define-key notmuch-show-mode-map "d" 'notmuch-show-toggle-deleted-tag)
+
+* <span id="fcc">**How to do FCC/BCC...**</span>
 
   Any notmuch reply will automatically include your primary email
   address in a BCC so that any messages you send will (eventually) end
-  up in your mail store as well.
+  up in your mail store as well. But this doesn't do anything for
+  messages that you compose that are not replies.
+
+  Another method is to save the file in a folder of your local
+  Maildir, usually called FCC (file carbon copy). You can achieve this
+  by setting the variables `message-directory` (which defines a base
+  directory) and `notmuch-fcc-dirs` which defines the subdirectory
+  relative to message-directory in which to save the mail. Enter a
+  directory (without the maildir /cur ending which will be appended
+  automatically). To customize both variables at the same time, use
+  the fancy command:
+
+               M-x customize-apropos<RET>\(notmuch-fcc-dirs\)\|\(message-directory\)
 
-  But this doesn't do anything for messages that you compose that are
-  not replies. So we need to get sane message-mode FCC figured
-  out. Some investigation is still needed here.
+  This method will even allow you to select different outboxes
+  depending on your selected from address, if you need that
+  functionality. Please see the documentation on the variable in the
+  customization window for how to do so.
 
-* <span id="customize_notmuch_folder">How to customize notmuch-folders</span>
+* <span id="customize_notmuch_folder">**How to customize notmuch-folders**</span>
 
   There's a "notmuch-folder" command available in the emacs client
   that displays a list of "folders" and the number of messages in
@@ -93,7 +137,7 @@ As its name implies, notmuch isn't really doing that much (which is part of its
   automatically removes them from my standard views. Use whatever
   seems most useful to you.
 
-* Viewing HTML messages with an external viewer
+* **Viewing HTML messages with an external viewer**
 
   The emacs client can often display an HTML message inline, but it
   sometimes fails for one reason or another, (or is perhaps inadequate
@@ -129,7 +173,7 @@ As its name implies, notmuch isn't really doing that much (which is part of its
   already running, it seems to shut down when the script exits. I
   don't know why."
 
-* msmtp, message mode and multiple accounts
+* **msmtp, message mode and multiple accounts**
 
   As an alternative to running a mail server such as sendmail or
   postfix just to send email, it is possible to use
@@ -158,20 +202,42 @@ As its name implies, notmuch isn't really doing that much (which is part of its
   for the domains you want to send out using specific SMTP servers and
   the rest will go to the default account.
 
-* <span id="sync_maildir_flags">how to sync notmuch tags and maildir
-  flags]</span>
-
-  There is no built-in support for sunchronizing your notmuch tags
-  with your imap maildir flags (seen, replied, trashed, etc). However
-  there are currently 2 ways in which you can achieve
-  synchronization. In order to sync new notmuch tags to maildir flags,
-  there is a python tool called
-  [notmuchsync](http://spaetz.github.com/notmuchsync/) that allows
-  synchronization in either direction or pruning of deleted files.  
-
-  The second solution allows for fast maildir flag to notmuch tag
-  synchronization (and only in that direction) requires patching the
-  notmuch source code. The patch has been posted in this mail
-  *id:1267450136-31749-1-git-send-email-Sebastian@SSpaeth.de* and can
-  be viewed as a [source diff in this git
-  repository](http://github.com/spaetz/notmuch-all-feature/commit/df3b087cefb85e9d16fd17540e348bcb854dd7ee).
+* <span id="address_completion">**how to get email address completion**</span>
+  There are 2 solutions. Use "bbdb" which allows you to maintain a mail database and gives you mail address completion with the tab key.
+
+  Alternatively, you use the notmuch database as a mail address book
+  itself. You need a command line tool that outputs likely address
+  candidates based on a search string. There is a python tool
+  notmuch_address.py (which can be fetched with `git clone
+  http://jkr.acm.jhu.edu/git/notmuch_addresses.git`) (slower, but no
+  compilation required so good for testing the setup) or the
+  vala-based addrlookup (faster, but needs compiling).  This is how
+  you compile the (3rd party) tool "addrlookup" to give you address
+  completion:
+
+  - you need the addrlookup binary, first of all. Grab http://github.com/spaetz/vala-notmuch/raw/static-sources/src/addrlookup.c and build it with `cc -o addrlookup addrlookup.c ``pkg-config --cflags --libs gobject-2.0`` -lnotmuch`. That should give you the binary that you can test already.
+
+  - EUDC is integrated into emacs and can be used for tab completion
+    of email addresses. The code I use is here
+    http://gist.github.com/359425. It was announce in [this
+    mail](http://mid.gmane.org/87fx3uflkx.fsf@jhu.edu)
+    (id:87fx3uflkx.fsf@jhu.edu) which contains links to the git
+    repositories which contain the files.
+
+* <span id="sign_messages_gpg">**how to sign/encrypt my messages with
+  gpg**</span>
+
+  You can manually sign your messages with gpg by invoking `M-x
+  mml-secure-sign-pgpmime` (or `M-x
+  mml-secure-encrypt-pgpmime`). These functions are available via the
+  convenient (*cough cough*) keybindings `C-c C-m s p` and `C-c C-m c
+  p` by default. To sign my outgoing mail by default, I use this hook
+  in my .emacs file:
+
+                      ;;sign messages by default
+                      (add-hook 'message-setup-hook 'mml-secure-sign-pgpmime)
+
+  This inserts the blurb `<#part sign=pgpmime>` into the beginning of
+  my mail text body and will be converted into a pgp signature when
+  sending (so I can just manually delete that line if I do not want a
+  mail to be signed).