1MU-SERVER(1)                General Commands Manual               MU-SERVER(1)
2
3
4

NAME

6       mu server - the mu backend for the mu4e e-mail client
7
8

SYNOPSIS

10       mu server [options]
11
12

DESCRIPTION

14       mu  server  starts a simple shell in which one can query and manipulate
15       the mu database. The output uses s-expressions. mu server is not  meant
16       for  use  by  humans,  except  for  debugging  purposes. Instead, it is
17       designed specifically for the mu4e e-mail client.
18
19       In this man-page, we document the commands mu server accepts,  as  well
20       as  their responses. In general, the commands sent to the server are s-
21       expressions of the form:
22
23          (<command-name> :param1 value1 :param2 value2)
24
25       For example, to view a certain message, the command would be:
26
27          (view :docid 12345)
28
29       Parameters can be sent in any order; they must be of the  correct  type
30       though.    See   lib/utils/mu-sexp-parser.hh   and   lib/utils/mu-sexp-
31       parser.cc in source-tree for the details.
32
33
34

OUTPUT FORMAT

36       mu server accepts a number of commands, and delivers its results in the
37       form:
38
39          \376<length>\377<s-expr>
40
41       \376  (one  byte  0xfe),  followed  by  the  length of the s-expression
42       expressed as an hexadecimal number, followed by another \377 (one  byte
43       0xff), followed by the actual s-expression.
44
45       By  prefixing  the expression with its length, it can be processed more
46       efficiently. The \376 and \377 were chosen since they  never  occur  in
47       valid UTF-8 (in which the s-expressions are encoded).
48
49
50
51

AUTHOR

53       Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
54
55

SEE ALSO

57       mu(1)
58
59
60
61User Manuals                     January 2020                     MU-SERVER(1)