GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → rougier → Mu4e Dashboard

rougier / Mu4e Dashboard

Licence: gpl-3.0
A dashboard for mu4e (mu for emacs)

Labels

emacsmailorg-mode

Projects that are alternatives of or similar to Mu4e Dashboard

Org Msg
OrgMsg is a GNU/Emacs global minor mode mixing up Org mode and Message mode to compose and reply to emails in a Outlook HTML friendly style.
Stars: ✭ 153 (-40.93%)
Mutual labels:  mail, emacs, org-mode
Orgro
An org-mode file viewer for iOS and Android
Stars: ✭ 175 (-32.43%)
Mutual labels:  emacs, org-mode
Org Pdftools
A custom org link type for pdf-tools
Stars: ✭ 165 (-36.29%)
Mutual labels:  emacs, org-mode
Toc Org
toc-org is an Emacs utility to have an up-to-date table of contents in the org files without exporting (useful primarily for readme files on GitHub)
Stars: ✭ 202 (-22.01%)
Mutual labels:  emacs, org-mode
Org Fragtog
Automatically toggle Org mode LaTeX fragment previews as the cursor enters and exits them
Stars: ✭ 149 (-42.47%)
Mutual labels:  emacs, org-mode
Writingwithemacs
Tips, Examples, and Resources for Writing with Emacs
Stars: ✭ 150 (-42.08%)
Mutual labels:  emacs, org-mode
Org Books
Reading list management with org mode
Stars: ✭ 186 (-28.19%)
Mutual labels:  emacs, org-mode
Cheatsheet
Pretty cheat sheets, or ``reference cards'', obtainable from Org files.
Stars: ✭ 116 (-55.21%)
Mutual labels:  emacs, org-mode
Doct
DOCT: Declarative Org Capture Templates for Emacs
Stars: ✭ 210 (-18.92%)
Mutual labels:  emacs, org-mode
Emacs Easy Hugo
Emacs major mode for managing hugo
Stars: ✭ 235 (-9.27%)
Mutual labels:  emacs, org-mode
Evil Org Mode
Supplemental evil-mode keybindings to emacs org-mode
Stars: ✭ 241 (-6.95%)
Mutual labels:  emacs, org-mode
Org Graph View
View Org buffers as a clickable, graphical mind-map
Stars: ✭ 141 (-45.56%)
Mutual labels:  emacs, org-mode
Novels.org
Novels.org - Your Novels in Plain Text (Emacs . org-mode)
Stars: ✭ 120 (-53.67%)
Mutual labels:  emacs, org-mode
Hexo Renderer Org
Hexo renderer plugin for emacs org-mode
Stars: ✭ 157 (-39.38%)
Mutual labels:  emacs, org-mode
Walkman
Write HTTP requests in Org mode and replay them at will using cURL
Stars: ✭ 120 (-53.67%)
Mutual labels:  emacs, org-mode
Go Org
Org mode parser with html & pretty printed org rendering. also shitty static site generator.
Stars: ✭ 177 (-31.66%)
Mutual labels:  emacs, org-mode
Org Brain
Org-mode wiki + concept-mapping
Stars: ✭ 1,512 (+483.78%)
Mutual labels:  emacs, org-mode
Emacs Gtd
Get Things Done with Emacs
Stars: ✭ 111 (-57.14%)
Mutual labels:  emacs, org-mode
Verb
Organize and send HTTP requests from Emacs
Stars: ✭ 205 (-20.85%)
Mutual labels:  emacs, org-mode
Ob Async
Asynchronous src_block execution for org-babel
Stars: ✭ 249 (-3.86%)
Mutual labels:  emacs, org-mode
View All Similar Projects ➔

mu4e Dashboard

mu4e dashboard provides a new =mu4e= org link type that allows to execute various mu4e queries when clicked. Such links can be organised into a dashboard, by simply writing an org file as shown below:

Screenshot 1: Full page dashboard

[[./dashboard.png]]

Screenshot 2: Side dashboard

[[./dashboard-2.png]]

** Installation

Evaluate the buffer and you're good to go. It is your responsibility to write an org file with links pointing to varius queries on your mailboxes.

** Configuration

*** Links

The link syntax is quite intuitive:

#+begin_src org [[mu4e:query|format|count][description]] #+end_src

=query= must be a valid mu4e query and =count= (optional) is the maximum number of results to be returned. When the link is clicked, =mu4e-headers-search= is called with the proper query.

#+begin_src org [[mu4e:flag:unread][All unread]] [[mu4e:flag:unread||10][Last 10 unread]] #+end_src

=format= can be used to specify that =query= results are to be counted in order to update the descritption using the given format:

#+begin_src org [[mu4e:flag:unread|%3d][---]] #+end_src

With the example above, when the link is cliked, the =---= part will be replaced by the number of unread mails.

*** Key bindings

Keybindings can be configured using the =KEYMAP= keyword in your org file:

#+begin_src org #+KEYMAP: key | elisp function #+end_src

For example, if you want to bind =;= to context switch, you would write:

#+begin_src org #+KEYMAP: ; | mu4e-context-switch #+end_src

*** Query test

In the provided [[dashboard.org]], there's a definition for a mu query that can be called directly inside the org file using [[https://orgmode.org/worg/org-contrib/babel/][org-babel]]. This can be convenient if you want to test a query before creating a link. Usage is quite simple:

#+begin_src org #+CALL: query(flag:unread, 10) #+RESULTS: #+end_src

Just type C-c C-c on the call line and you should see query results under the RESULTS line.

** Usage

To activate the dashboard, type =mu4e-dashboard-mode=. This will turn on =mu4e-dashboard-mode= minor mode and install any custom keybindings in the current buffer.

To edit the org file, you'll need to turn off =mu4e-dashboard-mode=.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].