├── .gitignore ├── LICENSE.txt ├── Makefile ├── README.org ├── dashboard-2.png ├── dashboard.org ├── dashboard.png ├── mu4e-dashboard.el ├── side-dashboard.org └── test ├── .gitignore ├── mock-mu-cli ├── regression-tests.el └── trivial-dash.org /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .POSIX: 2 | 3 | EMACS = emacs 4 | EVAL := $(EMACS) --eval 5 | MU4E = /opt/homebrew/share/emacs/site-lisp/mu/mu4e 6 | ELISP = mu4e-dashboard.el 7 | 8 | PKGDIR := . 9 | 10 | # Additional emacs loadpath 11 | LOADPATH := -L $(PKGDIR) 12 | 13 | # Prefer emacs config folder in XDG_CONFIG_HOME to ~/.emacs.d 14 | # Assume emacs-user-directory is ~/.emacs.d 15 | # Try to find ELPA directory or STRAIGHT directory. 16 | XDG_ELPA_DIR := $(if $(XDG_CONFIG_HOME), $(XDG_CONFIG_HOME)/emacs/elpa, $(HOME)/.config/emacs/elpa) 17 | ELPA_DIR := $(if $(shell test -d $(XDG_ELPA_DIR)), $(XDG_ELPA_DIR), $(HOME)/.emacs.d/elpa) 18 | 19 | XDG_STRAIGHT_DIR := $(if $(XDG_CONFIG_HOME), $(XDG_CONFIG_HOME)/emacs/straight/build, $(HOME)/.config/emacs/straight/build) 20 | STRAIGHT_DIR := $(if $(shell test -d $(XDG_STRAIGHT_DIR)), $(XDG_STRAIGHT_DIR), $(HOME)/.emacs.d/straight/build) 21 | 22 | ASYNC_ELPA_DIR = $(shell \ 23 | test -d $(ELPA_DIR) && \ 24 | find -L $(ELPA_DIR) -maxdepth 1 -regex '.*/async-[.0-9]*' 2> /dev/null | \ 25 | sort | tail -n 1) 26 | ifneq "$(ASYNC_ELPA_DIR)" "" 27 | LOADPATH += -L $(ASYNC_ELPA_DIR) 28 | endif 29 | 30 | ASYNC_STRAIGHT_DIR = $(shell \ 31 | test -d $(STRAIGHT_DIR) && \ 32 | find -L $(STRAIGHT_DIR) -maxdepth 1 -regex '.*/async' 2> /dev/null | \ 33 | sort | tail -n 1) 34 | ifneq "$(ASYNC_STRAIGHT_DIR)" "" 35 | LOADPATH += -L $(ASYNC_STRAIGHT_DIR) 36 | endif 37 | 38 | all: lints $(ELISP:.el=.elc) 39 | 40 | lints: checkdoc 41 | 42 | checkdoc: 43 | for f in $(ELISP); do $(EMACS) -batch -Q --eval "(checkdoc-file \"$$f\")"; done 44 | 45 | check: all 46 | srcdir=$(PWD) $(EMACS) -batch -Q $(LOADPATH) -L $(MU4E) -l test/regression-tests.el -f ert-run-tests-batch 47 | 48 | clean: 49 | rm -f $(ELISP:.el=.elc) 50 | 51 | .SUFFIXES: .el .elc 52 | 53 | .el.elc: 54 | $(EMACS) -batch -Q $(LOADPATH) -L . -L $(MU4E) -f batch-byte-compile $< 55 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | 2 | *mu4e Dashboard* 3 | 4 | mu4e dashboard provides a new =mu4e= org link type that allows to execute 5 | various mu4e queries when clicked. Such links can be organised into a 6 | dashboard, by simply writing an org file as shown below: 7 | 8 | *Screenshot 1*: Full page dashboard 9 | 10 | [[./dashboard.png]] 11 | 12 | *Screenshot 2*: Side dashboard 13 | 14 | [[./dashboard-2.png]] 15 | 16 | ** Installation 17 | 18 | Evaluate the buffer and you're good to go. It is your responsibility to 19 | write an org file with links pointing to varius queries on your mailboxes. 20 | 21 | ** Configuration 22 | 23 | *** Links 24 | 25 | The link syntax is quite intuitive: 26 | 27 | #+begin_src org 28 | [[mu:query|format|count][description]] 29 | #+end_src 30 | 31 | =query= must be a valid mu4e query and =count= (optional) is the maximum 32 | number of results to be returned. When the link is clicked, 33 | =mu4e-headers-search= is called with the proper query. 34 | 35 | #+begin_src org 36 | [[mu:flag:unread][All unread]] 37 | [[mu:flag:unread||10][Last 10 unread]] 38 | #+end_src 39 | 40 | =format= can be used to specify that =query= results are to be counted in 41 | order to update the description using the given format: 42 | 43 | #+begin_src org 44 | [[mu:flag:unread|%3d][---]] 45 | #+end_src 46 | 47 | With the example above, when the link is cliked, the =---= part will be 48 | replaced by the number of unread mails. 49 | 50 | *** Using mu4e-bookmarks 51 | 52 | Queries can include references to mu4e-bookmarks. A bookmark is denoted with 53 | ~bm:~ 54 | 55 | ~bookmarkName~ cannot contain spaces nor ]. A query can contain several bookmarks, 56 | but their expansion is not recursive. 57 | 58 | For example, assuming the following bookmark exists: 59 | 60 | #+begin_src emacs-lisp :exports both 61 | (add-to-list 'mu4e-bookmarks 62 | '(:name "Unread" 63 | :query "flag:unread and not flag:trashed" 64 | :key ?f) 65 | t) 66 | #+end_src 67 | 68 | the dashboard query: 69 | 70 | #+begin_src emacs-lisp :exports both 71 | mu:bm:Unread and date:7d..now 72 | #+end_src 73 | 74 | will be expanded to: 75 | 76 | #+begin_src emacs-lisp :exports both 77 | mu:(flag:unread and not flag:trashed) and date:7d..now 78 | #+end_src 79 | 80 | Note that parenthesis are added around the bookmark to make sure the expansion is hygienic. 81 | 82 | *** Key bindings 83 | 84 | Keybindings can be configured using the =KEYMAP= keyword in your org file: 85 | 86 | #+begin_src org 87 | #+KEYMAP: key | elisp function 88 | #+end_src 89 | 90 | For example, if you want to bind =;= to context switch, you would write: 91 | 92 | #+begin_src org 93 | #+KEYMAP: ; | mu4e-context-switch 94 | #+end_src 95 | 96 | *** Query test 97 | 98 | In the provided [[dashboard.org]], there's a definition for a mu query that can be 99 | called directly inside the org file using [[https://orgmode.org/worg/org-contrib/babel/][org-babel]]. This can be convenient if 100 | you want to test a query before creating a link. Usage is quite simple: 101 | 102 | #+begin_src org 103 | #+CALL: query(flag:unread, 10) 104 | #+RESULTS: 105 | #+end_src 106 | 107 | Just type *C-c C-c* on the call line and you should see query results under the 108 | RESULTS line. 109 | 110 | ** Usage 111 | 112 | To activate the dashboard, type =mu4e-dashboard-mode=. This will turn on 113 | =mu4e-dashboard-mode= minor mode and install any custom keybindings in 114 | the current buffer. 115 | 116 | To edit the org file, you'll need to turn off =mu4e-dashboard-mode=. 117 | 118 | 119 | 120 | ** Related 121 | 122 | There is a fork of this software which is designed to be used with 123 | [[https://notmuchmail.org/][notmuch]] instead of with mu4e. It replaces the standard =notmuch-hello= 124 | dashboard with an org-mode version. You can find it [[https://git.sr.ht/~inwit/org-notmuch-hello][here]]. 125 | -------------------------------------------------------------------------------- /dashboard-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rougier/mu4e-dashboard/c9c09b7ed6433070de148b656ac273b7fb7cec07/dashboard-2.png -------------------------------------------------------------------------------- /dashboard.org: -------------------------------------------------------------------------------- 1 | 2 | * Mu for Emacs (mu4e) *[[mu:flag:unread|%3d Unread][ 17 Unread]]* 3 | 4 | [[mu:flag:unread][Unread]] /[[mu:flag:unread|(%3d)][( 17)]]/ .... [u] [[mu:date:today..now][Today]] /[[mu:date:today..now|(%3d)][(113)]]/ .......... [t] *Compose* ...... [C] 5 | [[mu:m:/inria/inbox or m:/gmail/inbox or m:/univ/inbox][Inbox]] /[[mu:m:/inria/inbox or m:/gmail/inbox or m:/univ/inbox|(%3d)][( 33)]]/ .... [i] [[mu:date:2d..today and not date:today..now][Yesterday]] /[[mu:date:2d..today and not date:today..now|(%3d)][(242)]]/ ...... [y] *Update* ....... [U] 6 | [[mu:m:/inria/drafts or m:/gmail/drafts or m:/univ/drafts][Drafts]] /[[mu:m:/inria/drafts or m:/gmail/drafts or m:/univ/drafts|(%3d)][( 2)]]/ .... [d] [[mu:date:7d..now][Last week]] /[[mu:date:7d..now|(%4d)][( 989)]]/ ..... [w] *Switch context* [;] 7 | [[mu:m:/inria/sent or m:/gmail/sent or m:/univ/sent][Sent]] /[[mu:m:/inria/sent or m:/gmail/sent or m:/univ/sent|(%5d)][( 7082)]]/ .... [s] [[mu:date:4w..now][Last month]] /[[mu:date:4w..|(%4d)][(3606)]]/ .... [m] *Quit* ......... [q] 8 | 9 | * Queries 10 | 11 | Type *C-c C-c* on the /CALL/ line below to evaluate your query. 12 | *NOTE*: dashboard needs to be deactivated first 13 | 14 | #+CALL: query("flag:unread", 5) 15 | #+RESULTS: 16 | 17 | * Saved searches 18 | 19 | [[mu:m:/inria/archive or m:/gmail/archive or m:/univ/archive][Archive]] /[[mu:m:/inria/archive or m:/gmail/archive or m:/univ/archive|(%6d)][( 44132)]]/ ...... [[mu:m:/inria/archive or m:/gmail/archive or m:/univ/archive||100][100]] - [[mu:m:/inria/archive or m:/gmail/archive or m:/univ/archive||500][500]] [[mu:flag:attach][ Attachments]] /[[mu:flag:attach|(%5d)][( 9954)]]/ ... [[mu:flag:attach||99999][all]] - [[mu:size:10M..][big]] 20 | [[mu:flag:flagged][Important]] /[[mu:flag:flagged|(%4d)][( 278)]]/ ...... [[mu:flag:flagged||100][100]] - [[mu:flag:flagged||500][500]] [[mu:flag:encrypted][Encrypted]] /[[mu:flag:encrypted|(%4d)][( 888)]]/ ...... [[mu:flag:encrypted||100][100]] - [[mu:flag:encrypted||500][500]] 21 | 22 | ** People 23 | 24 | [[mu:from:rms@gnu.org][Richard Stallman]] /[[mu:from:rms@gnu.org|(%3d)][(508)]]/ ............................ [[mu:mu:from:rms@gnu.org||100][100]] - [[mu:from:rms@gnu.org||500][500]] - [[mu:from:rms@gnu.org||9999][all]] 25 | [[mu:from:djcb@djcbsoftware.nl][Dirk-Jan C. Binnema]] /[[mu:from:djcb@djcbsoftware.nl|(%2d)][(50)]]/ .......................... [[mu:from:djcb@djcbsoftware.nl||100][100]] - [[mu:from:djcb@djcbsoftware.nl||500][500]] - [[mu:from:djcb@djcbsoftware.nl||9999][all]] 26 | 27 | ** Date 28 | 29 | [[mu:date:20200101..20201231][Year 2020]] /[[mu:date:20200101..20201231|(%5d)][(28340)]]/ [[mu:date:20190101..20191231][ Year 2019]] /[[mu:date:20190101..20191231|(%5d)][(19845)]]/ [[mu:date:20180101..20181231][ Year 2018]] /[[mu:date:20180101..20181231|(%5d)][( 3038)]]/ 30 | 31 | ** Mailing lists 32 | 33 | [[mu:list:emacs-devel.gnu.org 34 | ][Emacs development]] /[[mu:list:emacs-devel.gnu.org|(%4d)][(3208)]]/ .......................... [[mu:list:emacs-devel.gnu.org||100][100]] - [[mu:list:emacs-devel.gnu.org||500][500]] - [[mu:list:emacs-devel.gnu.org||9999][all]] 35 | [[mu:list:mu-discuss.googlegroups.com][Mu4e discussions]] /[[mu:list:mu-discuss.googlegroups.com|(%4d)][( 267)]]/ ........................... [[mu:list:mu-discuss.googlegroups.com||100][100]] - [[mu:list:mu-discuss.googlegroups.com||500][500]] - [[mu:list:mu-discuss.googlegroups.com||9999][all]] 36 | 37 | * Information 38 | 39 | *Database* : ~/.cache/mu/xapian 40 | *Maildir* : ~/Documents/Mail-isync 41 | *Addresses* : [[mailto:nicolas.rougier@inria.fr][]] /(inria)/ 42 | [[mailto:nicolas.rougier@gmail.com][]] /(gmail)/ 43 | [[mailto:nicolas.rougier@u-bordeaux.fr][]] /(univ)/ 44 | 45 | * Configuration 46 | :PROPERTIES: 47 | :VISIBILITY: hideall 48 | :END: 49 | 50 | #+STARTUP: showall showstars indent 51 | 52 | #+NAME: query 53 | #+BEGIN_SRC sh :results list raw :var query="flag:unread" count=5 54 | export LANG="en_US.UTF-8"; export LC_ALL="en_US.UTF-8"; 55 | mu find -n $count --sortfield=date --reverse --fields "f s" $query 56 | #+END_SRC 57 | 58 | #+KEYMAP: u | mu4e-headers-search "flag:unread" 59 | #+KEYMAP: i | mu4e-headers-search "m:/inria/inbox or m:/gmail/inbox or m:/univ/inbox" 60 | #+KEYMAP: d | mu4e-headers-search "m:/inria/drafts or m:/gmail/drafts or m:/univ/drafts" 61 | #+KEYMAP: s | mu4e-headers-search "m:/inria/sent or m:/gmail/sent or m:/univ/sent" 62 | 63 | #+KEYMAP: t | mu4e-headers-search "date:today..now" 64 | #+KEYMAP: y | mu4e-headers-search "date:2d..today and not date:today..now" 65 | #+KEYMAP: w | mu4e-headers-search "date:7d..now" 66 | #+KEYMAP: m | mu4e-headers-search "date:4w..now" 67 | 68 | #+KEYMAP: C | mu4e-compose-new 69 | #+KEYMAP: U | mu4e-dashboard-update 70 | #+KEYMAP: ; | mu4e-context-switch 71 | #+KEYMAP: q | kill-current-buffer 72 | 73 | -------------------------------------------------------------------------------- /dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rougier/mu4e-dashboard/c9c09b7ed6433070de148b656ac273b7fb7cec07/dashboard.png -------------------------------------------------------------------------------- /mu4e-dashboard.el: -------------------------------------------------------------------------------- 1 | ;;; mu4e-dashboard.el --- Dashboards for mu4e -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2020-2024 Nicolas P. Rougier 4 | 5 | ;; Author: Nicolas P. Rougier 6 | ;; Homepage: https://github.com/rougier/mu4e-dashboard 7 | ;; Keywords: convenience 8 | ;; Version: 0.2 9 | 10 | ;; Package-Requires: ((emacs "27.1") (mu4e) (async) (org)) 11 | 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This file is free software; you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation; either version 3, or (at your option) 17 | ;; any later version. 18 | 19 | ;; This file is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; For a full copy of the GNU General Public License 25 | ;; see . 26 | 27 | ;;; Commentary: 28 | ;; 29 | ;; mu4e-dashboard provides enhanced org-mode links that allow you to 30 | ;; define custom dashboards that link back to the mu4e email client. 31 | ;; 32 | ;; 33 | ;;; NEWS: 34 | ;; 35 | ;; 36 | ;; Version 0.2 37 | ;; - Handle async requests with the async library 38 | ;; - Fix package warnings 39 | ;; - Added support for mu4e bookmarks 40 | ;; - Key bindings from mu4e can be used 41 | 42 | ;; Version 0.1 43 | ;; - initial release 44 | 45 | ;;; Code: 46 | (require 'subr-x) 47 | (require 'ob-shell) 48 | (require 'org) 49 | (require 'org-element) 50 | (require 'async) 51 | (require 'mu4e-headers) 52 | (require 'mu4e-search) 53 | 54 | 55 | (defconst mu4e-dashboard-version "0.1.1") 56 | 57 | ;; Install the mu4e link type 58 | (defgroup mu4e-dashboard nil 59 | "Provides a new Org mode link type for mu4e queries." 60 | :group 'comm) 61 | 62 | (defcustom mu4e-dashboard-file "~/.emacs.d/mu4e-dashboard.org" 63 | "Path to the dashboard org file." 64 | :type 'string) 65 | 66 | (defcustom mu4e-dashboard-link-name "mu" 67 | "Default link name." 68 | :type 'string) 69 | 70 | (defcustom mu4e-dashboard-mu-program "mu" 71 | "Default name of the mu command." 72 | :type 'string) 73 | 74 | (defcustom mu4e-dashboard-lighter " mu4ed" 75 | "Minor mode lighter indicating that this mode is active." 76 | :type 'string) 77 | 78 | (defcustom mu4e-dashboard-propagate-keymap t 79 | "Propagate dashboard defined keymap to mu4e header view." 80 | :type 'boolean) 81 | 82 | (org-link-set-parameters 83 | mu4e-dashboard-link-name 84 | :follow #'mu4e-dashboard-follow-mu4e-link) 85 | 86 | (defvar mu4e-dashboard--prev-local-keymap nil 87 | "Buffer-local variable to save the prior keymap.") 88 | 89 | (make-variable-buffer-local 'mu4e-dashboard--prev-local-keymap) 90 | 91 | (defvar mu4e-dashboard--async-update-in-progress nil 92 | "Set tot if an async update is in progress. 93 | 94 | This is a buffer-local variable that will be t if the current 95 | buffer is in the process of being updated asynchronously.") 96 | 97 | (make-variable-buffer-local 'mu4e-dashboard--async-update-in-progress) 98 | 99 | ;;;###autoload 100 | (define-minor-mode mu4e-dashboard-mode 101 | "Minor mode for \"live\" mu4e dashboards." 102 | :lighter mu4e-dashboard-lighter 103 | :init-value nil 104 | (if mu4e-dashboard-mode 105 | (progn 106 | (setq buffer-read-only t) 107 | ;; Make a copy of the current local keymap (this will, in 108 | ;; general, have been setup by org-mode, but I don't want to 109 | ;; assume that) 110 | (setq mu4e-dashboard--prev-local-keymap (current-local-map)) 111 | (use-local-map (make-composed-keymap (mu4e-dashboard-parse-keymap) (current-local-map))) 112 | ;; If buffer corresponds to the dashboard, add a special key 113 | ;; (buffer-name is harcoded). Dashboard should be open with a 114 | ;; special function naming a defcustom buffer name and then 115 | ;; install the minor mode. install the keymap as local with 116 | ;; current map as parent (this might generate some problem?) 117 | (if (string= (buffer-file-name) (expand-file-name mu4e-dashboard-file)) 118 | (local-set-key (kbd "") #'org-open-at-point)) 119 | (add-hook 'mu4e-index-updated-hook #'mu4e-dashboard-update) 120 | (if mu4e-dashboard-propagate-keymap 121 | ;; install minor mode to mu4e headers view when called 122 | ;; (should it be to message hook too?) 123 | (add-hook 'mu4e-headers-found-hook #'mu4e-dashboard-mode)) 124 | (mu4e-dashboard-update)) 125 | (if mu4e-dashboard--async-update-in-progress 126 | (user-error "Update in progress; try again when it is complete")) 127 | (remove-hook 'mu4e-index-updated-hook #'mu4e-dashboard-update) 128 | ;; clear hook when dashboard disable 129 | (remove-hook 'mu4e-headers-found-hook #'mu4e-dashboard-mode) 130 | (use-local-map mu4e-dashboard--prev-local-keymap) 131 | (setq buffer-read-only nil))) 132 | 133 | (defun mu4e-dashboard () 134 | "Open the dashboard (usin mu4e-dashboard-file)." 135 | (interactive) 136 | (if (file-exists-p mu4e-dashboard-file) 137 | (progn 138 | (find-file mu4e-dashboard-file) 139 | (mu4e-dashboard-mode)) 140 | (message (concat mu4e-dashboard-file " does not exist")) 141 | )) 142 | 143 | (defun mu4e-dashboard-compare-bookmark-name (bookmark field-name st) 144 | "Compare ST to the field FIELD-NAME in the BOOKMARK." 145 | (equal (plist-get bookmark field-name) st)) 146 | 147 | (defun mu4e-dashboard-find-bookmark (name) 148 | "Convert a mu4e bookmark NAME to a query." 149 | (if name 150 | (cl-find-if (lambda (a) (mu4e-dashboard-compare-bookmark-name a :name name )) 151 | mu4e-bookmarks))) 152 | 153 | (defun mu4e-dashboard-translate-bookmark-to-query (bm) 154 | "Translates a BM: into a mu4e query." 155 | (let ( ;; remove "bm:" from the begining of the name 156 | (bookmark (mu4e-dashboard-find-bookmark (substring bm 3))) 157 | ) 158 | (if bookmark 159 | ;; put parenthesis around to make it hygenic 160 | (concat "("(plist-get bookmark :query) ")") 161 | (progn 162 | (message (concat "bookmark not found: " bm)) 163 | bm)))) 164 | 165 | (defun mu4e-dashboard-expand-bookmarks-in-query (st) 166 | "Replace ST by the corresponding query if ST contain a bookmark." 167 | (let ((bookmark-re "\\(bm:[^ ]+\\)") 168 | ) 169 | (replace-regexp-in-string bookmark-re 'mu4e-dashboard-translate-bookmark-to-query st) 170 | )) 171 | 172 | (defun mu4e-dashboard-follow-mu4e-link (path) 173 | "Process a mu4e link with path PATH. 174 | 175 | PATH shall be of the form [[mu4e:query|fmt|limit][(---------)]]. 176 | If FMT is not specified or is nil, clicking on the link calls 177 | mu4e with the specified QUERY (with or without the given 178 | LIMIT). If FMT is specified, the description of the link is 179 | updated with the QUERY count formatted using the provided 180 | format (for example \"%4d\")." 181 | 182 | (let* ((link (org-element-context)) 183 | (queryname (string-trim (nth 0 (split-string path "[]|]")))) 184 | (query (mu4e-dashboard-expand-bookmarks-in-query queryname)) 185 | (fmt (nth 1 (split-string path "[]|]"))) 186 | (count (nth 2 (split-string path "[]|]")))) 187 | (cond 188 | ;; Regular query without limit 189 | ((and (not fmt) (not count)) 190 | (progn 191 | (message query) 192 | (if (get-buffer-window "*mu4e-headers*" t) 193 | (switch-to-buffer"*mu4e-headers*")) 194 | (mu4e-search query))) 195 | 196 | ;; Regular query with limit 197 | ((and count (> (length count) 0)) 198 | (progn 199 | (if (get-buffer-window "*mu4e-headers*" t) 200 | (switch-to-buffer"*mu4e-headers*")) 201 | (let ((mu4e-search-results-limit (string-to-number count))) 202 | (ignore mu4e-search-results-limit) 203 | (mu4e-search query)))) 204 | 205 | ;; Query count and link description update 206 | ((and fmt (> (length fmt) 0)) 207 | (mu4e-dashboard-update-link link))))) 208 | 209 | (defun mu4e-dashboard-update-link (link) 210 | "Update content of a formatted mu4e LINK. 211 | 212 | A formatted link is a link of the form 213 | [[mu4e:query|limit|fmt][(---------)]] where fmt is a non nil 214 | string describing the format. When a link is cleared, the 215 | description is replaced by a string for the form \"(---)\" and 216 | have the same size as the current description. If the given 217 | format is too big for the current description, description is 218 | replaced with + signs." 219 | 220 | (let* ((path (org-element-property :path link)) 221 | (queryname (string-trim (nth 0 (split-string path "|")))) 222 | (query (mu4e-dashboard-expand-bookmarks-in-query queryname)) 223 | (fmt (nth 1 (split-string path "|"))) 224 | (beg (org-element-property :contents-begin link)) 225 | (end (org-element-property :contents-end link)) 226 | (size (- end beg))) 227 | (if (and fmt (> (length fmt) 0)) 228 | (let* ((command (format "%s find %s 2> /dev/null | wc -l" mu4e-dashboard-mu-program 229 | (shell-quote-argument query))) 230 | (output (string-to-number (shell-command-to-string command))) 231 | (output (format fmt output))) 232 | (let ((modified (buffer-modified-p)) 233 | (inhibit-read-only t)) 234 | (save-excursion 235 | (delete-region beg end) 236 | (goto-char beg) 237 | (insert (if (<= (length output) size) output 238 | (make-string size ?+)))) 239 | (set-buffer-modified-p modified)))))) 240 | 241 | 242 | (defun mu4e-dashboard-update-all-async () 243 | "Update content of all formatted mu4e links in an asynchronous way. 244 | 245 | A formatted link is a link of the form 246 | [[mu4e:query|limit|fmt][(---------)]] where fmt is a non nil 247 | string describing the format. When a link is cleared, the 248 | description is replaced by a string for the form \"(---)\" and 249 | have the same size as the current description." 250 | 251 | (if mu4e-dashboard--async-update-in-progress 252 | (user-error "Cannot update while an update is in progress!")) 253 | (setq mu4e-dashboard--async-update-in-progress t) 254 | (let ((buffer (current-buffer))) 255 | (org-element-map (org-element-parse-buffer) 'link 256 | (lambda (link) 257 | (when (string= (org-element-property :type link) mu4e-dashboard-link-name) 258 | (let* ((path (org-element-property :path link)) 259 | (query (string-trim (nth 0 (split-string path "|")))) 260 | (fmt (nth 1 (split-string path "|"))) 261 | (beg (org-element-property :contents-begin link)) 262 | (end (org-element-property :contents-end link)) 263 | (size (if (and beg end) (- end beg) 0))) 264 | (when (and fmt (> (length fmt) 0)) 265 | ;; The rest of this function will execute successfully with a 266 | ;; `size' of zero, but since there would be no reason to 267 | ;; proceed with no output, we signal an error. 268 | (if (eq size 0) 269 | (error "The link ``%s'' has a format clause, but no output width" path)) 270 | 271 | (async-start 272 | (lambda () 273 | (let ((command (format "mu find %s 2> /dev/null | wc -l" 274 | (shell-quote-argument query)))) 275 | (string-to-number (shell-command-to-string command)))) 276 | (lambda (count) 277 | (with-current-buffer buffer 278 | (let ((modified (buffer-modified-p)) 279 | (inhibit-read-only t) 280 | (output (if (numberp count) 281 | (format fmt count) 282 | (format fmt 0)))) 283 | (save-excursion 284 | (delete-region beg end) 285 | (goto-char beg) 286 | (insert (if (<= (length output) size) output 287 | (make-string size ?+)))) 288 | (set-buffer-modified-p modified))))))))))) 289 | (setq mu4e-dashboard--async-update-in-progress nil)) 290 | 291 | 292 | (defun mu4e-dashboard-update-all-sync () 293 | "Update content of all mu4e formatted links in a synchronous way. 294 | 295 | A formatted link is a link of the form 296 | [[mu4e:query|limit|fmt][(---------)]] where fmt is a non nil 297 | string describing the format. When a link is cleared, the 298 | description is replaced by a string for the form \"(---)\" and 299 | have the same size as the current description." 300 | 301 | (mu4e-dashboard-clear-all) 302 | (org-element-map (org-element-parse-buffer) 'link 303 | (lambda (link) 304 | (when (string= (org-element-property :type link) mu4e-dashboard-link-name) 305 | (mu4e-dashboard-update-link link) 306 | (redisplay t))))) 307 | 308 | (defun mu4e-dashboard-clear-link (link) 309 | "Clear a formatted mu4e link LINK. 310 | 311 | A formatted link is a link of the form 312 | [[mu4e:query|limit|fmt][(---------)]] where fmt is a non nil 313 | string describing the format. When a link is cleared, the 314 | description is replaced by a string for the form \"(---)\" and 315 | having the same size as the current description." 316 | 317 | (let* ((path (org-element-property :path link)) 318 | (fmt (nth 1 (split-string path "|"))) 319 | (beg (org-element-property :contents-begin link)) 320 | (end (org-element-property :contents-end link)) 321 | (size (- end beg))) 322 | (if (and fmt (> (length fmt) 0)) 323 | (let ((modified (buffer-modified-p)) 324 | (inhibit-read-only t)) 325 | (save-excursion 326 | (delete-region beg end) 327 | (goto-char beg) 328 | (insert (format "(%s)" (make-string (- size 2) ?-)))) 329 | (set-buffer-modified-p modified))))) 330 | 331 | (defun mu4e-dashboard-clear-all () 332 | "Clear all formatted mu4e links. 333 | 334 | A formatted link is a link of the form 335 | [[mu4e:query|limit|fmt][(---------)]] where fmt is a non nil 336 | string describing the format. When a link is cleared, the 337 | description is replaced by a string for the form \"(---)\" and 338 | have the same size as the current description." 339 | 340 | (org-element-map (org-element-parse-buffer) 'link 341 | (lambda (link) 342 | (when (string= (org-element-property :type link) mu4e-dashboard-link-name) 343 | (mu4e-dashboard-clear-link link)))) 344 | (redisplay t)) 345 | 346 | (defun mu4e-dashboard-update () 347 | "Update the current dashboard." 348 | (interactive) 349 | ;; (message 350 | ;; (concat "[" (propertize "mu4e dashboard" 'face 'bold) "] " 351 | ;; (format-time-string "Update (%H:%M)"))) 352 | (dolist (buffer (buffer-list (current-buffer))) 353 | (with-current-buffer buffer 354 | (when (bound-and-true-p mu4e-dashboard-mode) 355 | (if buffer-read-only 356 | (mu4e-dashboard-update-all-async) 357 | (error "Dashboard cannot be updated only in read-only mode")))))) 358 | 359 | (defun mu4e-dashboard-parse-keymap () 360 | "Parse the current buffer file for keybindings. 361 | 362 | Keybindings are defined by keywords of type KEYMAP:VALUE and 363 | install the corresponding key bindings in the mu4e-dashboard 364 | minor mode keymap. The previous keymap (if any) is erased. 365 | 366 | VALUE is composed of \"keybinding | function-call\" with 367 | keybinding begin a string describing a key sequence and a call to 368 | an existing function. For example, to have \"q\" to kill the 369 | current buffer, the syntax would be: 370 | 371 | #+KEYMAP: q | kill-current-buffer 372 | 373 | This can be placed anywhere in the org file even though I advised 374 | to group keymaps at the same place." 375 | 376 | (let ((map (make-sparse-keymap))) 377 | (org-element-map (org-element-parse-buffer) 'keyword 378 | (lambda (keyword) 379 | (when (string= (org-element-property :key keyword) "KEYMAP") 380 | (let* ((value (org-element-property :value keyword)) 381 | (key (string-trim (nth 0 (split-string value "|")))) 382 | (call (string-trim (nth 1 (split-string value "|"))))) 383 | (define-key map 384 | (kbd key) 385 | `(lambda () (interactive) ,(car (read-from-string (format "(%s)" call))))) 386 | (message "mu4e-dashboard: binding %s to %s" 387 | key 388 | (format "(lambda () (interactive) (%s))" call)))))) 389 | map)) 390 | 391 | (provide 'mu4e-dashboard) 392 | ;;; mu4e-dashboard.el ends here 393 | -------------------------------------------------------------------------------- /side-dashboard.org: -------------------------------------------------------------------------------- 1 | 2 | * Mailboxes *[[mu:flag:unread|%2d][ 4]]* 3 | 4 | /[i]/ [[mu:m:/inria/inbox or m:/gmail/inbox or m:/univ/inbox][Inbox]] /.............../ /[[mu:m:/inria/inbox or m:/gmail/inbox or m:/univ/inbox|%2d][ 4]]/ 5 | /[f]/ [[mu:flag:flagged][Important]] /........../ /[[mu:flag:flagged|%3d][281]]/ 6 | /[d]/ [[mu:m:/inria/drafts or m:/gmail/drafts or m:/univ/drafts][Drafts]] /.............../ /[[mu:m:/inria/drafts or m:/gmail/drafts or m:/univ/drafts|%1d][1]]/ 7 | /[s]/ [[mu:m:/inria/sent or m:/gmail/sent or m:/univ/sent][Sent]] /............../ /[[mu:m:/inria/sent or m:/gmail/sent or m:/univ/sent|%4d][7186]]/ 8 | /[a]/ [[mu:m:/inria/archive or m:/gmail/archive or m:/univ/archive][Archive]] /........../ /[[mu:m:/inria/archive or m:/gmail/archive or m:/univ/archive|%5d][44978]]/ 9 | 10 | * Smart mailboxes 11 | 12 | /[t]/ [[mu:date:today..now][Today]] /............../ /[[mu:date:today..now|%3d][ 19]]/ 13 | /[y]/ [[mu:date:2d..today and not date:today..now][Yesterday]] /........../ /[[mu:date:2d..today and not date:today..now|%3d][380]]/ 14 | /[w]/ [[mu:date:1w..now][Last week]] /......... /[[mu:date:7d..now|%4d][1196]]/ 15 | /[m]/ [[mu:date:4w..now][Last month]] /......../ /[[mu:date:4w..|%4d][3924]]/ 16 | 17 | [[mu:flag:attach][Attachments]] /........../ /[[mu:flag:attach|%5d][10040]]/ 18 | [[mu:flag:encrypted][Encrypted]] /............./ /[[mu:flag:encrypted|%4d][ 888]]/ 19 | 20 | ** Tags 21 | 22 | [[mu:tag:LINK][LINK]] /-/ [[mu:tag:PAPER][PAPER]] /-/ [[mu:tag:TODO][TODO]] /-/ [[mu:tag:CODE][CODE]] 23 | [[mu:tag:CV][CV]] /-/ [[mu:tag:ASPP][ASPP]] /-/ [[mu:tag:EDMI][EDMI]] 24 | 25 | ** People 26 | 27 | [[mu:from:rms@gnu.org][Richard Stallman]] /[[mu:from:rms@gnu.org|%3d][---]]/ 28 | [[mu:from:djcb@djcbsoftware.nl][Dirk-Jan C. Binnema]] /[[mu:from:djcb@djcbsoftware.nl|%2d][ --]]/ 29 | 30 | ** Mailing lists 31 | 32 | [[mu:list:emacs-devel.gnu.org][Emacs development]] /.../ /[[mu:list:emacs-devel.gnu.org|%4d][3538]]/ 33 | [[mu:list:mu-discuss.googlegroups.com][Mu4e discussions]] /...../ /[[mu:list:mu-discuss.googlegroups.com|%3d][277]]/ 34 | [[mu:list:numpy-discussion.python.org][Numpy discussion]] /..../ /[[mu:list:numpy-discussion.python.org|%4d][1065]]/ 35 | 36 | ** Date 37 | 38 | [[mu:flag:attach][Year 2020]] /........../ /[[mu:date:20200101..20201231|%5d][29260]]/ 39 | [[mu:date:20190101..20191231][Year 2019]] /........../ /[[mu:date:20190101..20191231|%5d][19845]]/ 40 | [[mu:date:20180101..20181231][Year 2018]] /.........../ /[[mu:date:20180101..20181231|%4d][3038]]/ 41 | 42 | * /Configuration/ 43 | :PROPERTIES: 44 | :VISIBILITY: hideall 45 | :END: 46 | 47 | #+STARTUP: showall showstars indent 48 | 49 | #+NAME: query 50 | #+BEGIN_SRC shell :results list raw :var query="flag:unread count=5 51 | export LANG="en_US.UTF-8"; export LC_ALL="en_US.UTF-8"; 52 | mu find --sortfield=date --reverse --fields "f s" $query | head -$count 53 | #+END_SRC 54 | 55 | #+KEYMAP: u | mu4e-headers-search "flag:unread" 56 | #+KEYMAP: i | mu4e-headers-search "m:/inria/inbox or m:/gmail/inbox or m:/univ/inbox" 57 | #+KEYMAP: d | mu4e-headers-search "m:/inria/drafts or m:/gmail/drafts or m:/univ/drafts" 58 | #+KEYMAP: s | mu4e-headers-search "m:/inria/sent or m:/gmail/sent or m:/univ/sent" 59 | #+KEYMAP: f | mu4e-headers-search "flag:flagged" 60 | 61 | #+KEYMAP: t | mu4e-headers-search "date:today..now" 62 | #+KEYMAP: y | mu4e-headers-search "date:2d..today and not date:today..now" 63 | #+KEYMAP: w | mu4e-headers-search "date:7d..now" 64 | #+KEYMAP: m | mu4e-headers-search "date:4w..now" 65 | 66 | #+KEYMAP: C | mu4e-compose-new 67 | #+KEYMAP: U | mu4e-dashboard-update 68 | #+KEYMAP: ; | mu4e-context-switch 69 | #+KEYMAP: q | mu4e-dashboard-quit 70 | #+KEYMAP: W | mu4e-headers-toggle-include-related 71 | #+KEYMAP: O | mu4e-headers-change-sorting 72 | #+KEYMAP: x | mu4e-mark-execute-all t 73 | #+KEYMAP: | org-open-at-point 74 | -------------------------------------------------------------------------------- /test/.gitignore: -------------------------------------------------------------------------------- 1 | mock.log 2 | -------------------------------------------------------------------------------- /test/mock-mu-cli: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | declare -A rsp 3 | rsp=(["flag:unread"]=17 ["date:today..now"]=113) 4 | 5 | count=${rsp[$2]:-0} 6 | echo -n `date` >> mock.log 7 | echo ": $2 => $count" >> mock.log 8 | i=0 9 | while test $i -lt $count; do 10 | echo "mock response $i"; 11 | i=$(($i+1)); 12 | done 13 | -------------------------------------------------------------------------------- /test/regression-tests.el: -------------------------------------------------------------------------------- 1 | ;;; regression-tests.el --- basic regression tests for mu4e-dashboard.el 2 | 3 | ;;; Commentary: 4 | 5 | ;; These tests will load the two sample dashboards, activate them, and 6 | ;; assure basic functionality. 7 | 8 | ;;; Code: 9 | 10 | (require 'ert) 11 | (require 'mu4e-dashboard) 12 | 13 | (setq-default 14 | mu4e-dashboard-mu-program 15 | (format "%s/test/mock-mu-cli" (getenv "srcdir"))) 16 | 17 | (ert-deftest smoke-tests () 18 | "Simple mu4e-dashboard test." 19 | (find-file (format "%s/test/trivial-dash.org" (getenv "srcdir"))) 20 | (mu4e-dashboard-mode) 21 | 22 | (while (< (buffer-chars-modified-tick) 8) 23 | (sit-for 1) 24 | (while (accept-process-output))) 25 | 26 | (should 27 | (string-equal 28 | (buffer-string) 29 | " 30 | * Mailboxes *[[mu:flag:unread|%2d][17]]* 31 | 32 | [[mu:flag:unread][Unread]] /[[mu:flag:unread|(%3d)][( 17)]]/ .... [u] [[mu:date:today..now][Today]] /[[mu:date:today..now|(%3d)][(113)]]/ .......... [t] *Compose* ...... [C] 33 | 34 | #+KEYMAP: u | mu4e-headers-search \"flag:unread\" 35 | #+KEYMAP: t | mu4e-headers-search \"date:today..now\" 36 | #+KEYMAP: C | mu4e-compose-new 37 | ")) 38 | 39 | (should 40 | (string-match-p 41 | (regexp-quote "mu4e-compose-new") 42 | (prin1-to-string (lookup-key (current-local-map) "C"))))) 43 | -------------------------------------------------------------------------------- /test/trivial-dash.org: -------------------------------------------------------------------------------- 1 | 2 | * Mailboxes *[[mu:flag:unread|%2d][--]]* 3 | 4 | [[mu:flag:unread][Unread]] /[[mu:flag:unread|(%3d)][(---)]]/ .... [u] [[mu:date:today..now][Today]] /[[mu:date:today..now|(%3d)][(---)]]/ .......... [t] *Compose* ...... [C] 5 | 6 | #+KEYMAP: u | mu4e-headers-search "flag:unread" 7 | #+KEYMAP: t | mu4e-headers-search "date:today..now" 8 | #+KEYMAP: C | mu4e-compose-new 9 | --------------------------------------------------------------------------------