├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── .gitignore ├── COPYING ├── Makefile ├── README.md ├── api.go ├── bundle.go ├── cmd └── pinbox-server │ └── main.go ├── config.go ├── config_test.go ├── example └── config.toml ├── label.go ├── mailbox.go ├── message.go ├── notmuch.go ├── swagger.yaml └── thread.go /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. 16 | 2. 17 | 3. 18 | 19 | **Expected behavior** 20 | A clear and concise description of what you expected to happen. 21 | 22 | **Desktop (please complete the following information):** 23 | - OS: [e.g. Ubuntu 18.04] 24 | - Notmuch version (notmuch --version): [e.g. notmuch 0.26] 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Config files 2 | *.toml 3 | 4 | # Certificates 5 | *.crt 6 | *.key 7 | 8 | # Binaries for programs and plugins 9 | *.exe 10 | *.exe~ 11 | *.dll 12 | *.so 13 | *.dylib 14 | pinbox-server 15 | 16 | # Test binary, build with `go test -c` 17 | *.test 18 | 19 | # Output of the go coverage tool, specifically when used with LiteIDE 20 | *.out 21 | 22 | # IntelliJ Goland files 23 | .idea 24 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | # Copyright 2019 Martin Pritchard 2 | # 3 | # This file is part of Pinbox. 4 | # 5 | # Pinbox is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # Pinbox is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with Pinbox. If not, see . 17 | 18 | BINARY=pinbox-server 19 | 20 | .PHONY: build clean test 21 | 22 | $(BINARY): build test 23 | 24 | build: 25 | go get -d ./... 26 | go build -o $(BINARY) cmd/pinbox-server/main.go 27 | 28 | clean: 29 | rm -f $(BINARY) 30 | 31 | test: 32 | go test -v -race -cover 33 | 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | *ARCHIVING THIS REPOISTORY. THIS PROJECT HAS BEEN MERGED WITH THE FRONTEND. SEE: https://github.com/msp301/pinbox* 2 | 3 | # Pinbox webmail backend 4 | 5 | Pinbox is a self-hosted webmail client greatly inspired by Google Inbox. 6 | 7 | *Warning: Currently under development* 8 | 9 | ## Prerequsites 10 | 11 | * Go (https://golang.org/) 12 | * notmuch (https://notmuchmail.org/) 13 | 14 | ## Configuration 15 | 16 | Pinbox server requires a [TOML](https://github.com/toml-lang/toml) configuration file to define the Maildir location, port etc. See [example/config.toml](https://github.com/msp301/pinbox-server/blob/master/example/config.toml). 17 | 18 | ## Starting the server 19 | 20 | make && ./pinbox-server config.toml` 21 | 22 | ## Architecture 23 | 24 | Client App -> Backend API -> Notmuch -> OfflineIMAP 25 | 26 | ## License 27 | 28 | Licensed under GPL-3.0-or-later 29 | -------------------------------------------------------------------------------- /api.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | import ( 21 | "encoding/json" 22 | "log" 23 | "net/http" 24 | "net/url" 25 | "reflect" 26 | 27 | "github.com/gorilla/mux" 28 | ) 29 | 30 | // MailboxAPI contains logic for handling mailbox http requests 31 | type MailboxAPI struct { 32 | mailbox Mailbox 33 | config Config 34 | } 35 | 36 | // CreateMailboxAPI creates a new Mailbox API instance. 37 | // Return a new MailboxAPI reference. 38 | func CreateMailboxAPI(mailbox Mailbox, config Config) *MailboxAPI { 39 | return &MailboxAPI{ 40 | mailbox: mailbox, 41 | config: config, 42 | } 43 | } 44 | 45 | // GetInbox retrieves all inbox messages in the Mailbox. 46 | func (m *MailboxAPI) GetInbox(writer http.ResponseWriter, req *http.Request) { 47 | 48 | inbox, err := Inbox(m.mailbox, m.config) 49 | if err != nil { 50 | log.Println(err) 51 | http.Error(writer, "Error occurred accessing inbox", http.StatusInternalServerError) 52 | return 53 | } 54 | 55 | listHandler(inbox, writer) 56 | } 57 | 58 | // GetLabels retrieves the available labels in the Mailbox. 59 | func (m *MailboxAPI) GetLabels(writer http.ResponseWriter, req *http.Request) { 60 | 61 | payload, err := m.mailbox.Labels() 62 | if err != nil { 63 | log.Println("Failed to get labels", err) 64 | http.Error(writer, "Failed to get labels", http.StatusInternalServerError) 65 | return 66 | } 67 | 68 | listHandler(payload, writer) 69 | } 70 | 71 | // HandleSingleMessage retrieves a message by ID from the Mailbox. 72 | func (m *MailboxAPI) HandleSingleMessage(writer http.ResponseWriter, req *http.Request) { 73 | vars := mux.Vars(req) 74 | rawID, err := url.PathUnescape(vars["id"]) 75 | 76 | if err != nil { 77 | log.Println("Failed to extract message ID from URL", err) 78 | http.Error(writer, "Failed to extract message ID from URL", http.StatusBadRequest) 79 | return 80 | } 81 | 82 | payload, err := m.mailbox.ReadMessage(rawID) 83 | if err != nil { 84 | log.Println("Failed to read message", err) 85 | http.Error(writer, "Failed to read message", http.StatusInternalServerError) 86 | return 87 | } 88 | 89 | handler(payload, writer) 90 | } 91 | 92 | // HandleAllMessages retrieves all messages in the Mailbox. 93 | func (m *MailboxAPI) HandleAllMessages(writer http.ResponseWriter, req *http.Request) { 94 | payload, err := m.mailbox.Search("*") 95 | if err != nil { 96 | log.Println("Failed to get messages", err) 97 | http.Error(writer, "Failed to get messages", http.StatusInternalServerError) 98 | return 99 | } 100 | 101 | listHandler(payload, writer) 102 | } 103 | 104 | // HandleLabeledMessages retrieves any messages in the Mailbox with the specified labels. 105 | func (m *MailboxAPI) HandleLabeledMessages(writer http.ResponseWriter, req *http.Request) { 106 | labels := req.URL.Query()["label"] 107 | 108 | var dbQuery = "" 109 | for _, label := range labels { 110 | if len(label) == 0 { 111 | continue 112 | } 113 | 114 | if len(dbQuery) == 0 { 115 | dbQuery = dbQuery + " tag:" + label 116 | } else { 117 | dbQuery = dbQuery + " and tag:" + label 118 | } 119 | } 120 | 121 | if len(dbQuery) == 0 { 122 | log.Println("No labels given") 123 | http.Error(writer, "No labels given", http.StatusBadRequest) 124 | return 125 | } 126 | 127 | payload, err := m.mailbox.Search(dbQuery) 128 | if err != nil { 129 | log.Println("Failed to get messages", err) 130 | http.Error(writer, "Failed to get messages", http.StatusInternalServerError) 131 | return 132 | } 133 | 134 | listHandler(payload, writer) 135 | } 136 | 137 | func handler(content interface{}, writer http.ResponseWriter) { 138 | body, err := json.Marshal(content) 139 | if err != nil { 140 | log.Println("Failed to convert to JSON", err) 141 | http.Error(writer, "Failed to convert to JSON", http.StatusInternalServerError) 142 | return 143 | } 144 | 145 | writer.Header().Set("Content-Type", "application/json") 146 | writer.Write(body) 147 | return 148 | } 149 | 150 | func listHandler(content interface{}, writer http.ResponseWriter) { 151 | // Generally we're expecting a series of results. 152 | // To stop json.Marshal outputting 'null', assume the intent is to return a list. 153 | if reflect.ValueOf(content).IsNil() { 154 | content = make([]interface{}, 0) 155 | } 156 | 157 | handler(content, writer) 158 | return 159 | } 160 | -------------------------------------------------------------------------------- /bundle.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | // A Bundle represents a group of Threads. 21 | type Bundle struct { 22 | ID string `json:"id"` 23 | Type string `json:"type"` 24 | Date int64 `json:"date"` 25 | Threads []Thread `json:"threads"` 26 | } 27 | -------------------------------------------------------------------------------- /cmd/pinbox-server/main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package main 19 | 20 | import ( 21 | "fmt" 22 | "log" 23 | "net/http" 24 | "os" 25 | 26 | "github.com/gorilla/mux" 27 | 28 | "github.com/msp301/pinbox-server" 29 | ) 30 | 31 | func usage() string { 32 | return fmt.Sprintf(`Usage: %s `, os.Args[0]) 33 | } 34 | 35 | func main() { 36 | args := os.Args[1:] 37 | 38 | if len(args) != 1 { 39 | println(usage()) 40 | os.Exit(0) 41 | } 42 | 43 | configPath := args[0] 44 | 45 | config, err := pinbox.ReadConfigFile(configPath) 46 | if err != nil { 47 | log.Fatal(err) 48 | os.Exit(1) 49 | } 50 | 51 | mailbox := pinbox.CreateNotmuch(config) 52 | 53 | api := pinbox.CreateMailboxAPI(mailbox, config) 54 | 55 | router := mux.NewRouter() 56 | router.UseEncodedPath() 57 | 58 | router.Path("/api/messages").Queries("label", "{label}").HandlerFunc(api.HandleLabeledMessages) 59 | 60 | router.HandleFunc("/api/inbox", api.GetInbox) 61 | router.HandleFunc("/api/labels", api.GetLabels) 62 | router.HandleFunc("/api/messages/{id}", api.HandleSingleMessage) 63 | router.HandleFunc("/api/messages", api.HandleAllMessages) 64 | 65 | port := fmt.Sprintf(":%d", config.Port) 66 | 67 | if config.TLS { 68 | err = http.ListenAndServeTLS(port, config.CertificateFile, config.CertificateKey, router) 69 | } else { 70 | err = http.ListenAndServe(port, router) 71 | } 72 | 73 | if err != nil { 74 | log.Fatal(err) 75 | } 76 | 77 | os.Exit(0) 78 | } 79 | -------------------------------------------------------------------------------- /config.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | import ( 21 | "github.com/BurntSushi/toml" 22 | ) 23 | 24 | // Config holds any settings used to define the behaviour of the service. 25 | // For example to set the port to host the API on etc. 26 | type Config struct { 27 | Maildir string 28 | TLS bool 29 | CertificateFile string `toml:"certificate_file"` 30 | CertificateKey string `toml:"certificate_key"` 31 | Port int 32 | Inbox string 33 | Bundle []string 34 | Hidden []string 35 | } 36 | 37 | // ReadConfigFile loads the configuration file from disk. 38 | // Returns a Config object. 39 | func ReadConfigFile(path string) (Config, error) { 40 | var config = Config{} 41 | 42 | _, err := toml.DecodeFile(path, &config) 43 | 44 | return config, err 45 | } 46 | -------------------------------------------------------------------------------- /config_test.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | import ( 21 | "testing" 22 | ) 23 | 24 | func TestReadingConfig(t *testing.T) { 25 | filePath := "example/config.toml" 26 | config, err := ReadConfigFile(filePath) 27 | 28 | if err != nil { 29 | t.Fatalf("Failed to read config file '%s': %s", filePath, err) 30 | } 31 | 32 | if config.Port != 8000 { 33 | t.Fatalf("Unexpected port number read from config file '%s'", filePath) 34 | } 35 | } 36 | 37 | func TestReadingNonExistantConfig(t *testing.T) { 38 | filePath := "doesnotexist" 39 | _, err := ReadConfigFile(filePath) 40 | 41 | if err == nil { 42 | t.Fatalf("Expected error") 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /example/config.toml: -------------------------------------------------------------------------------- 1 | maildir = "/home/example/mail" 2 | port = 8000 3 | 4 | tls = true 5 | certificate_file = "server.crt" 6 | certificate_key = "server.key" 7 | 8 | # Label to use for inbox 9 | inbox = "inbox" 10 | 11 | # Bundle messages in the inbox with these labels 12 | bundle = [ 13 | "forums", 14 | ] 15 | 16 | # Labels to not include in label list 17 | hidden = [ 18 | "inbox", 19 | "unread", 20 | "attachment", 21 | ] -------------------------------------------------------------------------------- /label.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | // A Label is a tag that can be used to organise messages in the Mailbox. 21 | type Label struct { 22 | ID string `json:"id"` 23 | Name string `json:"name"` 24 | } 25 | -------------------------------------------------------------------------------- /mailbox.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | import ( 21 | "errors" 22 | "fmt" 23 | "log" 24 | "sort" 25 | "time" 26 | ) 27 | 28 | // The Mailbox interface acts as a wrapper for all email actions to abstract any 29 | // direct email access from the business logic of the Pinbox API transport. 30 | type Mailbox interface { 31 | Labels() ([]Label, error) 32 | ReadMessage(id string) (MessageContent, error) 33 | Search(query string) ([]Thread, error) 34 | } 35 | 36 | // Inbox returns all email messages that match the configured 'Inbox' whilst 37 | // grouping together any messages that match the labels configured in the 'Bundle' list. 38 | // 39 | // Returns a mixed list of Thread and Bundle objects. 40 | // The list is returned in reverse chronological order. 41 | func Inbox(mailbox Mailbox, config Config) ([]interface{}, error) { 42 | inboxLabel := config.Inbox 43 | 44 | queryString := "tag:" + inboxLabel 45 | for _, label := range config.Bundle { 46 | queryString += " and not tag:" + label 47 | } 48 | 49 | threads, err := mailbox.Search(queryString) 50 | if err != nil { 51 | return nil, errors.New("Search failed: " + err.Error()) 52 | } 53 | 54 | bundles := make(map[string][]*Bundle) 55 | for _, label := range config.Bundle { 56 | res, err := mailbox.Search("tag:" + inboxLabel + " and tag:" + label) 57 | if err != nil { 58 | log.Println(fmt.Sprintf("Error with bundle '%s': %s", label, err)) 59 | continue 60 | } 61 | 62 | bundled := make([]Thread, 0) 63 | var latestDate int64 64 | for _, thread := range res { 65 | date := thread.NewestDate 66 | 67 | if date > latestDate { 68 | latestDate = date 69 | } 70 | 71 | bundled = append(bundled, thread) 72 | } 73 | 74 | if len(bundled) > 0 { 75 | latest := time.Unix(latestDate, 0) 76 | month := fmt.Sprintf("%d %d", latest.Month(), latest.Year()) 77 | bundles[month] = append( 78 | bundles[month], 79 | &Bundle{ 80 | ID: label, 81 | Type: "bundle", 82 | Date: latestDate, 83 | Threads: bundled, 84 | }) 85 | } 86 | } 87 | 88 | for key := range bundles { 89 | sort.Slice(bundles[key], func(i, j int) bool { 90 | return bundles[key][i].Date > bundles[key][j].Date 91 | }) 92 | } 93 | 94 | inbox := make([]interface{}, 0) 95 | var prevDate time.Time 96 | for _, thread := range threads { 97 | date := time.Unix(thread.NewestDate, 0) 98 | month := fmt.Sprintf("%d %d", date.Month(), date.Year()) 99 | 100 | if len(bundles[month]) > 0 { 101 | for _, bundle := range bundles[month] { 102 | bundleDate := bundle.Date 103 | 104 | if bundleDate > date.Unix() { 105 | bundle.Type = "bundle" 106 | inbox = append(inbox, bundle) 107 | } 108 | } 109 | } 110 | 111 | thread.Type = "thread" 112 | inbox = append(inbox, thread) 113 | prevDate = date 114 | } 115 | 116 | // We have already added all top-level threads. 117 | // There may still be bundles that have not been included. 118 | // Flush out any remaining bundles that are older than our last top-level thread. 119 | keys := make([]string, 0) 120 | for key := range bundles { 121 | keys = append(keys, key) 122 | } 123 | sort.Sort(sort.Reverse(sort.StringSlice(keys))) 124 | 125 | for _, key := range keys { 126 | for _, bundle := range bundles[key] { 127 | if bundle.Date < prevDate.Unix() { 128 | bundle.Type = "bundle" 129 | inbox = append(inbox, bundle) 130 | } 131 | } 132 | } 133 | 134 | return inbox, nil 135 | } 136 | -------------------------------------------------------------------------------- /message.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | // A Message represents an individual email. 21 | type Message struct { 22 | ID string `json:"id"` 23 | Epoch int64 `json:"epoch"` 24 | Author string `json:"author"` 25 | Files []string `json:"files"` 26 | } 27 | 28 | // MessageContent is a container for the body of a Message. 29 | type MessageContent struct { 30 | ID string `json:"id"` 31 | Epoch int64 `json:"epoch"` 32 | Author string `json:"author"` 33 | Content string `json:"content"` 34 | } 35 | -------------------------------------------------------------------------------- /notmuch.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | import ( 21 | "encoding/base64" 22 | "errors" 23 | "fmt" 24 | "os" 25 | "path/filepath" 26 | 27 | "github.com/jhillyerd/enmime" 28 | notmuch "github.com/msp301/go.notmuch" 29 | ) 30 | 31 | // Notmuch is a Mailbox object intended to interact with a Notmuch database. 32 | // See https://notmuchmail.org/ for more information. 33 | type Notmuch struct { 34 | DbPath string 35 | ExcludeLabels []string 36 | InboxLabel string 37 | Bundle []string 38 | } 39 | 40 | // CreateNotmuch creates a new Notmuch object ready to interact with the 41 | // database specified by the given configuration. 42 | func CreateNotmuch(config Config) *Notmuch { 43 | mailbox := Notmuch{ 44 | DbPath: config.Maildir, 45 | ExcludeLabels: config.Hidden, 46 | InboxLabel: config.Inbox, 47 | Bundle: config.Bundle, 48 | } 49 | return &mailbox 50 | } 51 | 52 | // Labels returns a list of Label objects corresponding to 'tags' configured in 53 | // the Notmuch database. 54 | // Any label IDs specified in Notmuch.ExcludeLabels will be omitted. 55 | func (mailbox *Notmuch) Labels() ([]Label, error) { 56 | db, err := openDatabase(mailbox.DbPath) 57 | if err != nil { 58 | return nil, err 59 | } 60 | 61 | defer db.Close() 62 | 63 | tags, err := db.Tags() 64 | if err != nil { 65 | return nil, errors.New("Error getting tags") 66 | } 67 | 68 | hidden := make(map[string]int, 0) 69 | for _, label := range mailbox.ExcludeLabels { 70 | hidden[label] = 1 71 | } 72 | 73 | var payload []Label 74 | tag := ¬much.Tag{} 75 | for tags.Next(&tag) { 76 | name := tag.Value 77 | if hidden[name] == 1 { 78 | continue 79 | } 80 | label := Label{ID: name, Name: name} 81 | payload = append(payload, label) 82 | } 83 | 84 | return payload, nil 85 | } 86 | 87 | // ReadMessage retrieves the content of an email. 88 | // Returns a MessageContent object containing email body encoded in base64. 89 | func (mailbox *Notmuch) ReadMessage(id string) (MessageContent, error) { 90 | 91 | db, err := openDatabase(mailbox.DbPath) 92 | if err != nil { 93 | return MessageContent{}, err 94 | } 95 | 96 | defer db.Close() 97 | 98 | var msg *notmuch.Message 99 | var msgFilename string 100 | if err == nil { 101 | msg, err = db.FindMessage(id) 102 | 103 | if err == nil { 104 | msgFilename = msg.Filename() 105 | } 106 | } 107 | 108 | if err != nil { 109 | return MessageContent{}, fmt.Errorf("%s: %s", id, err) 110 | } 111 | 112 | file, err := os.Open(msgFilename) 113 | 114 | if err != nil { 115 | return MessageContent{}, err 116 | } 117 | defer file.Close() 118 | 119 | env, err := enmime.ReadEnvelope(file) 120 | 121 | if err != nil { 122 | return MessageContent{}, err 123 | } 124 | 125 | body := env.HTML 126 | if len(body) == 0 { 127 | body = env.Text 128 | } 129 | 130 | encodedContent := base64.StdEncoding.EncodeToString([]byte(body)) 131 | 132 | payload := MessageContent{ 133 | ID: msg.ID(), 134 | Epoch: msg.Date().Unix(), 135 | Author: msg.Header("From"), 136 | Content: encodedContent, 137 | } 138 | 139 | msg.Close() 140 | 141 | return payload, nil 142 | } 143 | 144 | // Search retrieves emails from the Notmuch database based on a given query. 145 | // The query string must be provided in Xapian query format (https://notmuchmail.org/searching/). 146 | func (mailbox *Notmuch) Search(query string) ([]Thread, error) { 147 | 148 | db, err := openDatabase(mailbox.DbPath) 149 | if err != nil { 150 | return nil, err 151 | } 152 | 153 | defer db.Close() 154 | 155 | dbQuery := db.NewQuery(query) 156 | threads, err := dbQuery.Threads() 157 | 158 | payload := toOurThreads(threads) 159 | 160 | return payload, nil 161 | } 162 | 163 | func openDatabase(path string) (*notmuch.DB, error) { 164 | var db *notmuch.DB 165 | var status error 166 | var dbPath = path + "/.notmuch" 167 | 168 | _, err := filepath.Abs(path) 169 | if err != nil { 170 | return nil, err 171 | } 172 | if _, err := os.Stat(path); os.IsNotExist(err) { 173 | return nil, fmt.Errorf("Mailbox directory '%s' does not exist", path) 174 | } 175 | if _, err := os.Stat(dbPath); os.IsNotExist(err) { 176 | db, status = notmuch.Create(path) 177 | db.Close() 178 | } 179 | if status == nil { 180 | db, status = notmuch.Open(path, notmuch.DBReadWrite) 181 | } else { 182 | return nil, errors.New("Failed to open database") 183 | } 184 | 185 | return db, nil 186 | } 187 | 188 | func toOurThread(thr *notmuch.Thread) Thread { 189 | _, authors := thr.Authors() 190 | 191 | var messages []Message 192 | msg := ¬much.Message{} 193 | msgs := thr.Messages() 194 | for msgs.Next(&msg) { 195 | var files []string 196 | file := "" 197 | filenames := msg.Filenames() 198 | for filenames.Next(&file) { 199 | files = append(files, file) 200 | } 201 | 202 | message := Message{ 203 | ID: msg.ID(), 204 | Author: msg.Header("From"), 205 | Epoch: msg.Date().Unix(), 206 | Files: files, 207 | } 208 | 209 | messages = append(messages, message) 210 | } 211 | msgs.Close() 212 | 213 | res := Thread{ 214 | ID: thr.ID(), 215 | Subject: thr.Subject(), 216 | NewestDate: thr.NewestDate().Unix(), 217 | OldestDate: thr.OldestDate().Unix(), 218 | Authors: authors, 219 | Messages: messages, 220 | } 221 | 222 | return res 223 | } 224 | 225 | func toOurThreads(threads *notmuch.Threads) []Thread { 226 | var payload []Thread 227 | thr := ¬much.Thread{} 228 | for threads.Next(&thr) { 229 | res := toOurThread(thr) 230 | payload = append(payload, res) 231 | } 232 | 233 | return payload 234 | } 235 | -------------------------------------------------------------------------------- /swagger.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Martin Pritchard 2 | # 3 | # This file is part of Pinbox. 4 | # 5 | # Pinbox is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # Pinbox is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with Pinbox. If not, see . 17 | 18 | openapi: "3.0.0" 19 | info: 20 | description: "Backend API for Pinbox webmail" 21 | title: "Pinbox Server" 22 | version: "1.0.0" 23 | 24 | servers: 25 | - url: /api 26 | 27 | components: 28 | schemas: 29 | epoch: 30 | type: number 31 | format: int64 32 | example: 1553292839 33 | 34 | Bundle: 35 | type: object 36 | properties: 37 | id: 38 | type: string 39 | type: 40 | type: string 41 | example: "bundle" 42 | date: 43 | $ref: "#/components/schemas/epoch" 44 | threads: 45 | type: array 46 | items: 47 | $ref: "#/components/schemas/Thread" 48 | 49 | Label: 50 | type: object 51 | properties: 52 | id: 53 | type: string 54 | name: 55 | type: string 56 | 57 | Message: 58 | type: object 59 | properties: 60 | id: 61 | type: string 62 | epoch: 63 | $ref: "#/components/schemas/epoch" 64 | files: 65 | type: array 66 | items: 67 | type: string 68 | 69 | MessageContent: 70 | type: object 71 | properties: 72 | id: 73 | type: string 74 | epoch: 75 | $ref: "#/components/schemas/epoch" 76 | author: 77 | type: string 78 | content: 79 | type: string 80 | format: byte # base64-encoded email body 81 | 82 | Thread: 83 | type: object 84 | properties: 85 | id: 86 | type: string 87 | type: 88 | type: string 89 | example: "thread" 90 | subject: 91 | type: string 92 | newestDate: 93 | $ref: "#/components/schemas/epoch" 94 | oldestDate: 95 | $ref: "#/components/schemas/epoch" 96 | authors: 97 | type: array 98 | items: 99 | type: string 100 | messages: 101 | type: array 102 | items: 103 | $ref: "#/components/schemas/Message" 104 | 105 | tags: 106 | - name: "labels" 107 | description: "Labels available to categorise messages" 108 | - name: "messages" 109 | description: "Email message threads" 110 | 111 | paths: 112 | /labels: 113 | get: 114 | tags: 115 | - "labels" 116 | summary: "All labels available for categorising email messages and threads" 117 | description: "" 118 | responses: 119 | 200: 120 | description: "Success" 121 | content: 122 | application/json: 123 | schema: 124 | type: array 125 | items: 126 | $ref: "#/components/schemas/Label" 127 | /inbox: 128 | get: 129 | tags: 130 | - "inbox" 131 | summary: "Access all messages in email inbox" 132 | description: "Retrieve messages with the 'inbox' label" 133 | responses: 134 | 200: 135 | description: "Success" 136 | content: 137 | application/json: 138 | schema: 139 | type: array 140 | items: 141 | anyOf: 142 | - $ref: "#/components/schemas/Thread" 143 | - $ref: "#/components/schemas/Bundle" 144 | /messages: 145 | get: 146 | tags: 147 | - "messages" 148 | summary: "Access email threads" 149 | responses: 150 | 200: 151 | description: "Success" 152 | content: 153 | application/json: 154 | schema: 155 | type: array 156 | items: 157 | $ref: "#/components/schemas/Thread" 158 | /messages/{id}: 159 | get: 160 | tags: 161 | - "messages" 162 | summary: "Access individual email" 163 | parameters: 164 | - in: path 165 | name: id 166 | description: "Message ID" 167 | required: true 168 | schema: 169 | type: string 170 | responses: 171 | 200: 172 | description: "Success" 173 | content: 174 | application/json: 175 | schema: 176 | type: array 177 | items: 178 | $ref: "#/components/schemas/MessageContent" 179 | -------------------------------------------------------------------------------- /thread.go: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Martin Pritchard 2 | // 3 | // This file is part of Pinbox. 4 | // 5 | // Pinbox is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // Pinbox is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with Pinbox. If not, see . 17 | 18 | package pinbox 19 | 20 | // A Thread represents a Message chain stored in the Mailbox. 21 | type Thread struct { 22 | ID string `json:"id"` 23 | Type string `json:"type"` 24 | Subject string `json:"subject"` 25 | NewestDate int64 `json:"newestDate"` 26 | OldestDate int64 `json:"oldestDate"` 27 | Authors []string `json:"authors"` 28 | Messages []Message `json:"messages"` 29 | } 30 | --------------------------------------------------------------------------------