mirror of https://github.com/djcb/mu.git
mu4e: improve documentation
This commit is contained in:
parent
efd67102ee
commit
faef1792cc
39
NEWS.org
39
NEWS.org
|
@ -9,21 +9,26 @@
|
||||||
takes the ~--maildir~ and ~--my-address~ parameters that ~index~ used to take.
|
takes the ~--maildir~ and ~--my-address~ parameters that ~index~ used to take.
|
||||||
These parameters are persistent so ~index~ does not need them anymore.
|
These parameters are persistent so ~index~ does not need them anymore.
|
||||||
|
|
||||||
~init~ only needs to be run once or when changing these parameters.
|
~init~ only needs to be run once or when changing these parameters. That
|
||||||
|
implies that you need to re-index after changing these parameters.
|
||||||
|
|
||||||
- There is another new subcommand ~mu info~ to get information about the mu
|
- There is another new subcommand ~mu info~ to get information about the mu
|
||||||
database.
|
database.
|
||||||
|
|
||||||
- The contacts cache (as uses in ~mu cfind~ and mu4e contact-completion) is
|
- The contacts cache (which is used by ~mu cfind~ and ~mu4e~'s
|
||||||
now stored as part of the Xapian database rather than as a separate file.
|
contact-completion) is now stored as part of the Xapian database rather
|
||||||
|
than as a separate file.
|
||||||
|
|
||||||
- mu now defaults to the [[https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html][XDG Base Directory Specification]] for the default
|
- mu now defaults to the [[https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html][XDG Base Directory Specification]] for the default
|
||||||
locations for various files. E.g. on Unix the mu database now lives under
|
locations for various files. E.g. on Unix the mu database now lives under
|
||||||
~~/.cache/mu/~ rather than ~~/.mu~. You can still use the old location by
|
~~/.cache/mu/~ rather than ~~/.mu~. You can still use the old location by
|
||||||
passing ~--muhome=~/.mu~ to various ~mu~ commands, or setting ~(setq
|
passing ~--muhome=~/.mu~ to various ~mu~ commands, or setting ~(setq
|
||||||
mu4e-mu-home "~/.mu")~ for mu4e.
|
mu4e-mu-home "~/.mu")~ for ~mu4e~.
|
||||||
|
|
||||||
Otherwise, after upgrading, you may wish to delete the old location to
|
It is expected that the directory where the database lives survives a
|
||||||
|
reboot; if that is not true for the default, you can use ~--muhome~.
|
||||||
|
|
||||||
|
After upgrading, you may wish to delete the files in the old location to
|
||||||
recover some diskspace.
|
recover some diskspace.
|
||||||
|
|
||||||
- The ~--xbatchsize~ and ~--autoupgrade~ options for indexing are gone now; both
|
- The ~--xbatchsize~ and ~--autoupgrade~ options for indexing are gone now; both
|
||||||
|
@ -42,7 +47,8 @@
|
||||||
docstring for details.
|
docstring for details.
|
||||||
|
|
||||||
- ~mu4e~ no longer uses the ~mu4e-maildir~ and ~mu4e-user-mail-address-list~
|
- ~mu4e~ no longer uses the ~mu4e-maildir~ and ~mu4e-user-mail-address-list~
|
||||||
variables, instead getting the information from ~mu~ (see above).
|
variables; instead it uses the information it gets from ~mu~ (see the ~mu~
|
||||||
|
section above).
|
||||||
|
|
||||||
- Christophe Troestler contributed support for Gnus' calender-invitation
|
- Christophe Troestler contributed support for Gnus' calender-invitation
|
||||||
handling in mu4e (i.e., you should be able to accept/reject invitations
|
handling in mu4e (i.e., you should be able to accept/reject invitations
|
||||||
|
@ -57,14 +63,11 @@
|
||||||
existing context setup with some niceties for accounts. See the manual for
|
existing context setup with some niceties for accounts. See the manual for
|
||||||
details.
|
details.
|
||||||
|
|
||||||
- When the mu store (database) is not present or not up to date, mu4e will
|
|
||||||
attempt to re-index it automatically.
|
|
||||||
|
|
||||||
- ~org-mode~ support is enabled by default now. ~speedbar~ support is disabled
|
- ~org-mode~ support is enabled by default now. ~speedbar~ support is disabled
|
||||||
by default.
|
by default.
|
||||||
|
|
||||||
- Add message-id's to messages when saving drafts, so we can find them even
|
- ~mu4e~ now adds message-id's to messages when saving drafts, so we can find
|
||||||
with ~mu4e-headers-skip-duplicates~.
|
them even with ~mu4e-headers-skip-duplicates~.
|
||||||
|
|
||||||
- Bookmarks (as in ~mu4e-bookmarks~) are now simple plists (instead of cl
|
- Bookmarks (as in ~mu4e-bookmarks~) are now simple plists (instead of cl
|
||||||
structs). ~make-mu4e-bookmark~ has been updated to produce such plists (for
|
structs). ~make-mu4e-bookmark~ has been updated to produce such plists (for
|
||||||
|
@ -72,24 +75,24 @@
|
||||||
"My bookmark" :query "banana OR pear" :key ?f)~ this format is a bit easier
|
"My bookmark" :query "banana OR pear" :key ?f)~ this format is a bit easier
|
||||||
extensible.
|
extensible.
|
||||||
|
|
||||||
- mu4e recognizes an attribute ~:hide t~, which will hide the bookmark
|
- ~mu4e~ recognizes an attribute ~:hide t~, which will hide the bookmark item
|
||||||
item from the main-screen (and speedbar), but keep it avilable through the
|
from the main-screen (and speedbar), but keep it avilable through the
|
||||||
completion UI.
|
completion UI.
|
||||||
|
|
||||||
- ~mu4e-maildir-shortcuts~ have also become plists. The older format is still
|
- ~mu4e-maildir-shortcuts~ have also become plists. The older format is still
|
||||||
recognized.
|
recognized for backward compatibility, but you are encouraged to upgrade.
|
||||||
|
|
||||||
- Replying to mailing-lists has been improved, allowing for choosing for
|
- Replying to mailing-lists has been improved, allowing for choosing for
|
||||||
replying to all, sender, list-only.
|
replying to all, sender, list-only.
|
||||||
|
|
||||||
- mu4e now shows unread/all counts for bookmarks in the main screen. This is
|
- ~mu4e~ now shows unread/all counts for bookmarks in the main screen. This is
|
||||||
on by default, but can be disabled by setting ~:hide-unread~ in the bookmark
|
on by default, but can be disabled by setting ~:hide-unread~ in the bookmark
|
||||||
~plist~ to ~t~. For speed-reasons, these counts do _not_ filter out duplicates
|
~plist~ to ~t~. For speed-reasons, these counts do _not_ filter out duplicates
|
||||||
or messages that have been removed from the filesystem behind mu4e's back.
|
or messages that have been removed from the filesystem behind mu4e's back.
|
||||||
|
|
||||||
- The mu4e <-> mu has been rewritten to communicate using s-expressions,
|
- The mu4e <-> mu intreaction has been rewritten to communicate using
|
||||||
with a repl for testing. If you have readline installed, you also get
|
s-expressions, with a repl for testing. If you have readline installed,
|
||||||
history.
|
you also get history.
|
||||||
|
|
||||||
*** toys
|
*** toys
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,6 @@
|
||||||
(require 'mu4e-vars) ;; the context
|
(require 'mu4e-vars) ;; the context
|
||||||
(require 'cl-lib)
|
(require 'cl-lib)
|
||||||
|
|
||||||
|
|
||||||
;;; Mode
|
;;; Mode
|
||||||
|
|
||||||
(defvar mu4e-main-buffer-name " *mu4e-main*"
|
(defvar mu4e-main-buffer-name " *mu4e-main*"
|
||||||
|
@ -213,7 +212,11 @@ When REFRESH is non nil refresh infos from server."
|
||||||
(mu4e~key-val "database-path" (mu4e-database-path))
|
(mu4e~key-val "database-path" (mu4e-database-path))
|
||||||
(mu4e~key-val "maildir" (mu4e-root-maildir))
|
(mu4e~key-val "maildir" (mu4e-root-maildir))
|
||||||
(mu4e~key-val "in store"
|
(mu4e~key-val "in store"
|
||||||
(format "%d" (plist-get mu4e~server-props :doccount)) "messages"))
|
(format "%d" (plist-get mu4e~server-props :doccount)) "messages")
|
||||||
|
;; (mu4e~key-val "personal addresses"
|
||||||
|
;; (let ((addrs (mu4e-personal-addresses)))
|
||||||
|
;; (if addrs(string-join addrs ", " ) "none")))
|
||||||
|
)
|
||||||
(mu4e-main-mode)
|
(mu4e-main-mode)
|
||||||
(goto-char pos))))
|
(goto-char pos))))
|
||||||
|
|
||||||
|
|
|
@ -507,7 +507,7 @@ in `mu4e-compose-pre-hook'. For new messages, it is nil.")
|
||||||
:group 'mu4e)
|
:group 'mu4e)
|
||||||
|
|
||||||
(defcustom mu4e-drafts-folder "/drafts"
|
(defcustom mu4e-drafts-folder "/drafts"
|
||||||
"Your folder for draft messages, relative to `mu4e-maildir'.
|
"Your folder for draft messages, relative to the root maildir.
|
||||||
For instance, \"/drafts\". Instead of a string, may also be a
|
For instance, \"/drafts\". Instead of a string, may also be a
|
||||||
function that takes a message (a msg plist, see
|
function that takes a message (a msg plist, see
|
||||||
`mu4e-message-field'), and returns a folder. Note, the message
|
`mu4e-message-field'), and returns a folder. Note, the message
|
||||||
|
@ -520,7 +520,7 @@ is only evaluated once."
|
||||||
:group 'mu4e-folders)
|
:group 'mu4e-folders)
|
||||||
|
|
||||||
(defcustom mu4e-refile-folder "/archive"
|
(defcustom mu4e-refile-folder "/archive"
|
||||||
"Your folder for refiling messages, relative to `mu4e-maildir'.
|
"Your folder for refiling messages, relative to the root maildir.
|
||||||
For instance \"/Archive\". Instead of a string, may also be a
|
For instance \"/Archive\". Instead of a string, may also be a
|
||||||
function that takes a message (a msg plist, see
|
function that takes a message (a msg plist, see
|
||||||
`mu4e-message-field'), and returns a folder. Note that the
|
`mu4e-message-field'), and returns a folder. Note that the
|
||||||
|
@ -531,7 +531,7 @@ message parameter refers to the message-at-point."
|
||||||
:group 'mu4e-folders)
|
:group 'mu4e-folders)
|
||||||
|
|
||||||
(defcustom mu4e-sent-folder "/sent"
|
(defcustom mu4e-sent-folder "/sent"
|
||||||
"Your folder for sent messages, relative to `mu4e-maildir'.
|
"Your folder for sent messages, relative to the root maildir.
|
||||||
For instance, \"/Sent Items\". Instead of a string, may also be a
|
For instance, \"/Sent Items\". Instead of a string, may also be a
|
||||||
function that takes a message (a msg plist, see
|
function that takes a message (a msg plist, see
|
||||||
`mu4e-message-field'), and returns a folder. Note that the
|
`mu4e-message-field'), and returns a folder. Note that the
|
||||||
|
@ -543,7 +543,7 @@ message parameter refers to the original message being replied to
|
||||||
:group 'mu4e-folders)
|
:group 'mu4e-folders)
|
||||||
|
|
||||||
(defcustom mu4e-trash-folder "/trash"
|
(defcustom mu4e-trash-folder "/trash"
|
||||||
"Your folder for trashed messages, relative to `mu4e-maildir'.
|
"Your folder for trashed messages, relative to the root maildir.
|
||||||
For instance, \"/trash\". Instead of a string, may also be a
|
For instance, \"/trash\". Instead of a string, may also be a
|
||||||
function that takes a message (a msg plist, see
|
function that takes a message (a msg plist, see
|
||||||
`mu4e-message-field'), and returns a folder. When using
|
`mu4e-message-field'), and returns a folder. When using
|
||||||
|
|
Loading…
Reference in New Issue