alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

mu4e-get-mail-command: improve documentation

Browse Source 
Make a bit clearer and add an example of using a function.
This commit is contained in:
Dirk-Jan C. Binnema
2025-12-22 15:01:51 +02:00
committed by Seth Ladygo
parent c6f9257bd9
commit e24c2c2826
2 changed files with 36 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
mu4e/mu4e-update.el
View File

@ -36,13 +36,14 @@
"Shell command for retrieving new mail or a function. "Shell command for retrieving new mail or a function.
Common values are \"offlineimap\", \"fetchmail\" or \"mbsync\", but Common values are \"offlineimap\", \"fetchmail\" or \"mbsync\", but
arbitrary shell-commands can be used. If it is a function, it should arbitrary shell commands can be used. If it is a function, it should
return a string specifying the same. return a string specifying a shell command.
When set to the literal string \"true\" (the default), the The default is the string \"true\", which refers to the
command simply finishes successfully (running the \"true\" `man:true(1)' shell command, which does nothing but return
command) without retrieving any mail. This can be useful when success. This default is all you need if mail is already
mail is already retrieved in another way, such as a local MDA." retrieved in some other way outside mu4e, such as through a local
MDA, but otherwise you need to customize it as described."
:type '(choice :type '(choice
(string :tag "Shell command") (string :tag "Shell command")
(function :tag "Function that returns a string (shell command)")) (function :tag "Function that returns a string (shell command)"))

33
mu4e/mu4e.texi
View File

@ -571,12 +571,37 @@ indicate `no mail'; we can handle that with:
A similar approach can be used with other mail retrieval programs, A similar approach can be used with other mail retrieval programs,
although not all of them have their exit codes documented. although not all of them have their exit codes documented.
@subsection Conditional mail retrieval
The value of @code{mu4e-get-mail-command} can also be a @emph{function} that
returns a shell command. This allows for more sophistication. For
instance, you may want to attempt to retrieve mail only when online.
Let us look at an example.
On many GNU/Linux systems the online-status an be checked using @emph{Network
Manager}'s @command{nm-online}, which returns non-zero when you are online.
Thus, we could use something like:
@lisp
(setq mu4e-get-mail-command
(lambda ()
(if (zerop (shell-command "nm-online -q"))
"mbsync -a"
"true")))
@end lisp
Of course, the can be customized to the particulars of your system.
@subsection Implicit mail retrieval @subsection Implicit mail retrieval
If you don't have a specific command for getting mail, for example Not everyone needs to run a shell command for getting mail. For example, you may
because you are running your own mail-server, you can leave be running your own mail-server, or you already have some other way to
@code{mu4e-get-mail-command} at @t{"true"} (the default), in which case periodically retrieve messages.
@code{mu4e} won't try to get new mail, but still re-index your messages.
In that case, you can leave @code{mu4e-get-mail-command} at @t{"true"} (the
default), in which case @code{mu4e} does not attempt to retrieve new mail, but
still re-indexes your messages as per @code{mu4e-update-interval}.
@subsection Speeding up indexing @subsection Speeding up indexing
@anchor{Speeding up indexing} @anchor{Speeding up indexing}