pax_global_header00006660000000000000000000000064130554152240014513gustar00rootroot0000000000000052 comment=770d00a8955b2ad8be9daf2923e31221c4847043 notmuch-0.23.7/000077500000000000000000000000001305541522400132615ustar00rootroot00000000000000notmuch-0.23.7/.dir-locals.el000066400000000000000000000010431305541522400157100ustar00rootroot00000000000000;; emacs local configuration settings for notmuch source ;; surmised by dkg on 2010-11-23 13:43:18-0500 ;; amended by amdragon on 2011-06-06 ((c-mode (indent-tabs-mode . t) (tab-width . 8) (c-basic-offset . 4) (c-file-style . "linux")) (c++-mode (indent-tabs-mode . t) (tab-width . 8) (c-basic-offset . 4) (c-file-style . "linux")) (emacs-lisp-mode (indent-tabs-mode . t) (tab-width . 8)) (shell-mode (indent-tabs-mode . t) (tab-width . 8) (sh-basic-offset . 4) (sh-indentation . 4)) (nil (fill-column . 70)) ) notmuch-0.23.7/.gitignore000066400000000000000000000002651305541522400152540ustar00rootroot00000000000000.first-build-message Makefile.config sh.config version.stamp TAGS tags *cscope* .deps /notmuch notmuch.sym notmuch-shared libnotmuch.so* libnotmuch*.dylib *.[ao] *~ .*.swp releases notmuch-0.23.7/.mailmap000066400000000000000000000004201305541522400146760ustar00rootroot00000000000000Peter Feigl Nate Ali Polatel Stefan Patrick Totzke Patrick Totzke Patrick Totzke Mark Walters notmuch-0.23.7/.travis.yml000066400000000000000000000016231305541522400153740ustar00rootroot00000000000000language: c before_install: - sudo apt-get update -qq - sudo apt-get install dtach libxapian-dev libgmime-2.6-dev libtalloc-dev python-sphinx # Notmuch requires zlib 1.2.5.2, unfortunately travis runs on Ubuntu 12.04LTS which # ships with zlib 1.2.3.3. We need to update to zlib 1.2.5.2 to be able to build. # TODO: Watch https://github.com/travis-ci/travis-ci/issues/2046 and remove # this hack once travis-ci switches to Ubuntu 14.04 - wget 'https://github.com/notmuch/travis-files/raw/master/zlib1g-dev_1.2.8.dfsg-1ubuntu1_amd64.deb' - wget 'https://github.com/notmuch/travis-files/raw/master/zlib1g_1.2.8.dfsg-1ubuntu1_amd64.deb' - sudo dpkg -i zlib1g-dev_1.2.8.dfsg-1ubuntu1_amd64.deb zlib1g_1.2.8.dfsg-1ubuntu1_amd64.deb - sudo apt-get install -f script: - ./configure - make test notifications: irc: channels: - "chat.freenode.net#notmuch" on_success: change notmuch-0.23.7/AUTHORS000066400000000000000000000023331305541522400143320ustar00rootroot00000000000000Carl Worth is the primary author of Notmuch. But there's really not much that he's done. There's been a lot of standing on shoulders here: William Morgan deserves credit for providing the primary inspiration for Notmuch with his program Sup (http://sup.rubyforge.org/). Some people have contributed code that has made it into Notmuch without their specific knowledge (but with their full permission thanks to the GNU General Public License). This includes: Brian Gladman (with Mikhail Gusarov ) Implementation of SHA-1 (nice and small) (libsha1.c) Please see the various files in the Notmuch distribution for individual copyright statements. And of course, though their code isn't distributed here, Notmuch would be not much of anything without the contributors to Xapian, the search engine that does the really heavy lifting, as well as the various system libraries, compilers, and the kernel that make it all work (thanks GNU, thanks Linux). Thanks to everyone who has played a part! Here is an incomplete list of other people that have made contributions to Notmuch (whether by code, bug reporting/fixes, ideas, inspiration, testing or feedback): Martin Krafft Keith Packard Jamey Sharp notmuch-0.23.7/COPYING000066400000000000000000000012141305541522400143120ustar00rootroot00000000000000Notmuch is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program, (in the COPYING-GPL-3 file in this directory). If not, see https://www.gnu.org/licenses/ notmuch-0.23.7/COPYING-GPL-3000066400000000000000000001044001305541522400150730ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . notmuch-0.23.7/INSTALL000066400000000000000000000056511305541522400143210ustar00rootroot00000000000000Build and install instructions for Notmuch. Compilation commands -------------------- The process for compiling and installing Notmuch is the very standard sequence of: ./configure make sudo make install In fact, if you don't plan to pass any arguments to the configure script, then you can skip that step and just start with "make", (which will call configure for you). See this command: ./configure --help for detailed documentation of the things you can control at the configure stage. Dependencies ------------ Notmuch depends on four libraries: Xapian, GMime 2.6, Talloc, and zlib which are each described below: Xapian ------ Xapian is the search-engine library underlying Notmuch. It provides all the real machinery of indexing and searching, (including the very nice parsing of the query string). Xapian is available from https://xapian.org Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian 1.1.4 (or later). Previous versions of Xapian (whether 1.0 or 1.1) had a performance bug that made notmuch very slow when modifying tags. This would cause distracting pauses when reading mail while notmuch would wait for Xapian when removing the "inbox" and "unread" tags from messages in a thread. GMime 2.6 ---------- GMime provides decoding of MIME email messages for Notmuch. Without GMime, Notmuch would not be able to extract and index the actual text from email message encoded as BASE64, etc. GMime is available from http://spruce.sourceforge.net/gmime/ Talloc ------ Talloc is a memory-pool allocator used by Notmuch. Talloc is an extremely lightweight and easy-to-use tool for allocating memory in a hierarchical fashion and then freeing it with a single call of the top-level handle. Using it has made development of Notmuch much easier and much less prone to memory leaks. Talloc is available from https://talloc.samba.org/ zlib ---- zlib is an extremely popular compression library. It is used by Xapian, so if you installed that you will already have zlib. You may need to install the zlib headers separately. Notmuch needs the transparent write feature of zlib introduced in version 1.2.5.2 (Dec. 2011). zlib is available from http://zlib.net Building Documentation ---------------------- To build the documentation for notmuch you need at least version 1.0 of sphinx (Jul. 2010). Sphinx is available from www.sphinx-doc.org. Installing Dependencies from Packages ------------------------------------- On a modern, package-based operating system you can install all of the dependencies with a simple simple command line. For example: For Debian and similar: sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev zlib1g-dev python-sphinx For Fedora and similar: sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel python-sphinx On other systems, a similar command can be used, but the details of the package names may be different. notmuch-0.23.7/Makefile000066400000000000000000000025641305541522400147300ustar00rootroot00000000000000# We want the all target to be the implicit target (if no target is # given explicitly on the command line) so mention it first. all: # Sub-directory Makefile.local fragments can append to these variables # to have directory-specific cflags as necessary. extra_cflags := extra_cxxflags := # Get settings from the output of configure by running it to generate # Makefile.config if it doesn't exist yet. # If Makefile.config doesn't exist, then srcdir won't be # set. Conditionally set it (assuming a plain srcdir build) so that # the rule to generate Makefile.config can actually work. srcdir ?= . include Makefile.config # We make all targets depend on the Makefiles themselves. global_deps = Makefile Makefile.config Makefile.local \ $(subdirs:%=%/Makefile) $(subdirs:%=%/Makefile.local) Makefile.config: $(srcdir)/configure ifeq ($(configure_options),) @echo "" @echo "Note: Calling ./configure with no command-line arguments. This is often fine," @echo " but if you want to specify any arguments (such as an alternate prefix" @echo " into which to install), call ./configure explicitly and then make again." @echo " See \"./configure --help\" for more details." @echo "" endif $(srcdir)/configure $(configure_options) # Finally, include all of the Makefile.local fragments where all the # real work is done. include $(subdirs:%=%/Makefile.local) Makefile.local notmuch-0.23.7/Makefile.local000066400000000000000000000277741305541522400160330ustar00rootroot00000000000000# -*- makefile -*- # Here's the (hopefully simple) versioning scheme. # # Releases of notmuch have a two-digit version (0.1, 0.2, etc.). We # increment the second digit for each release and increment the first # digit when we reach particularly major milestones of usability. # # Between releases, (such as when compiling notmuch from the git # repository), we let git append identification of the actual commit. PACKAGE=notmuch IS_GIT:=$(if $(wildcard ${srcdir}/.git),yes,no) ifeq ($(IS_GIT),yes) DATE:=$(shell git --git-dir=${srcdir}/.git log --date=short -1 --pretty=format:%cd) else DATE:=$(shell date +%F) endif VERSION:=$(shell cat ${srcdir}/version) ELPA_VERSION:=$(subst ~,_,$(VERSION)) ifeq ($(filter release release-message pre-release update-versions,$(MAKECMDGOALS)),) ifeq ($(IS_GIT),yes) VERSION:=$(shell git --git-dir=${srcdir}/.git describe --abbrev=7 --match '[0-9.]*'|sed -e s/_/~/ -e s/-/+/ -e s/-/~/) # drop the ~g$sha1 part ELPA_VERSION:=$(word 1,$(subst ~, ,$(VERSION))) # Write the file 'version.stamp' in case its contents differ from $(VERSION) FILE_VERSION:=$(shell test -f version.stamp && read vs < version.stamp || vs=; echo $$vs) ifneq ($(FILE_VERSION),$(VERSION)) $(shell echo "$(VERSION)" > version.stamp) endif endif endif UPSTREAM_TAG=$(subst ~,_,$(VERSION)) DEB_TAG=debian/$(UPSTREAM_TAG)-1 RELEASE_HOST=notmuchmail.org RELEASE_DIR=/srv/notmuchmail.org/www/releases RELEASE_URL=https://notmuchmail.org/releases TAR_FILE=$(PACKAGE)-$(VERSION).tar.gz DEB_TAR_FILE=$(PACKAGE)_$(VERSION).orig.tar.gz SHA1_FILE=$(TAR_FILE).sha1 GPG_FILE=$(SHA1_FILE).asc PV_FILE=bindings/python/notmuch/version.py # Smash together user's values with our extra values STD_CFLAGS := -std=gnu99 FINAL_CFLAGS = -DNOTMUCH_VERSION=$(VERSION) $(CPPFLAGS) $(STD_CFLAGS) $(CFLAGS) $(WARN_CFLAGS) $(extra_cflags) $(CONFIGURE_CFLAGS) FINAL_CXXFLAGS = $(CPPFLAGS) $(CXXFLAGS) $(WARN_CXXFLAGS) $(extra_cflags) $(extra_cxxflags) $(CONFIGURE_CXXFLAGS) FINAL_NOTMUCH_LDFLAGS = $(LDFLAGS) -Lutil -lutil -Llib -lnotmuch ifeq ($(LIBDIR_IN_LDCONFIG),0) FINAL_NOTMUCH_LDFLAGS += $(RPATH_LDFLAGS) endif FINAL_NOTMUCH_LDFLAGS += $(AS_NEEDED_LDFLAGS) $(GMIME_LDFLAGS) $(TALLOC_LDFLAGS) $(ZLIB_LDFLAGS) FINAL_NOTMUCH_LINKER = CC ifneq ($(LINKER_RESOLVES_LIBRARY_DEPENDENCIES),1) FINAL_NOTMUCH_LDFLAGS += $(CONFIGURE_LDFLAGS) FINAL_NOTMUCH_LINKER = CXX endif FINAL_LIBNOTMUCH_LDFLAGS = $(LDFLAGS) $(AS_NEEDED_LDFLAGS) $(CONFIGURE_LDFLAGS) .PHONY: all all: notmuch notmuch-shared build-man ruby-bindings ifeq ($(MAKECMDGOALS),) ifeq ($(shell cat .first-build-message 2>/dev/null),) @NOTMUCH_FIRST_BUILD=1 $(MAKE) --no-print-directory all @echo "" @echo "Compilation of notmuch is now complete. You can install notmuch with:" @echo "" @echo " make install" @echo "" @echo "Note that depending on the prefix to which you are installing" @echo "you may need root permission (such as \"sudo make install\")." @echo "See \"./configure --help\" for help on setting an alternate prefix." @echo Printed > .first-build-message endif endif # Depend (also) on the file 'version'. In case of ifeq ($(IS_GIT),yes) # this file may already have been updated. version.stamp: $(srcdir)/version echo $(VERSION) > $@ $(TAR_FILE): if git tag -v $(UPSTREAM_TAG) >/dev/null 2>&1; then \ ref=$(UPSTREAM_TAG); \ else \ ref="HEAD" ; \ echo "Warning: No signed tag for $(VERSION)"; \ fi ; \ git archive --format=tar --prefix=$(PACKAGE)-$(VERSION)/ $$ref > $(TAR_FILE).tmp echo $(VERSION) > version.tmp tar --append -f $(TAR_FILE).tmp --transform s_^_$(PACKAGE)-$(VERSION)/_ --transform 's_.tmp$$__' version.tmp rm version.tmp gzip < $(TAR_FILE).tmp > $(TAR_FILE) @echo "Source is ready for release in $(TAR_FILE)" $(SHA1_FILE): $(TAR_FILE) sha1sum $^ > $@ $(GPG_FILE): $(SHA1_FILE) @echo "Please enter your GPG password to sign the checksum." gpg --armor --sign $^ .PHONY: dist dist: $(TAR_FILE) .PHONY: update-versions update-versions: sed -i -e "s/^__VERSION__[[:blank:]]*=.*$$/__VERSION__ = \'${VERSION}\'/" \ -e "s/^SOVERSION[[:blank:]]*=.*$$/SOVERSION = \'${LIBNOTMUCH_VERSION_MAJOR}\'/" \ ${PV_FILE} # We invoke make recursively only to force ordering of our phony # targets in the case of parallel invocation of make (-j). # # We carefully ensure that our VERSION variable is passed down to any # sub-ordinate make invocations (which won't otherwise know that they # are part of the release and need to take the version from the # version file). .PHONY: release release: verify-source-tree-and-version $(MAKE) VERSION=$(VERSION) verify-newer $(MAKE) VERSION=$(VERSION) clean $(MAKE) VERSION=$(VERSION) test git tag -s -m "$(PACKAGE) $(VERSION) release" $(UPSTREAM_TAG) $(MAKE) VERSION=$(VERSION) $(GPG_FILE) ln -sf $(TAR_FILE) $(DEB_TAR_FILE) pristine-tar commit $(DEB_TAR_FILE) $(UPSTREAM_TAG) git tag -s -m "$(PACKAGE) Debian $(VERSION)-1 upload (same as $(VERSION))" $(DEB_TAG) mkdir -p releases mv $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) releases $(MAKE) VERSION=$(VERSION) release-message > $(PACKAGE)-$(VERSION).announce ifeq ($(REALLY_UPLOAD),yes) git push origin $(VERSION) cd releases && scp $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) $(RELEASE_HOST):$(RELEASE_DIR) ssh $(RELEASE_HOST) "rm -f $(RELEASE_DIR)/LATEST-$(PACKAGE)-* ; ln -s $(TAR_FILE) $(RELEASE_DIR)/LATEST-$(TAR_FILE)" endif @echo "Please send a release announcement using $(PACKAGE)-$(VERSION).announce as a template." .PHONY: pre-release pre-release: $(MAKE) VERSION=$(VERSION) clean $(MAKE) VERSION=$(VERSION) test git tag -s -m "$(PACKAGE) $(VERSION) release" $(UPSTREAM_TAG) git tag -s -m "$(PACKAGE) Debian $(VERSION)-1 upload (same as $(VERSION))" $(DEB_TAG) $(MAKE) VERSION=$(VERSION) $(TAR_FILE) ln -sf $(TAR_FILE) $(DEB_TAR_FILE) pristine-tar commit $(DEB_TAR_FILE) $(UPSTREAM_TAG) mkdir -p releases mv $(TAR_FILE) $(DEB_TAR_FILE) releases .PHONY: debian-snapshot debian-snapshot: make VERSION=$(VERSION) clean TMPFILE=$$(mktemp /tmp/notmuch.XXXXXX); \ cp debian/changelog $${TMPFILE}; \ EDITOR=/bin/true dch -b -v $(VERSION)+1 \ -D UNRELEASED 'test build, not for upload'; \ echo '3.0 (native)' > debian/source/format; \ debuild -us -uc; \ mv -f $${TMPFILE} debian/changelog; \ echo '3.0 (quilt)' > debian/source/format .PHONY: release-message release-message: @echo "To: notmuch@notmuchmail.org" @echo "Subject: $(PACKAGE) release $(VERSION) now available" @echo "" @echo "Where to obtain notmuch $(VERSION)" @echo "===========================" @echo " $(RELEASE_URL)/$(TAR_FILE)" @echo "" @echo "Which can be verified with:" @echo "" @echo " $(RELEASE_URL)/$(SHA1_FILE)" @echo -n " " @cat releases/$(SHA1_FILE) @echo "" @echo " $(RELEASE_URL)/$(GPG_FILE)" @echo " (signed by `getent passwd "$$USER" | cut -d: -f 5 | cut -d, -f 1`)" @echo "" @echo "What's new in notmuch $(VERSION)" @echo "=========================" @sed -ne '/^[Nn]otmuch $(VERSION)/{n;n;b NEWS}; d; :NEWS /^===/q; {p;n;b NEWS}' < NEWS | head -n -2 @echo "" @echo "What is notmuch" @echo "===============" @echo "Notmuch is a system for indexing, searching, reading, and tagging" @echo "large collections of email messages in maildir or mh format. It uses" @echo "the Xapian library to provide fast, full-text search with a convenient" @echo "search syntax." @echo "" @echo "For more about notmuch, see https://notmuchmail.org" # This is a chain of dependencies rather than a simple list simply to # avoid the messages getting interleaved in the case of a parallel # make invocation. .PHONY: verify-source-tree-and-version verify-source-tree-and-version: verify-no-dirty-code .PHONY: verify-no-dirty-code verify-no-dirty-code: release-checks ifeq ($(IS_GIT),yes) @printf "Checking that source tree is clean..." ifneq ($(shell git --git-dir=${srcdir}/.git ls-files -m),) @echo "No" @echo "The following files have been modified since the most recent git commit:" @echo "" @git --git-dir=${srcdir}/.git ls-files -m @echo "" @echo "The release will be made from the committed state, but perhaps you meant" @echo "to commit this code first? Please clean this up to make it more clear." @false else @echo "Good" endif endif .PHONY: release-checks release-checks: devel/release-checks.sh .PHONY: verify-newer verify-newer: @echo -n "Checking that no $(VERSION) release already exists..." @wget -q --no-check-certificate -O /dev/null $(RELEASE_URL)/$(TAR_FILE) ; \ case $$? in \ 8) echo "Good." ;; \ 0) echo "Ouch."; \ echo "Found: $(RELEASE_URL)/$(TAR_FILE)"; \ echo "Refusing to replace an existing release."; \ echo "Don't forget to update \"version\" as described in RELEASING before release." ; \ false ;; \ *) echo "An unexpected error occured"; \ false;; esac # The user has not set any verbosity, default to quiet mode and inform the # user how to enable verbose compiles. ifeq ($(V),) quiet_DOC := "Use \"$(MAKE) V=1\" to see the verbose compile lines.\n" quiet = @printf $(quiet_DOC)$(eval quiet_DOC:=)"$1 $@\n"; $($(shell echo $1 | sed -e s'/ .*//')) endif # The user has explicitly enabled quiet compilation. ifeq ($(V),0) quiet = @printf "$1 $@\n"; $($(shell echo $1 | sed -e s'/ .*//')) endif # Otherwise, print the full command line. quiet ?= $($(shell echo $1 | sed -e s'/ .*//')) %.o: %.cc $(global_deps) @mkdir -p $(patsubst %/.,%,.deps/$(@D)) $(call quiet,CXX $(CPPFLAGS) $(CXXFLAGS)) -c $(FINAL_CXXFLAGS) $< -o $@ -MD -MP -MF .deps/$*.d %.o: %.c $(global_deps) @mkdir -p $(patsubst %/.,%,.deps/$(@D)) $(call quiet,CC $(CPPFLAGS) $(CFLAGS)) -c $(FINAL_CFLAGS) $< -o $@ -MD -MP -MF .deps/$*.d .PHONY : clean clean: rm -rf $(CLEAN); rm -rf .deps .PHONY: distclean distclean: clean rm -rf $(DISTCLEAN) .PHONY: dataclean dataclean: distclean rm -rf $(DATACLEAN) notmuch_client_srcs = \ command-line-arguments.c\ debugger.c \ status.c \ gmime-filter-reply.c \ hooks.c \ notmuch.c \ notmuch-compact.c \ notmuch-config.c \ notmuch-count.c \ notmuch-dump.c \ notmuch-insert.c \ notmuch-new.c \ notmuch-reply.c \ notmuch-restore.c \ notmuch-search.c \ notmuch-setup.c \ notmuch-show.c \ notmuch-tag.c \ notmuch-time.c \ sprinter-json.c \ sprinter-sexp.c \ sprinter-text.c \ query-string.c \ mime-node.c \ crypto.c \ tag-util.c notmuch_client_modules = $(notmuch_client_srcs:.c=.o) notmuch.o: version.stamp notmuch: $(notmuch_client_modules) lib/libnotmuch.a util/libutil.a parse-time-string/libparse-time-string.a $(call quiet,CXX $(CFLAGS)) $^ $(FINAL_LIBNOTMUCH_LDFLAGS) -o $@ notmuch-shared: $(notmuch_client_modules) lib/$(LINKER_NAME) $(call quiet,$(FINAL_NOTMUCH_LINKER) $(CFLAGS)) $(notmuch_client_modules) $(FINAL_NOTMUCH_LDFLAGS) -o $@ .PHONY: install install: all install-man mkdir -p "$(DESTDIR)$(prefix)/bin/" install notmuch-shared "$(DESTDIR)$(prefix)/bin/notmuch" ifeq ($(MAKECMDGOALS), install) @echo "" @echo "Notmuch is now installed to $(DESTDIR)$(prefix)" @echo "" @echo "New users should simply run \"notmuch\" to be guided" @echo "through the process of configuring notmuch and creating" @echo "a database of existing email messages. The \"notmuch\"" @echo "command will also offer some sample search commands." ifeq ($(WITH_EMACS), 1) @echo "" @echo "Beyond the command-line interface, notmuch also offers" @echo "a full-featured interface for reading and writing mail" @echo "within emacs. To use this, each user should add the" @echo "following line to the ~/.emacs file:" @echo "" @echo " (require 'notmuch)" @echo "" @echo "And then run emacs as \"emacs -f notmuch\" or invoke" @echo "the command \"M-x notmuch\" from within emacs." endif endif .PHONY: install-desktop install-desktop: mkdir -p "$(DESTDIR)$(desktop_dir)" desktop-file-install --mode 0644 --dir "$(DESTDIR)$(desktop_dir)" notmuch.desktop SRCS := $(SRCS) $(notmuch_client_srcs) CLEAN := $(CLEAN) notmuch notmuch-shared $(notmuch_client_modules) CLEAN := $(CLEAN) version.stamp notmuch-*.tar.gz.tmp DISTCLEAN := $(DISTCLEAN) .first-build-message Makefile.config sh.config DEPS := $(SRCS:%.c=.deps/%.d) DEPS := $(DEPS:%.cc=.deps/%.d) -include $(DEPS) .SUFFIXES: # Delete the default suffixes. Old-Fashioned Suffix Rules not used. notmuch-0.23.7/NEWS000066400000000000000000003674231305541522400137770ustar00rootroot00000000000000Notmuch 0.23.7 (2017-02-28) =========================== Test Suite ---------- Drop use of gpgconf --create-socketdir. Move $GNUPGHOME to /tmp. It turns out the hardcoded use of /run/user in gpg doesn't work out that well in some environments. The more low tech fix is to move all of $GNUPGHOME to somewhere where we can control the length of the paths. Notmuch 0.23.6 (2017-02-27) =========================== Command Line Interface ---------------------- Fix read-after-free bug in `notmuch new`. Test Suite ---------- Use gpgconf --create-socketdir if available. GnuPG has a facility to use sockets in /run or /var/run to avoid problems with long socket paths, but this is not enabled by default for GNUPGHOME other than $HOME/.gnupg. Enable it, if possible. Notmuch 0.23.5 (2017-01-09) =========================== Build system ------------ Fix quoting bug in configure. This had introduced a RUNPATH into the notmuch binary in cases where it was not not needed. Notmuch 0.23.4 (2016-12-24) =========================== Command Line Interface ---------------------- Improve error handling in notmuch insert Database lock errors no longer prevent message file delivery to the filesystem. Certain errors during `notmuch insert` most likely to be temporary return EX_TEMPFAIL. Emacs ----- Restore autoload cookie for notmuch-search. Notmuch 0.23.3 (2016-11-27) =========================== Command Line Interface ---------------------- Treat disappearing files during notmuch new as non-fatal. Test Suite ---------- Fix incompatibility (related to signature size) with gnupg 2.1.16. Notmuch 0.23.2 (2016-11-20) =========================== Emacs ----- Fix notmuch-interesting-buffer and notmuch-cycle-notmuch-buffers. notmuch-tree-mode and notmuch-message-mode buffers are now considered interesting by `notmuch-interesting-buffer` and `notmuch-cycle-notmuch-buffers`. Restore compatibility with Emacs 23. Notmuch support for Emacs 23 is now deprecated. Notmuch 0.23.1 (2016-10-23) =========================== General ------- Require Xapian >= 1.2.6 The ifdef branch for older Xapian (pre-compact API) had bit-rotted. Emacs ----- Fix default colours for unread and flagged messages In 0.23 the default colours for unread and flagged messages in search view were accidentally swapped. This release returns them to the original colours. A related change in 0.23 broke the customize widget for notmuch-search-line-faces. This is now fixed. Fix test failure with Emacs 25.1 A previously undiscovered jit-lock related bug was exposed by Emacs 25, causing a notmuch-show mode test to fail. This release fixes the bug, and hence the test. Notmuch 0.23 (2016-10-03) ========================= General (Xapian 1.4+) --------------------- Compiling against Xapian 1.4 enables several new features. Support for single argument date: queries `date:` is equivalent to `date:..`. Support for blocking opens When opening a database notmuch by default will wait for another process to release a write lock, rather than returning an error. Support for named queries Named queries (also known as 'saved searches') can be defined with a `query:name` format. The expansion of these queries is stored in the database and they can be used from any notmuch client. Library ------- Message property API libnotmuch now supports the attachment of arbitrary key-value pairs to messages. These can be used by various tools to manage their private data without polluting the user tag space. They also support iteration of values with the same key or same key prefix. Bug fix for `notmuch_directory_set_mtime` Update cached mtime to match on-disk mtime. CLI --- Support for compile time options A group of `built_with` keys is now supported for notmuch config. Initial keys in this group are `compact`, `field_processor`, and `retry_lock`. Dump/Restore support for configuration information and properties Any configuration information stored in the database (initially just named queries) is dumped and restored. Similarly any properties attached to messages are also dumped and restored. Any new information in the dump format is prefixed by '#' to allow existing scripts to ignore it. Emacs ----- Make notmuch-message-mode use insert for fcc Notmuch-message-mode now defaults to using notmuch insert for fcc. The old file based fcc behaviour can be restored by setting the defcustom `notmuch-maildir-use-notmuch-insert` to nil. When using notmuch insert, `notmuch-fcc-dirs` must be a subdirectory of the mailstore (absolute paths are not permitted) followed by any tag changes to be applied to the inserted message. The tag changes are applied after the default tagging for new messages. For example setting the header to "sentmail -inbox +sent" would insert the message in the subdirectory sentmail of the mailstore, add the tag "sent", and not add the (normally added) "inbox" tag. Finally, if the insert fails (e.g. if the database is locked) the user is presented with the option to retry, ignore, or edit the header. Make internal address completion customizable There is a new defcustom `notmuch-address-internal-completion` which controls how the internal completion works: it allows the user to choose whether to match on messages the user sent, or the user received, and to filter the messages used for the match, for example by date. Allow internal address completion on an individual basis There is a new function `notmuch-address-toggle-internal-completion` (by default it has no keybinding) which allows users who normally use an external completion command to use the builtin internal completion for the current buffer. Alternatively, if the user has company-mode enabled, then the user can use company mode commands such as `company-complete` to activate the builtin completion for an individual completion. Resend messages The function `notmuch-show-resend-message` (bound to `b` in show and tree modes) will (attempt to) send current message to new recipients. The headers of the message won't be altered (e.g. `To:` may point to yourself). New `Resent-To:`, `Resent-From:` and so on will be added instead. Face customization is easier New faces `notmuch-tag-unread`, `notmuch-tag-flagged`, `notmuch-tag-deleted`, `notmuch-tag-added`, `notmuch-search-flagged-face` and `notmuch-search-unread-face` are now used by default. Customize `notmuch-faces` to modify them. Omit User-Agent header by default when sending mail Ruby Bindings ------------- Add support for `notmuch_database_get_all_tags` Go Bindings ----------- Go bindings moved to contrib Add support for `notmuch_threads_t` and `notmuch_thread_t` Fixed constant values so they are not all zero anymore Previously, it was impossible to open writable database handles, because `DATABASE_MODE_READ_ONLY` and `DATABASE_MODE_READ_WRITE` were both set to zero. The same issue occured with sort modes. Notmuch 0.22.2 (2016-09-08) =========================== Test Suite ---------- Silence gdb more Have gdb write to a log file instead of stdout, hiding some more (harmless) stderr chatter which causes test failures. Hardcode fingerprint in PGP/MIME tests Make the tests more robust against changing GnuPG output formats. Notmuch 0.22.1 (2016-07-19) =========================== Library ------- Correct the definition of `LIBNOTMUCH_CHECK_VERSION`. Document the (lack of) operations permitted on a closed database. Test Suite ---------- Fix race condition in dump / restore tests. Notmuch-Mutt ------------ Use `env` to locate perl. Emacs ----- Tell `message-mode` mode that outgoing messages are mail This makes message-mode configuration behave more predictably. Respect charset of MIME parts when reading them Fix previous assumption that everyone uses UTF-8. Notmuch 0.22 (2016-04-26) ========================= General ------- Xapian 1.3 support Notmuch should now build (and the test suite should pass) on recent releases of Xapian 1.3.x. It has been tested with Xapian 1.3.5. Limited support for S/MIME messages Signature verification is supported, but not decryption. S/MIME signature creation and S/MIME encryption are supported via built-in support in Emacs. S/MIME support is not extensively tested at this time. Bug Fixes Fix for threading bug involving deleting and re-adding messages. Fix for case-sensitive content disposition headers. Fix handling of 1 character directory names at top level. Command Line Interface ---------------------- `notmuch show` now supports verifying S/MIME signatures This support relies on an appropriately configured `gpgsm`. Build System ------------ Drop dependency on "pkg-config emacs". Emacs Interface --------------- Notmuch replies now include all parts shown in the show view There are two main user visible changes. The first is that rfc822 parts are now included in replies. The second change is that part headers are now included in the reply buffer to provide visible separation of the parts. The choice of which part headers to show is customizable via the variable `notmuch-mua-reply-insert-header-p-function`. Filtering or Limiting messages is now bound to `l` in the search view This binding now matches the analogous binding in show view. `F` forwards all open messages in a thread When viewing a thread of messages, the new binding `F` can be used to generate a new outgoing message which forwards all of the open messages in the thread. This is analogous to the `f` binding, which forwards only the current message. Preferred content type can be determined from the message content More flexibility in choosing which sub-part of a multipart/alternative part is initially shown is available by setting `notmuch-multipart/alternative-discouraged` to a function that returns a list of discouraged types. The function so specified is passed the message as an argument and can examine the message content to determine which content types should be discouraged. This is in addition to the current capabilities (i.e. setting `notmuch-multipart/alternative-discouraged` to a list of discouraged types). When viewing a thread ("show" mode), queries that match no messages no longer generate empty buffers Should an attempt be made to view the thread corresponding to a query that matches no messages, a warning message is now displayed and the terminal bell rung rather than displaying an empty buffer (or, in some cases, displaying an empty buffer and throwing an error). This also affects re-display of the current thread. Handle S/MIME signatures in emacs The emacs interface is now capable making and verifying S/MIME signatures. `notmuch-message-address-insinuate` is now a no-op This reduces the amount of interference with non-notmuch uses of message-mode. Address completion improvements An external script is no longer needed for address completion; if you previously configured one, customize the variable `notmuch-address-command` to try the internal completion. If `company-mode` is available, notmuch uses it by default for interactive address completion. Test and experiment with the emacs MUA available in source tree `./devel/try-emacs-mua` runs emacs and fills the window with information how to try the MUA safely. Emacs is configured to use the notmuch (lisp) files located in `./emacs` directory. Documentation ------------- New `notmuch-report(1)` and `notmuch-report.json(5)` man pages describe `notmuch-report` and its JSON configuration file. You can build these files by running `make` in the `devel/nmbug/doc` directory. notmuch-report -------------- Renamed from `nmbug-status`. This script generates reports based on notmuch queries, and doesn't really have anything to do with nmbug, except for sharing the `NMBGIT` environment variable. The new name focuses on the script's action, instead of its historical association with the nmbug workflow. This should make it more discoverable for users looking for generic notmuch reporting tools. The default configuration file name (extracted from the `config` branch of `NBMGIT` has changed from `status-config.json` to `notmuch-report.json` so it is more obviously associated with the report-generating script. The configuration file also has a new `meta.message-url` setting, which is documented in `notmuch-report.json(5)`. `notmuch-report` now wraps query phrases in parentheses when and-ing them together, to avoid confusion about clause grouping. Notmuch 0.21 (2015-10-29) ========================= General ------- Notmuch now requires gmime >= 2.6.7. The gmime 2.4 series is no longer supported. Database revision tracking: `lastmod:` queries Each message now has a metadata revision number that increases with every tagging operation. See the discussion of `lastmod:` in `notmuch-search-terms(7)` for more information. Date queries now support `date:..!` shorthand for `date:..` You can use, for example, `date:yesterday..!` to match from the beginning of yesterday to the end of yesterday. For further details, please refer to the `notmuch-search-terms` manual page. Notmuch database upgrade to support `lastmod:` queries The above mentioned `lastmod:` prefix. This will be done automatically, without prompting on the next time `notmuch new` is run after the upgrade. The upgrade is not reversible, and the upgraded database will not be readable by older versions of Notmuch. As a safeguard, a database dump will be created in the `.notmuch` directory before upgrading. Build System ------------ The ruby bindings are now built as part of the main notmuch build process. This can be disabled with the `--without-ruby` option to configure. Building the documentation can be disabled with the `--without-docs` option to configure. Skipped individual tests are no longer considered as failures. Command Line Interface ---------------------- Database revision tracking Two new options were added to support revision tracking. A global option "--uuid" (`notmuch(1)`) was added for to detect counter rollover and reinitialization, and `notmuch-count(1)` gained a `--lastmod` option to query database revision tracking data. The `notmuch address` command supports new deduplication schemes `notmuch address` has gained a new `--deduplicate` option to specify how the results should be deduplicated, if at all. The alternatives are `no` (do not deduplicate, useful for processing the results with external tools), `mailbox` (deduplicate based on the full, case sensitive name and email address), and `address` (deduplicate based on the case insensitive address part). See the `notmuch-address` manual page for further information. Emacs Interface --------------- `notmuch-emacs-version` is used in `User-Agent` header The value of recently introduced variable `notmuch-emacs-version` is now used as a part of `User-Agent` header when sending emails. Removed `notmuch-version` function by renaming it to `notmuch-cli-version` With existing variable `notmuch-emacs-version` the accompanied function which retrieves the version of `notmuch-command` is better named as `notmuch-cli-version`. Query input now supports completion for "is:" New message composition mode: `notmuch-compose-mode` This is mainly to fix fcc handling, but may be useful for user customization as well. Allow filtering of search results in `notmuch-show` Add function to rerun current tree-view search in search mode Bug fix for replying to encrypted messages in `notmuch-tree` mode Allow saved searched to specify tree view rather than search view Applies to saved searches run from `notmuch-hello`, or by a keyboard shortcut (`notmuch-jump`). Can be set in the customize interface, or by adding :search-type tree to the appropriate saved search plist in `notmuch-saved-searches`. Increase maximum size of rendered text parts The variable `notmuch-show-max-text-part-size` controls the maximum size (in bytes) which is automatically rendered. This may make rendering large threads slower. To get the previous behaviour set this variable to 10000. Library ------- The use of absolute paths is now enforced when calling `notmuch_database_{open, create}` New function `notmuch_directory_delete` to delete directory documents Previously there was no way to delete directory documents from the database, leading to confusing results when the "ghost" directory document of a renamed or deleted filesystem directory was encountered every time the parent directory was being scanned by `notmuch new`. The mtime of the old directory document was also used if a directory by the same name was added again in the filesystem, potentially bypassing the scan for the directory. The issues are fixed by providing a library call to delete directory documents, and deleting the old documents in `notmuch new` on filesystem directory removal or rename. Database revision tracking Revision tracking is supported via a new prefix "lastmod:" in the query parser and the new function `notmuch_database_get_revision`. For the latter, see `notmuch(3)`. New status code returning API for n_query_count_{messages,threads} Deprecated functions `notmuch_query_search_threads`, `notmuch_query_search_messages`, `notmuch_query_count_messages`, and `notmuch_query_count_threads` are all deprecated as of this release. Clients are encouraged to transition to the `_st` variants supporting better error reporting. nmbug-status ------------ `nmbug-status` now supports specifying the sort order for each view. Notmuch 0.20.2 (2015-06-27) =========================== Emacs Interface --------------- Bug fix for marking messages read in `notmuch-tree` mode. Notmuch 0.20.1 (2015-06-01) =========================== Test Suite ---------- Work around apparent gdb bug on arm64. Notmuch 0.20 (2015-05-31) ========================= Command-Line Interface ---------------------- There is a new `mimetype:` search prefix The new `mimetype:` search prefix allows searching for the content-type of attachments, which is now indexed. See the `notmuch-search-terms` manual page for details. Path to gpg is now configurable On systems with multiple versions of gpg, you can tell notmuch which one to use by setting `crypto.gpg_path` Emacs ----- Avoid rendering large text attachements. Improved rendering of CID references in HTML. Vim --- Vim client now respects excluded tags. Notmuch-Mutt ------------ Support messages without Message-IDs. Library ------- Undeprecate single message mboxes It seems more trouble to remove this feature than expected, so `notmuch new` will no longer nag about mboxes with a single message. New error logging facility Clients should call `notmuch_database_status_string` to retrieve output formerly printed to stderr. Several bug fixes related to stale iterators New status code returning API for n_query_search_{messages,thread} Fix for library `install_name` on Mac OS X Fix for rounding of seconds Documentation ------------- Sphinx is now mandatory to build docs Support for using rst2man in place of sphinx to build the docmumentation has been removed. Improved notmuch-search-terms.7 The man page `notmuch-search-terms(7)` has been extended, merging some material from the relicensed wiki. Contrib ------- `notmuch-deliver` is removed. As far as we know, all functionality previously provided by `notmuch-deliver` should now be provided by `notmuch insert`, provided by the main notmuch binary. nmbug-status ------------ `nmbug-status` now only matches local branches when reading `status-config.json` from the `config` branch of the `NMBGIT` repository. To help new users running `nmbug-status`, `nmbug clone` now creates a local `config` branch tracking `origin/config`. Folks who use `nmbug-status` with an in-Git config (i.e. you don't use the `--config` option) who already have `NMBGIT` set up are encouraged to run: git checkout config origin/config in their `NMBGIT` repository (usually `~/.nmbug`). Notmuch 0.19 (2014-11-14) ========================= Overview -------- This release improves the reliability of `notmuch dump` and the error handling for `notmuch insert`. The new `notmuch address` command is intended to make searching for email addresses more convenient. At the library level the revised handling of missing messages fixes at least one bug in threading. The release also includes several interface improvements to the emacs interface, most notably the ability to bind keyboard shortcuts to saved searches. Command-Line Interface ---------------------- Stopped `notmuch dump` failing if someone writes to the database The dump command now takes the write lock when running. This prevents other processes from writing to the database during the dump which would cause the dump to fail. Note, if another notmuch process already has the write lock the dump will not start, so script callers should still check the return value. `notmuch insert` requires successful message indexing for success status Previously the `notmuch insert` subcommand indicated success even if the message indexing failed, as long as the message was delivered to file system. This could have lead to delivered messages missing tags, etc. `notmuch insert` is now more strict, also requiring successful indexing for success status. Use the new `--keep` option to revert to the old behaviour (keeping the delivered message file and returning success even if indexing fails). `notmuch insert` has gained support for `post-insert` hook The new `post-insert` hook is run after message delivery, similar to `post-new`. There's also a new option `notmuch insert --no-hooks` to skip the hook. See the notmuch-hooks(1) man page for details. `notmuch deliver` is deprecated With this release we believe that `notmuch insert` has reached parity with `notmuch deliver`. We recommend that all users of `notmuch deliver` switch to `notmuch insert` as the former is currently unmaintained. `notmuch search` now supports `--duplicate=N` option with `--output=messages` Complementing the `notmuch search --duplicate=N --output=files` options, the new `--duplicate=N --output=messages` combination limits output of message IDs to messages matching search terms that have at least `N` files associated with them. Added `notmuch address` subcommand This new subcommand searches for messages matching the given search terms, and prints the addresses from them. Duplicate addresses are filtered out. The `--output` option controls which of the following information is printed: sender addresses, recipient addresses and count of duplicate addresses. Emacs Interface --------------- Use the `j` key to access saved searches from anywhere in notmuch `j` is now globally bound to `notmuch-jump`, which provides fast, interactive keyboard shortcuts to saved searches. For example, with the default saved searches `j i` from anywhere in notmuch will bring up the inbox. Improved handling of the unread tag Notmuch now marks an open message read (i.e., removes the unread tag) if point enters the message at any time in a show buffer regardless of how point got there (mouse click, cursor command, page up/down, notmuch commands such as n,N etc). This fixes various anomalies or bugs in the previous handling. Additionally it is possible to customize the mark read handling by setting `notmuch-show-mark-read-function` to a custom function. Expanded default saved search settings The default saved searches now include several more common searches, as well as shortcut keys for `notmuch-jump`. Improved `q` binding in notmuch buffers `q` will now bury rather than kill a notmuch search, show or tree buffer if there are multiple windows showing the buffer. If only a single window is showing the buffer, it is killed. `notmuch-show-stash-mlarchive-link-alist` now supports functions Some list archives may use a more complicated scheme for referring to messages than just concatenated URL and message ID. For example, patchwork requires a query to translate message ID to a patchwork patch ID. `notmuch-show-stash-mlarchive-link-alist` now supports functions to better cover such cases. See the help documentation for the variable for details. Library changes --------------- Introduced database version 3 with support for "database features." Features are independent aspects of the database schema. Representing these independently of the database version number will let us evolve the database format faster and more incrementally, while maintaining better forwards and backwards compatibility. Library users are no longer required to call `notmuch_database_upgrade` Previously, library users were required to call `notmuch_database_needs_upgrade` and `notmuch_database_upgrade` before using a writable database. Even the CLI didn't get this right, and it is no longer required. Now, individual APIs may return `NOTMUCH_STATUS_UPGRADE_REQUIRED` if the database format is too out of date for that API. Library users can now abort an atomic section by closing the database Previously there was no supported way to abort an atomic section. Callers can now simply close the database, and any outstanding atomic section will be aborted. Add return status to `notmuch_database_close` and `notmuch_database_destroy` Bug fixes and performance improvements for thread linking The database now represents missing-but-referenced messages ("ghost messages") similarly to how it represents regular messages. This enables an improved thread linking algorithm that performs better and fixes a bug that sometimes prevented notmuch from linking messages into the same thread. nmbug ----- The Perl script has been translated to Python; you'll need Python 2.7 or anything from the 3.x line. Most of the user-facing interface is the same, but `nmbug help` is now `nmbug --help`, and the following nmbug commands have slightly different interfaces: `archive`, `commit`, `fetch`, `log`, `pull`, `push`, and `status`. For details on the new interface for a given command, run `nmbug COMMAND --help`. nmbug-status ------------ `nmbug-status` can now optionally load header and footer templates from the config file. Use something like: { "meta": { "header": "\n\n...", "footer": "", ... }, ... } Python Bindings --------------- Add support for `notmuch_query_add_tag_exclude` Build System ------------ The notmuch binaries and libraries are now build with debugging symbols by default. Users concerned with disk space should change the defaults when configuring or use the strip(1) command. Notmuch 0.18.2 (2014-10-25) =========================== Test Suite ---------- Translate T380-atomicity to use gdb/python The new version is compatible with gdb 7.8 Emacs 24.4 related bug fixes The Messages buffer became read-only, and the generated mime structure for signatures changed slightly. Simplify T360-symbol-hiding Replace the use of `objdump` on the object files with `nm` on the resulting lib. Notmuch 0.18.1 (2014-06-25) =========================== This is a bug fix and portability release. Build System ------------ Add a workaround for systems without zlib.pc Make emacs install robust against the non-existence of emacs Put notmuch lib directory first in RPATH Fix handling of `html_static_path` in sphinx Both the python bindings and the main docs had spurious settings of this variable. Test Suite ---------- Use --quick when starting emacs This avoids a hang in the T160-json tests. Allow pending break points in atomicity script This allows the atomicity tests to run on several more architectures/OSes. Command-Line Interface ---------------------- To improve portability use fsync instead of fdatasync in `notmuch-dump`. There should be no functional difference. Library changes --------------- Resurrect support for single-message mbox files The removal introduced a bug with previously indexed single-message mboxes. This support remains deprecated. Fix for phrase indexing There were several bugs where words intermingled from different headers and MIME parts could match a single phrase query. This fix will affect only newly indexed messages. Emacs Interface --------------- Make sure tagging on an empty query is harmless Previously tagging an empty query could lead to tags being unintentionally removed. Notmuch 0.18 (2014-05-06) ========================= Overview -------- This new release includes some enhancements to searching for messages by filesystem location (`folder:` and `path:` prefixes under *General* below). Saved searches in *Emacs* have also been enhanced to allow distinct search orders for each one. Another enhancement to the *Emacs* interface is that replies to encrypted messages are now encrypted, reducing the risk of unintentional information disclosure. The default dump output format has changed to the more robust `batch-tag` format. The previously deprecated parsing of single message mboxes has been removed. For detailed release notes, see below. General ------- The `folder:` search prefix now requires an exact match The `folder:` prefix has been changed to search for email messages by the exact, case sensitive maildir or MH folder name. Wildcard matching (`folder:foo*`) is no longer supported. The new behaviour allows for more accurate mail folder based searches, makes it possible to search for messages in the top-level folder, and should lead to less surprising results than the old behaviour. Users are advised to see the `notmuch-search-terms` manual page for details, and review how the change affects their existing `folder:` searches. There is a new `path:` search prefix The new `path:` search prefix complements the `folder:` prefix. The `path:` prefix searches for email messages that are in particular directories within the mail store, optionally recursively using a special syntax. See the `notmuch-search-terms` manual page for details. Notmuch database upgrade due to `folder:` and `path:` changes The above mentioned changes to the `folder:` prefix and the addition of `path:` prefix require a Notmuch database upgrade. This will be done automatically, without prompting on the next time `notmuch new` is run after the upgrade. The upgrade is not reversible, and the upgraded database will not be readable by older versions of Notmuch. As a safeguard, a database dump will be created in the `.notmuch` directory before upgrading. Library changes --------------- Notmuch database upgrade The libnotmuch consumers are reminded to handle database upgrades properly, either by relying on running `notmuch new`, or checking `notmuch_database_needs_upgrade()` and calling `notmuch_database_upgrade()` as necessary. This has always been the case, but in practise there have been no database upgrades in any released version of Notmuch before now. Support for indexing mbox files has been dropped There has never been proper support for mbox files containing multiple messages, and the support for single-message mbox files has been deprecated since Notmuch 0.15. The support has now been dropped, and all mbox files will be rejected during indexing. Message header parsing changes Notmuch previously had an internal parser for message headers. The parser has now been dropped in favour of letting GMime parse both the headers and the message MIME structure at the same pass. This is mostly an internal change, but the GMime parser is stricter in its interpretation of the headers. This may result in messages with slightly malformed message headers being now rejected. Command-Line Interface ---------------------- `notmuch dump` now defaults to `batch-tag` format The old format is still available with `--format=sup`. `notmuch new` has a --quiet option This option suppresses the progress and summary reports. `notmuch insert` respects maildir.synchronize_flags config option Do not synchronize tags to maildir flags in `notmuch insert` if the user does not want it. The commands set consistent exit status codes on failures The cli commands now consistently set exit status of 1 on failures, except where explicitly otherwise noted. The notable expections are the status codes for format version mismatches for commands that support formatted output. Bug fix for checking configured new.tags for invalid tags `notmuch new` and `notmuch insert` now check the user configured new.tags for invalid tags, and refuse to apply them, similar to `notmuch tag`. Invalid tags are currently the empty string and tags starting with `-`. Emacs Interface --------------- Init file If the file pointed by new variable `notmuch-init-file` (typically `~/.emacs.d/notmuch-config.el`) exists, it is loaded at the end of `notmuch.el`. Users can put their personal notmuch emacs lisp based configuration/customization items there instead of filling `~/.emacs` with these. Changed format for saved searches The format for `notmuch-saved-searches` has changed, but old style saved searches are still supported. The new style means that a saved search can store the desired sort order for the search, and it can store a separate query to use for generating the count notmuch shows. The variable is fully customizable and any configuration done through customize should *just work*, with the additional options mentioned above. For manual customization see the documentation for `notmuch-saved-searches`. IMPORTANT: a new style notmuch-saved-searches variable will break previous versions of notmuch-emacs (even search will not work); to fix remove the customization for notmuch-saved-searches. If you have a custom saved search sort function (not unsorted or alphabetical) then the sort function will need to be modified. Replacing (car saved-search) by (notmuch-saved-search-get saved-search :name) and (cdr saved-search) by (notmuch-saved-search-get saved-search :query) should be sufficient. The keys of `notmuch-tag-formats` are now regexps Previously, the keys were literal strings. Customized settings of `notmuch-tag-formats` will continue to work as before unless tags contain regexp special characters like `.` or `*`. Changed tags are now shown in the buffer Previously tag changes made in a buffer were shown immediately. In some cases (particularly automatic tag changes like marking read) this made it hard to see what had happened (e.g., whether the message had been unread). The changes are now shown explicitly in the buffer: by default deleted tags are displayed with red strike-through and added tags are displayed underlined in green (inverse video is used for deleted tags if the terminal does not support strike-through). The variables `notmuch-tag-deleted-formats` and `notmuch-tag-added-formats`, which have the same syntax as `notmuch-tag-formats`, allow this to be customized. Setting `notmuch-tag-deleted-formats` to `'((".*" nil))` and `notmuch-tag-added-formats` to `'((".*" tag))` will give the old behavior of hiding deleted tags and showing added tags identically to tags already present. Version variable The new, build-time generated variable `notmuch-emacs-version` is used to distinguish between notmuch cli and notmuch emacs versions. The function `notmuch-hello-versions` (bound to 'v' in notmuch-hello window) prints both notmuch cli and notmuch emacs versions in case these differ from each other. This is especially useful when using notmuch remotely. Ido-completing-read initialization in Emacs 23 `ido-completing-read` in Emacs 23 versions 1 through 3 freezes unless it is initialized. Defadvice-based *Ido* initialization is defined for these Emacs versions. Bug fix for saved searches with newlines in them Split lines confuse `notmuch count --batch`, so we remove embedded newlines before calling notmuch count. Bug fixes for sender identities Previously, Emacs would rewrite some sender identities in unexpected and undesirable ways. Now it will use identities exactly as configured in `notmuch-identities`. Replies to encrypted messages will be encrypted by default In the interest of maintaining confidentiality of communications, the Notmuch Emacs interface now automatically adds the mml tag to encrypt replies to encrypted messages. This should make it less likely to accidentally reply to encrypted messages in plain text. Reply pushes mark before signature We push mark and set point on reply so that the user can easily cut the quoted text. The mark is now pushed before the signature, if any, instead of end of buffer so the signature is preserved. Message piping uses the originating buffer's working directory `notmuch-show-pipe-message` now uses the originating buffer's current default directory instead of that of the `*notmuch-pipe*` buffer's. nmbug ----- nmbug adds a `clone` command for setting up the initial repository and uses `@{upstream}` instead of `FETCH_HEAD` to track upstream changes. The `@{upstream}` change reduces ambiguity when fetching multiple branches, but requires existing users update their `NMBGIT` repository (usually `~/.nmbug`) to distinguish between local and remote-tracking branches. The easiest way to do this is: 1. If you have any purely local commits (i.e. they aren't in the nmbug repository on nmbug.tethera.net), push them to a remote repository. We'll restore them from the backup in step 4. 2. Remove your `NMBGIT` repository (e.g. `mv .nmbug .nmbug.bak`). 3. Use the new `clone` command to create a fresh clone: nmbug clone http://nmbug.tethera.net/git/nmbug-tags.git 4. If you had local commits in step 1, add a remote for that repository and fetch them into the new repository. Notmuch 0.17 (2013-12-30) ========================= Incompatible change in SHA1 computation --------------------------------------- Previously on big endian architectures like sparc and powerpc the computation of SHA1 hashes was incorrect. This meant that messages with overlong or missing message-ids were given different computed message-ids than on more common little endian architectures like i386 and amd64. If you use notmuch on a big endian architecture, you are strongly advised to make a backup of your tags using `notmuch dump` before this upgrade. You can locate the affected files using something like: notmuch dump | \ awk '/^notmuch-sha1-[0-9a-f]{40} / \ {system("notmuch search --exclude=false --output=files id:" $1)}' Command-Line Interface ---------------------- New options to better support handling duplicate messages If more than one message file is associated with a message-id, `notmuch search --output=files` will print all of them. A new `--duplicate=N` option can be used to specify which duplicate to print for each message. `notmuch count` now supports `--output=files` option to output the number of files associated with matching messages. This may be bigger than the number of matching messages due to duplicates (i.e. multiple files having the same message-id). Improved `notmuch new` performance for unchanged folders `notmuch new` now skips over unchanged folders more efficiently, which can substantially improve the performance of checking for new mail in some situations (like NFS-mounted Maildirs). `notmuch reply --format=text` RFC 2047-encodes headers Previously, this used a mix of standard MIME encoding for the reply body and UTF-8 for the headers. Now, the text format reply template RFC 2047-encodes the headers, making the output a valid RFC 2822 message. The JSON/sexp format is unchanged. `notmuch compact` command The new `compact` command exposes Xapian's compaction functionality through a more convenient interface than `xapian-compact`. `notmuch compact` will compact the database to a temporary location, optionally backup the original database, and move the compacted database into place. Emacs Interface --------------- `notmuch-tree` (formerly `notmuch-pick`) has been added to mainline `notmuch-tree` is a threaded message view for the emacs interface. Each message is one line in the results and the thread structure is shown using UTF-8 box drawing characters (similar to Mutt's threaded view). It comes between search and show in terms of amount of output and can be useful for viewing both single threads and multiple threads. Using `notmuch-tree` The main key entries to notmuch tree are 'z' enter a query to view using notmuch tree (works in hello, search, show and tree mode itself) 'Z' view the current query in tree notmuch tree (works from search and show) Once in tree mode, keybindings are mostly in line with the rest of notmuch and are all viewable with '?' as usual. Customising `notmuch-tree` `notmuch-tree` has several customisation variables. The most significant is the first notmuch-tree-show-out which determines the behaviour when selecting a message (with RET) in tree view. By default tree view uses a split window showing the single message in the bottom pane. However, if this option is set then it views the whole thread in the complete window jumping to the selected message in the thread. In either case command-prefix selects the other option. Tagging threads in search is now race-free Previously, adding or removing a tag from a thread in a search buffer would affect messages that had arrived after the search was performed, resulting in, for example, archiving messages that were never seen. Tagging now affects only the messages that were in the thread when the search was performed. `notmuch-hello` refreshes when switching to the buffer The hello buffer now refreshes whenever you switch to the buffer, regardless of how you get there. You can disable automatic refreshing by customizing `notmuch-hello-auto-refresh`. Specific mini-buffer prompts for tagging operations When entering tags to add or remove, the mini-buffer prompt now indicates what operation will be performed (e.g., "Tag thread", "Tag message", etc). Built-in help improvements Documentation for many commands has been improved, as displayed by `notmuch-help` (usually bound to "?"). The bindings listed by `notmuch-help` also now include descriptions of prefixed commands. Quote replies as they are displayed in show view We now render the parts for reply quoting the same way they are rendered for show. At this time, the notable change is that replies to text/calendar are now pretty instead of raw vcalendar. Fixed inconsistent use of configured search order All ways of interactively invoking search now honor the value of `notmuch-search-oldest-first`. Common keymap for notmuch-wide bindings Several key bindings have been moved from mode-specific keymaps to the single `notmuch-common-keymap`, which is inherited by each notmuch mode. If you've customized your key bindings, you may want to move some of them to the common keymap. The `notmuch-tag` function now requires a list of tag changes For users who have scripted the Emacs interface: the `notmuch-tag` API has changed. Previously, it accepted either a list of tag changes or a space-separated string of tag changes. The latter is no longer supported and the function now returns nothing. Fixed `notmuch-reply` putting reply in primary selection On emacs 24 notmuch-reply used to put the cited text into the primary selection (which could lead to inadvertently pasting this cited text elsewhere). Now the primary-selection is not changed. Fixed `notmuch-show` invisible part handling In some obscure cases part buttons and invisibility had strange interactions: in particular, the default action for some parts gave the wrong action. This has been fixed. Fixed `notmuch-show` attachment viewers and stderr In emacs 24.3+ viewing an attachment could cause spurious text to appear in the show buffer (any stderr or stdout the viewer produced). By default this output is now discarded. For debugging, setting `notmuch-show-attachment-debug` causes notmuch to keep the viewer's stderr and stdout in a separate buffer. Fixed `notmuch-mua-reply` point placement when signature involved By restricting cursor movement to body section for cursor placement after signature is inserted, the cursor cannot "leak" to header section anymore. Now inserted citation content will definitely go to the body part of the message. Vim Interface ------------- It is now possible to compose new messages in the Vim interface, as opposed reply to existing messages. There is also support for going straight to a search (bypassing the folders view). Notmuch 0.16 (2013-08-03) ========================= Command-Line Interface ---------------------- Support for delivering messages to Maildir There is a new command `insert` that adds a message to a Maildir folder and notmuch index. `notmuch count --batch` option `notmuch count` now supports batch operations similar to `notmuch tag`. This is mostly an optimization for remote notmuch usage. `notmuch tag` option to remove all tags from matching messages `notmuch tag --remove-all` option has been added to remove all tags from matching messages. This can be combined with adding new tags, resulting in setting (rather than modifying) the tags of the messages. Decrypting commands explicitly expect a gpg-agent Decryption in `notmuch show` and `notmuch reply` has only ever worked with a functioning gpg-agent. This is now made explicit in code and documentation. The functional change is that it's now possible to have gpg-agent running, but gpg "use-agent" configuration option disabled, not forcing the user to use the agent everywhere. Configuration file saves follow symbolic links The notmuch commands that save the configuration file now follow symbolic links instead of overwrite them. Top level option to specify configuration file It's now possible to specify the configuration file to use on the command line using the `notmuch --config=FILE` option. Bash command-line completion The notmuch command-line completion support for the bash shell has been rewritten. Supported completions include all the notmuch commands, command-line arguments, values for keyword arguments, search prefixes (such as "subject:" or "from:") in all commands that use search terms, tags after + and - in `notmuch tag`, tags after "tag:" prefix, user's email addresses after "from:" and "to:" prefixes, and config options (and some config option values) in `notmuch config`. The new completion support depends on the bash-completion package. Deprecated commands "part" and "search-tags" are removed. Emacs Interface --------------- New keymap to view/save parts; removed s/v/o/| part button bindings The commands to view, save, and open MIME parts are now prefixed with "." (". s" to save, ". v" to view, etc) and can be invoked with point anywhere in a part, unlike the old commands, which were restricted to part buttons. The old "s"/"v"/"o"/"|" commands on part buttons have been removed since they clashed with other bindings (notably "s" for search!) and could not be invoked when there was no part button. The new, prefixed bindings appear in show's help, so you no longer have to memorize them. Default part save directory is now `mm-default-directory` Previously, notmuch offered to save parts and attachments to a mix of `mm-default-directory`, `mailcap-download-directory`, and `~/`. This has been standardized on `mm-default-directory`. Key bindings for next/previous thread Show view has new key bindings M-n and M-p to move to the next and previous thread in the search results. Better handling of errors in search buffers Instead of interleaving errors in search result buffers, search mode now reports errors in the minibuffer. Faster search and show Communication between Emacs and the notmuch CLI is now more efficient because it uses the CLI's S-expression support. As a result, search mode should now fill search buffers faster and threads should show faster. No Emacs 22 support The Emacs 22 support added late 2010 was sufficient only for a short period of time. After being incomplete for roughly 2 years the code in question was now removed from this release. Vim Front-End ------------- The vim based front-end has been replaced with a new one that uses the Ruby bindings. The old font-end is available in the contrib subfolder. Python Bindings --------------- Fix loading of libnotmuch shared library on OS X (Darwin) systems. Notmuch 0.15.2 (2013-02-17) =========================== Build fixes ----------- Update dependencies to avoid problems when building in parallel. Internal test framework changes ------------------------------- Adjust Emacs test watchdog mechanism to cope with `process-attributes` being unimplemented. Notmuch 0.15.1 (2013-01-24) =========================== Internal test framework changes ------------------------------- Set a default value for TERM when running tests. This fixes certain build failures in non-interactive environments. Notmuch 0.15 (2013-01-18) ========================= General ------- Date range search support The `date:` prefix can now be used in queries to restrict the results to only messages within a particular time range (based on the Date: header) with a range syntax of `date:..`. Notmuch supports a wide variety of expressions in `` and ``. Please refer to the `notmuch-search-terms(7)` manual page for details. Empty tag names and tags beginning with "-" are deprecated Such tags have been a frequent source of confusion and cause (sometimes unresolvable) conflicts with other syntax. notmuch tag no longer allows such tags to be added to messages. Removing such tags continues to be supported to allow cleanup of existing tags, but may be removed in a future release. Command-Line Interface ---------------------- `notmuch new` no longer chokes on mboxes `notmuch new` now rejects mbox files containing more than one message, rather than treating the file as one giant message. Support for single message mboxes is deprecated For historical reasons, `notmuch new` will index mbox files containing a single message; however, this behavior is now officially deprecated. Fixed `notmuch new` to skip ignored broken symlinks `notmuch new` now correctly skips symlinks if they are in the ignored files list. Previously, it would abort when encountering broken symlink, even if it was ignored. New dump/restore format and tagging interface There is a new `batch-tag` format for dump and restore that is more robust, particularly with respect to tags and message-ids containing whitespace. `notmuch tag` now supports the ability to read tag operations and queries from an input stream, in a format compatible with the new dump/restore format. Bcc and Reply-To headers are now available in notmuch show json output The `notmuch show --format=json` now includes "Bcc" and "Reply-To" headers. For example notmuch Emacs client can now have these headers visible when the headers are added to the `notmuch-message-headers` variable. CLI callers can now request a specific output format version `notmuch` subcommands that support structured output now support a `--format-version` argument for requesting a specific version of the structured output, enabling better compatibility and error handling. `notmuch search` has gained a null character separated text output format The new --format=text0 output format for `notmuch search` prints output separated by null characters rather than newline characters. This is similar to the find(1) -print0 option, and works together with the xargs(1) -0 option. Emacs Interface --------------- Removal of the deprecated `notmuch-folders` variable `notmuch-folders` has been deprecated since the introduction of saved searches and the notmuch hello view in notmuch 0.3. `notmuch-folders` has now been removed. Any remaining users should migrate to `notmuch-saved-searches`. Visibility of MIME parts can be toggled Each part of a multi-part MIME email can now be shown or hidden using the button at the top of each part (by pressing RET on it or by clicking). For emails with multiple alternative formats (e.g., plain text and HTML), only the preferred format is shown initially, but other formats can be shown using their part buttons. To control the behavior of this, see `notmuch-multipart/alternative-discouraged` and `notmuch-show-all-multipart/alternative-parts`. Note notmuch-show-print-message (bound to '#' by default) will print all parts of multipart/alternative message regardless of whether they are currently hidden or shown in the buffer. Emacs now buttonizes mid: links mid: links are a standardized way to link to messages by message ID (see RFC 2392). Emacs now hyperlinks mid: links to the appropriate notmuch search. Handle errors from bodypart insertions If displaying the text of a message in show mode causes an error (in the `notmuch-show-insert-part-*` functions), notmuch no longer cuts off thread display at the offending message. The error is now simply displayed in place of the message. Emacs now detects version mismatches with the notmuch CLI Emacs now detects and reports when the Emacs interface version and the notmuch CLI version are incompatible. Improved text/calendar content handling Carriage returns in embedded text/calendar content caused insertion of the calendar content fail. Now CRs are removed before calling icalendar to extract icalendar data. In case icalendar extraction fails an error is thrown for the bodypart insertion function to deal with. Disabled coding conversions when reading in `with-current-notmuch-show-message` Depending on the user's locale, saving attachments containing 8-bit data may have performed an unintentional encoding conversion, corrupting the saved attachment. This has been fixed by making `with-current-notmuch-show-message` disable coding conversion. Fixed errors with HTML email containing images in Emacs 24 Emacs 24 ships with a new HTML renderer that produces better output, but is slightly buggy. We work around a bug that caused it to fail for HTML email containing images. Fixed handling of tags with unusual characters in them Emacs now handles tags containing spaces, quotes, and parenthesis. Fixed buttonization of id: links without quote characters Emacs now correctly buttonizes id: links where the message ID is not quoted. `notmuch-hello` refresh point placement improvements Refreshing the `notmuch-hello` buffer does a better job of keeping the point where it was. Automatic tag changes are now unified and customizable All the automatic tag changes that the Emacs interface makes when reading, archiving, or replying to messages, can now be customized. Any number of tag additions and removals is supported through the `notmuch-show-mark-read`, `notmuch-archive-tags`, and `notmuch-message-replied-tags` customization variables. Support for stashing the thread id in show view Invoking `notmuch-show-stash-message-id` with a prefix argument stashes the (local and database specific) thread id of the current thread instead of the message id. New add-on tool: notmuch-pick ----------------------------- The new contrib/ tool `notmuch-pick` is an experimental threaded message view for the emacs interface. Each message is one line in the results and the thread structure is shown using UTF-8 box drawing characters (similar to Mutt's threaded view). It comes between search and show in terms of amount of output and can be useful for viewing both single threads and multiple threads. See the notmuch-pick README file for further details and installation. Portability ----------- notmuch now builds on OpenBSD. Internal test framework changes ------------------------------- The emacsclient binary is now user-configurable The test framework now accepts `TEST_EMACSCLIENT` in addition to `TEST_EMACS` for configuring the emacsclient to use. This is necessary to avoid using an old emacsclient with a new emacs, which can result in buggy behavior. Notmuch 0.14 (2012-08-20) ========================= General bug fixes ----------------- Maildir tag synchronization Maildir flag-to-tag synchronization now applies only to messages in maildir-like directory structures. Previously, it applied to any message that had a maildir "info" part, which meant it could incorrectly synchronize tags for non-maildir messages, while at the same time failing to synchronize tags for newly received maildir messages (typically causing new messages to not receive the "unread" tag). Command-Line Interface ---------------------- The deprecated positional output file argument to `notmuch dump` has been replaced with an `--output` option. The input file positional argument to `notmuch restore` has been replaced with an `--input` option for consistency with dump. These changes simplify the syntax of dump/restore options and make them more consistent with other notmuch commands. Emacs Interface --------------- Search results now get re-colored when tags are updated The formatting of tags in search results can now be customized Previously, attempting to change the format of tags in `notmuch-search-result-format` would usually break tagging from search-mode. We no longer make assumptions about the format. Experimental support for multi-line search result formats It is now possible to embed newlines in `notmuch-search-result-format` to make individual search results span multiple lines. Next/previous in search and show now move by boundaries All "next" and "previous" commands in the search and show modes now move to the next/previous result or message boundary. This doesn't change the behavior of "next", but "previous" commands will first move to the beginning of the current result or message if point is inside the result or message. Search now uses the JSON format internally This should address problems with unusual characters in authors and subject lines that could confuse the old text-based search parser. The date shown in search results is no longer padded before applying user-specified formatting Previously, the date in the search results was padded to fixed width before being formatted with `notmuch-search-result-format`. It is no longer padded. The default format has been updated, but if you've customized this variable, you may have to change your date format from `"%s "` to `"%12s "`. The thread-id for the `target-thread` argument for `notmuch-search` should now be supplied without the "thread:" prefix. Notmuch 0.13.2 (2012-06-02) =========================== Bug-fix release --------------- Update `contrib/notmuch-deliver` for API changes in 0.13. This fixes a compilation error for this contrib package. Notmuch 0.13.1 (2012-05-29) =========================== Bug-fix release --------------- Fix inserting of UTF-8 characters from *text/plain* parts in reply While notmuch gained ability to insert content from other than *text/plain* parts of email whenever *text/plain* parts are not available (notably HTML-only emails), replying to mails that do have *text/plain* the non-ASCII characters were incorrectly decoded. This is now fixed. `notmuch_database_get_directory` and `notmuch_database_find_message_by_filename` now work on read-only databases Previously, these functions attempted to create directory documents that didn't exist and would return an error or abort when given a read-only database. Now they no longer create directory documents and simply return a `NULL` object if the directory does not exist, as documented. Fix compilation of ruby bindings Revert to dynamic linking, since the statically linked bindings did not work well. Notmuch 0.13 (2012-05-15) ========================= Command-Line Interface ---------------------- JSON reply format `notmuch reply` can now produce JSON output that contains the headers for a reply message and full information about the original message begin replied to. This allows MUAs to create replies intelligently. For example, an MUA that can parse HTML might quote HTML parts. Calling notmuch reply with `--format=json` imposes the restriction that only a single message is returned by the search, as replying to multiple messages does not have a well-defined behavior. The default retains its current behavior for multiple message replies. Tag exclusion Tags can be automatically excluded from search results by adding them to the new `search.exclude_tags` option in the Notmuch config file. This behaviour can be overridden by explicitly including an excluded tag in your query, for example: notmuch search $your_query and tag:$excluded_tag Existing users will probably want to run `notmuch setup` again to add the new well-commented [search] section to the configuration file. For new configurations, accepting the default setting will cause the tags "deleted" and "spam" to be excluded, equivalent to running: notmuch config set search.exclude_tags deleted spam Raw show format changes The output of show `--format=raw` has changed for multipart and message parts. Previously, the output was a mash of somewhat-parsed headers and transfer-decoded bodies. Now, such parts are reproduced faithfully from the original source. Message parts (which includes part 0) output the full message, including the message headers (but not the transfer headers). Multipart parts output the part as encoded in the original message, including the part's headers. Leaf parts, as before, output the part's transfer-decoded body. Listing configuration items The new `config list` command prints out all configuration items and their values. Emacs Interface --------------- Changes to tagging interface The user-facing tagging functions in the Emacs interface have been normalized across all notmuch modes. The tagging functions are now notmuch-search-tag in search-mode, and notmuch-show-tag in show-mode. They accept a string representing a single tag change, or a list of tag changes. See 'M-x describe-function notmuch-tag' for more information. NOTE: This breaks compatibility with old tagging functions, so user may need to update in custom configurations. Reply improvement using the JSON format Emacs now uses the JSON reply format to create replies. It obeys the customization variables message-citation-line-format and message-citation-line-function when creating the first line of the reply body, and it will quote HTML parts if no text/plain parts are available. New add-on tool: notmuch-mutt ----------------------------- The new contrib/ tool `notmuch-mutt` provides Notmuch integration for the Mutt mail user agent. Using it, Mutt users can perform mail search, thread reconstruction, and mail tagging/untagging without leaving Mutt. notmuch-mutt, formerly distributed under the name `mutt-notmuch` by Stefano Zacchiroli, will be maintained as a notmuch contrib/ from now on. Library changes --------------- The API changes detailed below break binary and source compatibility, so libnotmuch has been bumped to version 3.0.0. The function `notmuch_database_close` has been split into `notmuch_database_close` and `notmuch_database_destroy` This makes it possible for long running programs to close the xapian database and thus release the lock associated with it without destroying the data structures obtained from it. `notmuch_database_open`, `notmuch_database_create`, and `notmuch_database_get_directory` now return errors The type signatures of these functions have changed so that the functions now return a `notmuch_status_t` and take an out-argument for returning the new database object or directory object. Go bindings changes ------------------- Go 1 compatibility The go bindings and the `notmuch-addrlookup` utility are now compatible with go 1. Notmuch 0.12 (2012-03-20) ========================= Command-Line Interface ---------------------- Reply to sender `notmuch reply` has gained the ability to create a reply template for replying just to the sender of the message, in addition to reply to all. The feature is available through the new command line option `--reply-to=(all|sender)`. Mail store folder/file ignore A new configuration option, `new.ignore`, lets users specify a ;-separated list of file and directory names that will not be searched for messages by `notmuch new`. NOTE: *Every* file/directory that goes by one of those names will be ignored, independent of its depth/location in the mail store. Unified help and manual pages The notmuch help command now runs man for the appropriate page. If you install notmuch somewhere "unusual", you may need to update MANPATH. Manual page for notmuch configuration options The notmuch CLI configuration file options are now documented in the notmuch-config(1) manual page in addition to the configuration file itself. Emacs Interface --------------- Reply to sender The Emacs interface has, with the new CLI support, gained the ability to reply to sender in addition to reply to all. In both show and search modes, 'r' has been bound to reply to sender, replacing reply to all, which now has key binding 'R'. More flexible and consistent tagging operations All tagging operations ('+', '-', '*') now accept multiple tags with '+' or '-' prefix, like '*' operation in notmuch-search view before. '*' operation (`notmuch-show-tag-all`) is now available in notmuch-show view. `notmuch-show-{add,remove}-tag` functions no longer accept tag argument, `notmuch-show-tag-message` should be used instead. Custom bindings using these functions should be updated, e.g.: (notmuch-show-remove-tag "unread") should be changed to: (notmuch-show-tag-message "-unread") Refreshing the show view ('=' by default) no longer opens or closes messages To get the old behavior of putting messages back in their initial opened/closed state, use a prefix argument, e.g., 'C-u ='. Attachment buttons can be used to view or save attachments. When the cursor is on an attachment button the key 's' can be used to save the attachment, the key 'v' to view the attachment in the default mailcap application, and the key 'o' prompts the user for an application to use to open the attachment. By default Enter or mouse button 1 saves the attachment but this is customisable (option Notmuch Show Part Button Default Action). New functions `notmuch-show-stash-mlarchive-link{,-and-go}` allow stashing and optionally visiting a URI to the current message at one of a number of Mailing List Archives. Fix MML tag quoting in replies The MML tag quoting fix of 0.11.1 unintentionally quoted tags inserted in `message-setup-hook`. Quoting is now limited to the cited message. Show view archiving key binding changes The show view archiving key bindings 'a' and 'x' now remove the "inbox" tag from the current message only (instead of thread), and move to the next message. At the last message, 'a' proceeds to the next thread in search results, and 'x' returns to search results. The thread archiving functions are now available in 'A' and 'X'. Support text/calendar MIME type The text/calendar MIME type is now supported in addition to text/x-vcalendar. Generate inline patch fake attachment file names from message subject Use the message subject to generate file names for the inline patch fake attachments. The names are now similar to the ones generated by 'git format-patch' instead of just "inline patch". See "Notmuch Show Insert Text/Plain Hook" in the notmuch customize interface. Enable `notmuch-search-line-faces` by default Make the `notmuch-search-line-faces` functionality more discoverable for new users by showing "unread" messages bold and "flagged" messages blue by default in the search view. Printing Support notmuch-show mode now has simple printing support, bound to '#' by default. You can customize the variable notmuch-print-mechanism. Library changes --------------- New functions `notmuch_query_add_tag_exclude` supports the new tag exclusion feature. Python bindings changes ----------------------- Python 3.2 compatibility The python bindings are now compatible with both python 2.5+ and 3.2. Added missing unicode conversions Python strings have to be encoded to and decoded from utf-8 when calling libnotmuch functions. Porting the bindings to python 3.2 revealed a few function calls that were missing these conversions. Build fixes ----------- Compatibility with GMime 2.6 It is now possible to build notmuch against both GMime 2.4 and 2.6. However, a bug in GMime 2.6 before 2.6.5 causes notmuch not to report signatures where the signer key is unavailable (GNOME bug 668085). For compatibility with GMime 2.4's tolerance of "From " headers we require GMime 2.6 >= 2.6.7. Notmuch 0.11.1 (2012-02-03) =========================== Bug-fix release --------------- Fix error handling in python bindings The python bindings in 0.11 failed to detect NULL pointers being returned from libnotmuch functions and thus failed to raise exceptions to indicate the error condition. Any subsequent calls into libnotmuch caused segmentation faults. Quote MML tags in replies MML tags are text codes that Emacs uses to indicate attachments (among other things) in messages being composed. The Emacs interface did not quote MML tags in the quoted text of a reply. User could be tricked into replying to a maliciously formatted message and not editing out the MML tags from the quoted text. This could lead to files from the user's machine being attached to the outgoing message. The Emacs interface now quotes these tags in reply text, so that they do not effect outgoing messages. Notmuch 0.11 (2012-01-13) ========================= Command-Line Interface ---------------------- Hooks Hooks have been introduced to notmuch. Hooks are scripts that notmuch invokes before and after certain actions. Initially, `notmuch new` supports `pre-new` and `post-new` hooks that are run before and after importing new messages into the database. `notmuch reply --decrypt bugfix` The `notmuch reply` command with `--decrypt` argument had a rarely occurring bug that caused an encrypted message not to be decrypted sometimes. This is now fixed. Performance ----------- Automatic tag query optimization `notmuch tag` now automatically optimizes the user's query to exclude messages whose tags won't change. In the past, we've suggested that people do this by hand; this is no longer necessary. Don't sort messages when creating a dump file This speeds up tag dumps considerably, without any loss of information. To replicate the old behavior of sorted output (for example to compare two dump files), one can use e.g. `sort(1)`. Memory Management ----------------- Reduction of memory leaks Two memory leaks when searching and showing messages were identified and fixed in this release. Emacs Interface --------------- Bug fixes notmuch-show-advance (bound to the spacebar in notmuch-show-mode) had a bug that caused it to always jump to the next message, even if it should have scrolled down to show more of the current message instead. This is now fixed. Support `notmuch new` as a notmuch-poll-script It's now possible to use `notmuch new` as a notmuch-poll-script directly. This is also the new default. This allows taking better advantage of the `notmuch new` hooks from emacs without intermediate scripts. Improvements in saved search management New saved searches are now appended to the list of saved searches, not inserted in front. It's also possible to define a sort function for displaying saved searches; alphabetical sort is provided. Hooks for notmuch-hello Two new hooks have been added: "notmuch-hello-mode-hook" (called after entering notmuch-hello-mode) and "notmuch-hello-refresh-hook" (called after updating a notmuch-hello buffer). New face for crypto parts headers Crypto parts used to be displayed with a hardcoded color. A new face has been introduced to fix this: notmuch-crypto-part-header. It defaults to the same value as before, but can be customized to match other color themes. Use space as default thousands separator Large numbers in notmuch-hello are now displayed using a space as thousands separator (e.g. "123 456" instead of "123,456"). This can be changed by customizing "notmuch-hello-thousands-separator". Call notmuch-show instead of notmuch-search when clicking on buttonized id: links New function notmuch-show-advance This new function advances through just the current thread, and is less invasive than notmuch-show-advance-and-archive. It can easily be bound to SPC with: (define-key notmuch-show-mode-map " " 'notmuch-show-advance) Various performance improvements New add-on tool --------------- The tool `contrib/notmuch-deliver` helps with initial delivery and tagging of mail (replacing running `notmuch new`). Notmuch 0.10.2 (2011-12-04) =========================== Bug-fix release --------------- Fix crash in python bindings The python bindings did not call `g_type_init`, which caused crashes for some, but not all users. Notmuch 0.10.1 (2011-11-25) =========================== Bug-fix release --------------- Fix `--help` argument Argument processing changes in 0.10 introduced a bug where `notmuch --help` crashed while `notmuch help` worked fine. This is fixed in 0.10.1. Notmuch 0.10 (2011-11-23) ========================= New build and testing features ------------------------------ Emacs tests are now done in `dtach`. This means that dtach is now needed to run the notmuch test suite, at least until the checking for prerequisites is improved. Full test coverage of the stashing feature in Emacs. New command-line features ------------------------- Add `notmuch restore --accumulate` option The `--accumulate` switch causes the union of the existing and new tags to be applied, instead of replacing each message's tags as they are read in from the dump file. Add search terms to `notmuch dump` The dump command now takes an optional search term much like notmuch search/show/tag. The output file argument of dump is deprecated in favour of using stdout. Add `notmuch search` `--offset` and `--limit` options The search command now takes options `--offset=[-]N` and `--limit=N` to limit the number of results shown. Add `notmuch count --output` option The count command is now capable of counting threads in addition to messages. This is selected using the new `--output=(threads|messages)` option. New emacs UI features --------------------- Add tab-completion for `notmuch-search` and `notmuch-search-filter` These functions now support completion tags for query parts starting with "tag:". Turn "id:MSG-ID" links into buttons associated with notmuch searches Text of the form "id:MSG-ID" in mails is now a clickable button that opens a notmuch search for the given message id. Add keybinding ('c I') for stashing Message-ID's without an id: prefix Reduces manual labour when stashing them for use outside notmuch. Do not query on `notmuch-search` exit It is harmless to kill the external notmuch process, so the user is no longer interrogated when they interrupt a search. Performance ----------- Emacs now constructs large search buffers more efficiently Search avoids opening and parsing message files We now store more information in the database so search no longer has to open every message file to get basic headers. This can improve search speed by as much as 10X, but taking advantage of this requires a database rebuild: notmuch dump > notmuch.dump # Backup, then remove notmuch database ($MAIL/.notmuch) notmuch new notmuch restore notmuch.dump New collection of add-on tools ------------------------------ The source directory "contrib" contains tools built on notmuch. These tools are not part of notmuch, and you should check their individual licenses. Feel free to report problems with them to the notmuch mailing list. nmbug - share tags with a given prefix nmbug helps maintain a git repo containing all tags with a given prefix (by default "notmuch::"). Tags can be shared by commiting them to git in one location and restoring in another. Notmuch 0.9 (2011-10-01) ======================== New, general features --------------------- Correct handling of interruptions during `notmuch new` `notmuch new` now operates as a series of small, self-consistent transactions, so it can correctly resume after an interruption or crash. Previously, interruption could lose existing tags, fail to detect messages on resume, or leave the database in a state temporarily or permanently inconsistent with the mail store. Library changes --------------- New functions `notmuch_database_begin_atomic` and `notmuch_database_end_atomic` allow multiple database operations to be performed atomically. `notmuch_database_find_message_by_filename` does exactly what it says. API changes `notmuch_database_find_message` (and `n_d_f_m_by_filename`) now return a status indicator and uses an output parameter for the message. This change required changing the SONAME of libnotmuch to libnotmuch.so.2 Python bindings changes ----------------------- - Re-encode python unicode objects to utf-8 before passing back to libnotmuch. - Support `Database().begin_atomic()/end_atomic()` - Support `Database().find_message_by_filename()` NB! This needs a db opened in READ-WRITE mode currently, or it will crash the python process. The is a limitation (=bug) of the underlying libnotmuch. - Fixes where we would not throw NotmuchErrors when we should (Justus Winter) - Update for `n_d_find_message*` API changes (see above). Ruby bindings changes --------------------- - Wrap new library functions `notmuch_database_{begin,end}_atomic.` - Add new exception `Notmuch::UnbalancedAtomicError.` - Rename destroy to destroy! according to Ruby naming conventions. - Update for `n_d_find_message*` API changes (see above). Emacs improvements ------------------ * Add gpg callback to crypto sigstatus buttons to retrieve/refresh signing key. * Add `notmuch-show-refresh-view` function (and corresponding binding) to refresh the view of a notmuch-show buffer. Reply formatting cleanup ------------------------ `notmuch reply` no longer includes notification that non-leafnode MIME parts are being suppressed. Notmuch 0.8 (2011-09-10) ======================== Improved handling of message/rfc822 parts Both in the CLI and the emacs interface. Output of rfc822 parts now includes the primary headers, as well as the body and all subparts. Output of the completely raw rfc822-formatted message, including all headers, is unfortunately not yet supported (but hopefully will be soon). Improved Build system portability Certain parts of the shell script generating notmuch.sym were specific to the GNU versions of sed and nm. The new version should be more portable to e.g. OpenBSD. Documentation update for Ruby bindings Added documentation, typo fixes, and improved support for rdoc. Unicode, iterator, PEP8 changes for python bindings - PEP8 (code formatting) changes for python files. - Remove `Tags.__len__` ; see 0.6 release notes for motivation. - Decode headers as UTF8, encode (unicode) database paths as UTF8. Notmuch 0.7 (2011-08-01) ======================== Vim interface improvements -------------------------- Jason Woofenden provided a number of bug fixes for the Vim interface * fix citation/signature fold lengths * fix cig/cit parsing within multipart/* * fix on-screen instructions for show-signature * fix from list reformatting in search view * fix space key: now archives (did opposite) Uwe Kleine-König contributed * use full path for sendmail/doc fix * fix compose temp file name Python Bindings changes ----------------------- Sebastian Spaeth contributed two changes related to unicode and UTF8: * message tags are now explicitly unicode * query string is encoded as a UTF8 byte string Build-System improvements ------------------------- Generate notmuch.sym after the relevant object files This fixes a bug in parallel building. Thanks to Thomas Jost for the patch. Notmuch 0.6.1 (2011-07-17) ========================== Bug-fix release --------------- Re-export Xapian exception typeinfo symbols It turned out our aggressive symbol hiding caused problems for people running gcc 4.4.5. Notmuch 0.6 (2011-07-01) ======================= New, general features --------------------- Folder-based searching Notmuch queries can now include a search term to match the directories in which mail files are stored (within the mail storage). The syntax is as follows: folder: For example, one might use things such as: folder:spam folder:2011-* folder:work/todo to match any path containing a directory "spam", "work/todo", or containing a directory starting with "2011-", respectively. This feature is particularly useful for users of delivery-agent software (such as procmail or maildrop) that is filtering mail and delivering it to particular folders, or users of systems such as Gmail that use filesystem directories to indicate message tags. NOTE: Only messages that are newly indexed with this version of notmuch will be searchable with folder: terms. In order to enable this feature for all mail, the entire notmuch index will need to be rebuilt as follows: notmuch dump > notmuch.dump # Backup, then remove notmuch database ($MAIL/.notmuch) notmuch new notmuch restore notmuch.dump Support for PGP/MIME Both the command-line interface and the emacs-interface have new support for PGP/MIME, detailed below. Thanks to Daniel Kahn Gillmor and Jameson Graef Rollins for making this happen. New, automatic tags: "signed" and "encrypted" These tags will automatically be applied to messages containing multipart/signed and multipart/encrypted parts. NOTE: Only messages that are newly indexed with this version of notmuch will receive these tags. New command-line features ------------------------- Add new "notmuch show --verify" option for signature verification This option instruct notmuch to verify the signature of PGP/MIME-signed parts. Add new "notmuch show --decrypt" and "notmuch reply --decrypt" options This option instructs notmuch to decrypt PGP/MIME-encrypted parts. Note that this feature currently requires gpg-agent and a passphrase entry tool (e.g. pinentry-gtk or pinentry-curses). Proper nesting of multipart parts in "notmuch show" output MIME parts are now display with proper nesting to reflect original MIME hierarchy of a message. This allows clients to correctly analyze the MIME structure, (such as, for example, determining to which parts a signature part applies). Add new "notmuch show --part" option This is a replacement for the older "notmuch part" command, (which is now deprecated—it should still work as always, but is no longer documented). Putting part output under "notmuch show" allows for all of the "notmuch show" options to be applied when extracting a single part, (such as --format=json for extracting a message part with JSON formatting). Deprecate "notmuch search-tags" (in favor of "notmuch search --output=tags *") The "notmuch search-tags" sub-command has been redundant since the addition of the --output=tags option to "notmuch search". We now make that more clear by deprecating "notmuch search-tags", (dropping it from the documentation). We do continue to support the old syntax by translating it internally to the new call. Performance improvements ------------------------ Faster searches (by doing fewer searches to construct threads) Whenever a user asks for search results as threads, notmuch first performs a search for messages matching the query, then performs additional searches to find other messages in the resulting threads. Removing inefficiencies and redundancies in these secondary searches results in a measured speedups of 1.5x for a typical search. Faster searches (by doing fewer passes to gather message data) Optimizing Xapian data access patterns (using a single pass to get all message-document data rather than a pass for each data type) results in a measured speedup of 1.7x for a typical search. The benefits of this optimization combine with the preceding optimization. With both in place, Austin Clements measured a speedup of 2.5x for a search of all messages in his inbox (was 4.5s, now 1.8s). Thanks, Austin! Faster initial indexing More efficient indexing of new messages results in a measured speedup of 1.4x for the initial indexing of 3 GB of mail (1h 14m rather than 1h 46m). Thanks to Austin Clements and Michal Sojka. Make "notmuch new" faster for unchanged directories Optimizing to not do any further examinations of sub-directories when the filesystem indicates that a directory is unchanged from the last "notmuch new" results in measured speedups of 8.5 for the "No new mail" case, (was 0.77s, now 0.09s). Thanks to Karel Zak. New emacs-interface features ---------------------------- Support for PGP/MIME (GnuPG) Automatically indicate validity of signatures for multipart/signed messages. Automatically display decrypted content for multipart/encrypted messages. See the emacs variable notmuch-crypto-process-mime for more information. Note that this needs gpg-agent and a pinentry tool just as the command-line tools. Also note there is no support SMIME yet. Output of pipe command is now displayed if pipe command fails This is extremely useful in the common use case of piping a patch to "git am". If git fails to cleanly merge the patch the error messages from the failed merge are now clearly displayed to the user, (where previously they were silently hidden from the user). User-selectable From address A user can choose which configured email addresses should be used as the From address whenever composing a new message. To do so, simply press C-u before the command which will open a new message. Emacs will prompt for the from address to use. The user can customize the "Notmuch Identities" setting in the notmuch customize group in order to use addresses other than those in the notmuch configuration file if desired. The user can also choose to always be prompted for the from address when composing a new message (without having to use C-u) by setting the "Notmuch Always Prompt For Sender" option in the notmuch customize group. Hiding of repeated subjects in collapsed thread view In notmuch-show mode, if a collapsed message has the same subject as its parent, the subject is not shown. Automatic detection and hiding of original message in top-posted message When a message contains a line looking something like: ----- Original Message ----- emacs hides this and all subsequent lines as an "original message", (allowing the user to click or press enter on the "original message" button to display it again). This makes the handling of top-posted citations work much like conventional citations. New hooks for running code when tags are modified Some users want to perform additional actions whenever a particular tag is added/removed from a message. This could be used to, for example, interface with some external spam-recognition training tool. To facilitate this, two new hooks are added which can be modified in the following settings of the notmuch customize group: Notmuch Before Tag Hook Notmuch After Tag Hook New optional support for hiding some multipart/alternative parts Many emails are sent with redundant content within a multipart/alternative group (such as a text/plain part as well as a text/html part). Users can configure the setting: Notmuch Show All Multipart/Alternative Parts to "off" in the notmuch customize group to have the interface automatically hide some part alternatives (such as text/html parts). This new part hiding is not configured by default yet because there's not yet a simple way to re-display such a hidden part if it is not actually redundant with a displayed part. Better rendering of text/x-vcalendar parts These parts are now displayed in a format suitable for use with the emacs diary. Avoid getting confused by Subject and Author fields with newline characters Replacing all characters with ASCII code less than 32 with a question mark. Cleaner display of From line in email messages Remove double quotes, and drop "name" if it's actually just a repeat of the email address. Vim interface improvements -------------------------- Felipe Contreras provided a number of updates for the vim interface: * Using sendmail directly rather than mailx, * Implementing archive in show view * Add support to mark as read in show and search views * Add delete commands * Various cleanups. Bindings improvements --------------------- Ruby bindings are now much more complete Including `QUERY.sort`, `QUERY.to_s`, `MESSAGE.maildir_flags_to_tags`, `MESSAGE.tags_to_maildir_flags`, and `MESSAGE.get_filenames` Python bindings have been updated and extended (docs online at https://notmuch.readthedocs.io/) New bindings: - `Message().get_filenames()`, `Message().tags_to_maildir_flags()`, `Message().maildir_flags_to_tags()`, `list(Threads())` and `list(Messages)` works now - `Message().__cmp__()` and `__hash__()` These allow, for example: if msg1 == msg2: ... As well as set arithmetic on `Messages()`: s1, s2 = set(msgs1), set(msgs2) s1.union(s2) s2 -= s1 Removed: - `len(Messages())` as it exhausted the iterator Use `len(list(Messages()))` or `Query.count_messages()` to get the length. Added initial Go bindings in bindings/go New build-system features ------------------------- Added support for building in a directory other than the source directory This can be used with the widely-supported idiom of simply running the configure script from some other directory: mkdir build cd build ../configure make Fix to save configure options for future, implicit runs of configure When a user updates the source (such as with "git pull") calling "make" may cause an automatic re-run of the configure script. When this happens, the configure script will automatically be called with the same options the user originally passed in the most-recent manual invocation of configure. New test-suite feature ---------------------- Binary for bash for running test suite now located via PATH The notmuch test suite requires a fairly recent version of bash (>= bash 4). As some systems supply an older version of bash at /bin/bash, the test suite is now updated to search $PATH to locate the bash binary. This allows users of systems with old /bin/bash to simply install bash >= 4 somewhere on $PATH before /bin and then use the test suite. Support for testing output with a trailing newline Previously, some tests would fail to notice a difference in the presence/absence of a trailing newline in a program output, (which has led to bugs in the past). Now, carefully-written tests (using `test_expect_equal_file` rather than `test_expect_equal`) will detect any change in the presence/absence of a trailing newline. Many tests are updated to take advantage of this. Avoiding accessing user's $HOME while running test suite The test suite now carefully creates its own HOME directory. This allows the test suite to be run with no existing HOME directory, (as some build systems apparently do), and avoids test-suite differences due to configuration files in the users HOME directory. General bug fixes ----------------- Output *all* files for "notmuch search --output=files" For the cases where multiple files have the same Message ID, previous versions of notmuch would output only one such file. This command is now fixed to correctly output all files. Fixed spurious search results from "overlapped" indexing of addresses This fixed a bug where a search for: to:user@elsewhere.com would incorrectly match a message sent: To: user@example,com, someone@elsewhere.com Fix --output=json when search has no results A bug present since notmuch 0.4 had caused searches with no results to produce an invalid json object. This is now fixed to cleanly return a valid json object representing an empty array "[]" as expected. Fix the automatic detection of the From address for "notmuch reply" from the Received headers in some cases Fix core dump on DragonFlyBSD due to -1 return value from `sysconf(_SC_GETPW_R_SIZE_MAX)` Cleaned up several memory leaks Eliminated a few, rare segmentation faults and a double-free Fix libnotmuch library to only export notmuch API functions Previous release of the notmuch library also exported some Xapian C++ exception type symbols. These were never part of the library interface and were never intended to be exported. Emacs-interface bug fixes ------------------------- Display any unexpected output or errors from "notmuch search" invocations Previously any misformatted output or trailing error messages were silently ignored. This output is now clearly displayed. This fix was very helpful in identifying and fixing the bug described below. Fix bug where some threads would be missing from large search results When a search returned a "large" number of results, the emacs interface was incorrectly dropping one thread every time the output of the "notmuch search" process spanned the emacs read-buffer. This is now fixed. Avoid re-compression of .gz files (and similar) when saving attachment Emacs was being too clever for its own good and trying to re-compress pre-compressed .gz files when saving such attachments (potentially corrupting the attachment). The emacs interface is fixed to avoid this bug. Fix hiding of a message when a previously-hidden citation is visible Previously the citation would remain visible in this case. This is fixed so that hiding a message hides all parts. Notmuch 0.5 (2010-11-11) ======================== New, general features --------------------- Maildir-flag synchronization Notmuch now knows how to synchronize flags in maildir filenames with tags in the notmuch database. The following flag/tag mappings are supported: Flag <-> Tag ---- ----- 'D' draft 'F' flagged 'P' passed 'R' replied 'S' unread (added when 'S' flag is not present) The synchronization occurs in both directions, (for example, adding the 'S' flag to a file will cause the "unread" tag to be added, and adding the "replied" tag to a message will cause the file to be renamed with an 'R' flag). This synchronization is enabled by default for users of the command-line interface, (though only files in directories named "cur" or "new" will be renamed). It can be disabled by setting the new `maildir.synchronize_flags` option in the configuration file. For example: notmuch config set maildir.synchronize_flags false Users upgrading may also want to run "notmuch setup" once (just accept the existing configuration) to get a new, nicely-commented [maildir] section added to the configuration file. For users of the notmuch library, the new synchronization functionality is available with the following two new functions: notmuch_message_maildir_flags_to_tags notmuch_message_tags_to_maildir_flags It is anticipated that future improvements to this support will allow for safe synchronization of the 'T' flag with the "deleted" tag, as well as support for custom flag/tag mappings. New library features -------------------- Support for querying multiple filenames for a single message It is common for the mailstore to contain multiple files with the same message ID. Previously, notmuch would always hide these duplicate files, (returning a single, arbitrary filename with `notmuch_message_get_filename`). With this release, library users can access all filenames for a message with the new function: notmuch_message_get_filenames Together with `notmuch_filenames_valid`, `notmuch_filenames_get`, and `notmuch_filenames_move_to_next` it is now possible to iterate over all available filenames for a given message. New command-line features ------------------------- New "notmuch show --format=raw" for getting at original email contents This new feature allows for a fully-functional email client to be built on top of the notmuch command-line without needing any direct access to the mail store itself. For example, it's now possible to run "emacs -f notmuch" on a local machine with only ssh access to the mail store/notmuch database. To do this, simply set the notmuch-command variable in emacs to the name of a script containing: ssh user@host notmuch "$@" If the ssh client has enabled connection sharing (ControlMaster option in OpenSSH), the emacs interface can be quite responsive this way. General bug fixes ----------------- Fix "notmuch search" to print nothing when nothing matches The 0.4 release had a bug in which: notmuch search would produce a single blank line of output, (where previous versions would produce no output. This fix also causes a change in the --format=json output, (which would previously produce "[]" and now produces nothing). Emacs interface improvements ---------------------------- Fix to allow pipe ('|') command to work when using notmuch over ssh Fix count of lines in hidden signatures Omit repeated subject lines in (collapsed) thread display Display current thread subject in a header line Provide a "c i" binding to copy a thread ID from the search view Allow for notmuch-fcc-dirs to have a value of nil Also, the more complex form of notmuch-fcc-dirs now has a slightly different format. It no longer has a special first-element, fallback string. Instead it's now a list of cons cells where the car of each cell is a regular expression to be matched against the sender address, and the cdr is the name of a folder to use for an FCC. So the old fallback behavior can be achieved by including a final cell of (".*" . "default-fcc-folder"). Vim interface improvements -------------------------- Felipe Contreras provided a number of updates for the vim interface These include optimizations, support for newer versions of vim, fixed support for sending mail on modern systems, new commands, and various cleanups. New bindings ------------ Added initial ruby bindings in bindings/ruby Notmuch 0.4 (2010-11-01) ======================== New command-line features ------------------------- `notmuch search --output=(summary|threads|messages|tags|files)` This new option allows for particular items to be returned from notmuch searches. The "summary" option is the default and behaves just as "notmuch search" has historically behaved. The new option values allow for thread IDs, message IDs, lists of tags, and lists of filenames to be returned from searches. It is expected that this new option will be very useful in shell scripts. For example: for file in $(notmuch search --output=files ); do "$file" done `notmuch show --format=mbox ` This new option allows for the messages matching a search specification to be presented as an mbox. Specifically the "mboxrd" format is used which allows for reversible quoting of lines beginning with "From ". A reader should remove a single '>' from the beginning of all lines beginning with one or more '>' characters followed by the 5 characters "From ". `notmuch config [get|set]
. [value ...]` The new top-level "config" command allows for any value in the notmuch configuration file to be queried or set to a new value. Both single-valued and multi-valued items are supported, as our any custom items stored in the configuration file. Avoid setting Bcc header in "notmuch reply" We decided that this was a bit heavy-handed as the actual mail user-agent should be responsible for setting any Bcc option. Also, see below for the notmuch/emacs user-agent now setting an Fcc by default rather than Bcc. New library features -------------------- Add `notmuch_query_get_query_string` and `notmuch_query_get_sort` These are simply functions for querying properties of a `notmuch_query_t` object. New emacs features ------------------ Enable Fcc of all sent messages by default (to "sent" directory) All messages sent from the emacs interface will now be saved to the notmuch mail store where they will be incorporated to the database by the next "notmuch new". By default, messages are saved to the "sent" directory at the top-level of the mail store. This directory can be customized by means of the "Notmuch Fcc Dirs" option in the notmuch customize interface. Ability to all open messages in a thread to a pipe Historically, the '|' keybinding allows for piping a single message to an external command. Now, by prefixing this key with a prefix argument, (for example, by pressing "Control-U |"), all open messages in the current thread will be sent to the external command. Optional support for detecting inline patches This hook is disabled by default but can be enabled with a checkbox under "Notmuch Show Insert Text/Plain Hook" in the notmuch customize interface. It allows for inline patches to be detected and treated as if they were attachments, (with context-sensitive highlighting). Automatically tag messages as "replied" when sending a reply Messages replied to within the emacs interface will now be tagged as "replied". This feature can easily be customized to add or remove other tags as well. For example, a user might use a tag of "needs-reply" and can configure this feature to automatically remove that tag when replying. See "Notmuch Message Mark Replied" in the notmuch customize interface. Allow search-result color specifications to overlay each other For example, one tag can specify the background color of matching lines, while another can specify the foreground. With this change, both settings will now be visible simultaneously, (which was not the case in previous releases). See "Notmuch Search Line Faces" in the notmuch customize interface. Make hidden author names still available for incremental search When there is insufficient space to display all authors of a thread in search results, the names of hidden authors are now still made available to emacs' incremental search commands. As the user searches, matching lines will temporarily expand to show the hidden names. New binding of Control-TAB (works like TAB in reverse) Many notmuch nodes already use TAB to navigate forward through various items allowing actions, (message headers, email attachments, etc.). The new Control-TAB binding operates similarly but in the opposite direction. New build-system features ------------------------- Various portability fixes have been applied These include fixes for build failures on at least Solaris, FreeBSD, and Fedora systems. We're hopeful that the notmuch code base is now more portable than ever before. Arrange for libnotmuch to be found automatically after make install The notmuch build system is now careful to help the user avoid errors of the form "libnotmuch.so could not be found" immediately after installing. This support takes two forms: 1. If the library is installed to a system directory, (configured in /etc/ld.so.conf), then "make install" will automatically run ldconfig. 2. If the library is installed to a non-system directory, the build system adds a `DR_RUNPATH` entry to the final binary pointing to the directory to which the library is installed. When this support works, the user should be able to run notmuch immediately after "make install", without any errors trying to find the notmuch library, and without having to manually set environment variables such as `LD_LIBRARY_PATH`. Check compiler/linker options before using them The configure script now carefully checks that any desired compilation options, (whether for enabling compiler warnings, or for embedding rpath, etc.), are supported. Only supported options are used in the resulting Makefile. New test-suite features ----------------------- New modularization of test suite Thanks to a gracious relicensing of the test-suite infrastructure from the git project, notmuch now has a modular test suite. This provides the ability to run individual sections of the test suite rather than the whole things. It also provides better summary of test results, with support for tests that are expected to fail (BROKEN and FIXED) in addition to PASS and FAIL. Finally, it makes it easy to run the test suite within valgrind (pass --valgrind to notmuch-test or to any sub-script) which has been very useful. New testing of emacs interface The test suite has been augmented to allow automated testing of the emacs interfaces. So far, this includes basic searches, display of threads, and tag manipulation. This also includes a test that a new message can successfully be sent out through a (dummy) SMTP server and that said message is successfully integrated into the notmuch database via the FCC setting. General bug fixes ----------------- Fix potential corruption of database when "notmuch new" is interrupted Previously, an interruption of "notmuch new" would (rarely) result in a corrupt database. The corruption would manifest itself by a persistent error of the form: document ID of 1234 has no thread ID The message-adding code has been carefully audited and reworked to avoid this sort of corruption regardless of when it is interrupted. Fix failure with extremely long message ID headers Previously, a message with an extremely long message ID, (say, more than 300 characters), would fail to be added to notmuch, (triggering Xapian exceptions). This has now been fixed. Fix for messages with "charset=unknown-8bit" Previously, messages with this charset would cause notmuch to emit a GMime warning, (which would then trip up emacs or other interfaces parsing the notmuch results). Fix `notmuch_query_search_threads` function to return NULL on any exception Fix "notmuch search" to return non-zero if `notmuch_query_search_threads` fails Previously, this command could confusingly report a Xapian exception, yet still return an error code of 0. It now correctly returns a failing error code of 1 in this case. Emacs bug fixes --------------- Fix to handle a message with a subject containing, for example "[1234]" Previously, a message subject containing a sequence of digits within square brackets would cause the emacs interface to mis-parse the output of "notmuch search". This would result in the message being mis-displayed and prevent the user from manipulating the message in the emacs interface. Fix to correctly handle message IDs containing ".." The emacs interface now properly quotes message IDs to avoid a Xapian bug in which the ".." within a message ID would be misinterpreted as a numeric range specification. Python-binding fixes -------------------- The python bindings for notmuch have been updated to work with python3. Debian-specific fixes --------------------- Fix emacs initialization so "M-x notmuch" works for users by default Now, a new Debian user can immediately run "emacs -f notmuch" after "apt-get install notmuch". Previously, the user would have had to edit the ~/.emacs file to add "(require 'notmuch)" before this would work. Notmuch 0.3.1 (2010-04-27) ========================== General bug fixes ----------------- Fix an infinite loop in "notmuch reply" This bug could be triggered by replying to a message where the user's primary email address did not appear in the To: header and the user had not configured any secondary email addresses. The bug was a simple re-use of the same iterator variable in nested loops. Fix a potential SEGV in "notmuch search" This bug could be triggered by an author name ending in a ','. Admittedly - that's almost certainly a spam email, but we never want notmuch to crash. Emacs bug fixes --------------- Fix calculations for line wrapping in the primary "notmuch" view Fix Fcc support to prompt to create a directory if the specified Fcc directory does not exist Build fix --------- Fix build on OpenSolaris (at least) due to missing 'extern "C"' block Without this, the C++ sources could not find strcasestr and the final linking of notmuch would fail. Notmuch 0.3 (2010-04-27) ======================== New command-line features ------------------------- User-configurable tags for new messages A new "new.tags" option is available in the configuration file to determine which tags are applied to new messages. Run "notmuch setup" to generate new documentation within ~/.notmuch-config on how to specify this value. Threads search results named based on subjects that match search This means that when new mails arrived to a thread you've previously read, and the new mails have a new subject, you will see that subject in the search results rather than the old subject. Faster operation of "notmuch tag" (avoid unneeded sorting) Since the user just wants to tag all matching messages, we can make things perform a bit faster by avoiding the sort. Even Better guessing of From: header for "notmuch reply" Notmuch now looks at a number of headers when trying to figure out the best From: header to use in a reply. This is helpful if you have several configured email addresses, and you also subscribe to various mailing lists with different addresses, (so that mails you are replying to won't always include your subscribed address in the To: header). Indication of author names that match a search When notmuch displays threads as the result of a search, it now lists the authors that match the search before listing the other authors in the thread. It inserts a pipe '|' symbol between the last matching and first non-matching author. This is especially useful in a search that includes tag:unread. Now the authors of the unread messages in the thread are listed first. New: Python bindings -------------------- Sebastian Spaeth has contributed his python bindings for the notmuch library to the central repository. These bindings were previously known as "cnotmuch" within python but have now been renamed to be accessible with a simple, and more official-looking "import notmuch". The bindings have already proven very useful as people proficient in python have been able to easily develop programs to do notmuch-based searches for email-address completion, maildir-flag synchronization, and other tasks. These bindings are available within the bindings/python directory, but are not yet integrated into the top-level Makefiles, nor the top-level package-building scripts. Improvements are welcome. Emacs interface improvements ---------------------------- An entirely new initial view for notmuch, (friendly yet powerful) Some of us call the new view "notmuch hello" but you can get at it by simply calling "emacs -f notmuch". The new view provides a search bar where new searches can be performed. It also displays a list of recent searches, along with a button to save any of these, giving it a new name as a "saved search". Many people find these "saved searches" one of the most convenient ways of organizing their mail, (providing all of the features of "folders" in other mail clients, but without any of the disadvantages). Finally, this view can also optionally display all of the tags that exist in the database, along with a count for each tag, and a custom search of messages with that tag that's simply a click (or keypress) away. NOTE: For users that liked the original mode of "emacs -f notmuch" immediately displaying a particular search result, we recommend instead running something like: emacs --eval '(notmuch search "tag:inbox" t)' The "t" means to sort the messages in an "oldest first" order, (as notmuch would do previously by default). You can also leave that off to have your search results in "newest first" order. Full-featured "customize" support for configuring notmuch Notmuch now plugs in well to the emacs "customize" mode to make it much simpler to find things about the notmuch interface that can be tweaked by the user. You can get to this mode by starting at the main "Customize" menu in emacs, then browsing through "Applications", "Mail", and "Notmuch". Or you can go straight to "M-x customize-group" "notmuch". Once you're at the customize screen, you'll see a list of documented options that can be manipulated along with checkboxes, drop-down selectors, and text-entry boxes for configuring the various settings. Support for doing tab-completion of email addresses This support currently relies on an external program, (notmuch-addresses), that is not yet shipped with notmuch itself. But multiple, suitable implementations of this program have already been written that generate address completions by doing notmuch searches of your email collection. For example, providing first those addresses that you have composed messages to in the past, etc. One such program (implemented in python with the python bindings to notmuch) is available via: git clone http://jkr.acm.jhu.edu/git/notmuch_addresses.git Install that program as notmuch-addresses on your PATH, and then hitting TAB on a partial email address or name within the To: or Cc: line of an email message will provide matching completions. Support for file-based (Fcc) delivery of sent messages to mail store This isn't yet enabled by default. To enable this, one will have to set the "Notmuch Fcc Dirs" setting within the notmuch customize screen, (see its documentation there for details). We anticipate making this automatic in a future release. New 'G' key binding to trigger mail refresh (G == "Get new mail") The 'G' key works wherever '=' works. Before refreshing the screen it calls an external program that can be used to poll email servers, run notmuch new and set up specific tags for the new emails. The script to be called should be configured with the "Notmuch Poll Script" setting in the customize interface. This script will typically invoke "notmuch new" and then perhaps several "notmuch tag" commands. Implement emacs message display with the JSON output from notmuch This is much more robust than the previous implementation, (where some HTML mails and mail quoting the notmuch code with the delimiter characters in it would cause the parser to fall over). Better handling of HTML messages and MIME attachments (inline images!) Allow for any MIME parts that emacs can display to be displayed inline. This includes inline viewing of image attachments, (provided the window is large enough to fit the image at its natural size). Much more robust handling of HTML messages. Currently both text/plain and text/html alternates will be rendered next to each other. In a future release, users will be able to decide to see only one or the other representation. Each attachment now has its own button so that attachments can be saved individually (the 'w' key is still available to save all attachments). Customizable support for tidying of text/plain message content Many new functions are available for tidying up message content. These include options such as wrapping long lines, compressing duplicate blank lines, etc. Most of these are disabled by default, but can easily be enabled by clicking the available check boxes under the "Notmuch Show Insert Text/Plain Hook" within the notmuch customize screen. New support for searchable citations (even when hidden) When portions of overly-long citations are hidden, the contents of these citations will still be available for emacs' standard "incremental search" functions. When the search matches any portion of a hidden citation, the citation will become visible temporarily to display the search result. More flexible handling of header visibility As an answer to complaints from many users, the To, Cc, and Date headers of messages are no longer hidden by default. For those users that liked that these were hidden, a new "Notmuch Messages Headers Visible" option in the customize interface can be set to nil. The visibility of headers can still be toggled on a per-message basis with the 'h' keybinding. For users that don't want to see some subset of those headers, the new "Notmuch Message Headers" variable can be customized to list only those headers that should be present in the display of a message. The Return key now toggles message visibility anywhere Previously this worked only on the first summary-line of a message. Customizable formatting of search results The user can easily customize the order, width, and formatting of the various fields in a "notmuch search" buffer. See the "Notmuch Search Result Format" section of the customize interface. Generate nicer names for search buffers when using a saved search Add a notmuch User-Agent header when sending mail from notmuch/emacs New keybinding (M-Ret) to open all collapsed messages in a thread New library feature ------------------- Provide a new `NOTMUCH_SORT_UNSORTED` value for queries This can be somewhat faster when sorting simply isn't desired. For example when collecting a set of messages that will all be manipulated identically, (adding a tag, removing a tag, deleting the messages), then there's no advantage to sorting the messages by date. Build fixes ----------- Fix to compile against GMime 2.6 Previously notmuch insisted on being able to find GMime 2.4, (even though GMime 2.6 would have worked all along). Fix configure script to accept (and ignore) various standard options For example, those that the Gentoo build scripts expect configure to accept are now all accepted. Test suite ---------- A large number of new tests for the many new features Better display of output from failed tests Now shows failures with diff rather than forcing the user to gaze at complete actual and expected output looking for deviation. Notmuch 0.2 (2010-04-16) ======================== This is the second release of the notmuch mail system, with actual detailed release notes this time! This release consists of a number of minor new features that make notmuch more pleasant to use, and a few fairly major bug fixes. We didn't quite hit our release target of "about a week" from the 0.1 release, (0.2 is happening 11 days after 0.1), but we hope to do better for next week. Look forward to some major features coming to notmuch in subsequent releases. -Carl General features ---------------- Better guessing of From: header Notmuch now tries harder to guess which configured address should be used as the From: line in a "notmuch reply". It will examine the Received: headers if it fails to find any configured address in To: or Cc:. This allows it to often choose the correct address even when replying to a message sent to a mailing list, and not directly to a configured address. Make "notmuch count" with no arguments count all messages Previously, it was hard to construct a search term that was guaranteed to match all messages. Provide a new special-case search term of "*" to match all messages This can be used in any command accepting a search term, such as "notmuch search '*'". Note that you'll want to take care that the shell doesn't expand * against the current files. And note that the support for "*" is a special case. It's only meaningful as a single search term and loses its special meaning when combined with any other search terms. Automatically detect thread connections even when a parent message is missing Previously, if two or more message were received with a common parent, but that parent was not received, then these messages would not be recognized as belonging to the same thread. This is now fixed so that such messages are properly connected in a thread. General bug fixes ----------------- Fix potential data loss in "notmuch new" with SIGINT One code path in "notmuch new" was not properly handling SIGINT. Previously, this could lead to messages being removed from the database (and their tags being lost) if the user pressed Control-C while "notmuch new" was working. Fix segfault when a message includes a MIME part that is empty Fix handling of non-ASCII characters with --format=json Previously, characters outside the range of 7-bit ASCII were silently dropped from the JSON output. This led to corrupted display of utf-8 content in the upcoming notmuch web-based frontends. Fix headers to be properly decoded in "notmuch reply" Previously, the user might see: Subject: Re: =?iso-8859-2?q?Rozlu=E8ka?= rather than: Subject: Re: Rozlučka The former text is properly encoded to be RFC-compliant SMTP, will be sent correctly, and will be properly decoded by the recipient. But the user trying to edit the reply would likely be unable to read or edit that field in its encoded form. Emacs client features --------------------- Show the last few lines of citations as well as the first few lines It's often the case that the last sentence of a citation is what is being replied to directly, so the last few lines are often much more important. The number of lines shown at the beginning and end of any citation can be configured, (notmuch-show-citation-lines-prefix and notmuch-show-citation-lines-suffix). The '+' and '-' commands in the search view can now add and remove tags by region Selective bulk tagging is now possible by selecting a region of threads and then using either the '+' or '-' keybindings. Bulk tagging is still available for all threads matching the current search with the '*' binding. More meaningful buffer names for thread-view buffers Notmuch now uses the Subject of the thread as the buffer name. Previously it was using the thread ID, which is a meaningless number to the user. Provide for customized colors of threads in search view based on tags See the documentation of notmuch-search-line-faces, (or us "M-x customize" and browse to the "notmuch" group within "Applications" and "Mail"), for details on how to configure this colorization. Build-system features --------------------- Add support to properly build libnotmuch on Darwin systems (OS X) Add support to configure for many standard options We include actual support for: --includedir --mandir --sysconfdir And accept and silently ignore several more: --build --infodir --libexecdir --localstatedir --disable-maintainer-mode --disable-dependency-tracking Install emacs client in "make install" rather than requiring a separate "make install-emacs" Automatically compute versions numbers between releases This support uses the git-describe notation, so a version such as 0.1-144-g43cbbfc indicates a version that is 144 commits since the 0.1 release and is available as git commit "43cbbfc". Add a new "make test" target to run the test suite and actually verify its results Notmuch 0.1 (2010-04-05) ======================== This is the first release of the notmuch mail system. It includes the libnotmuch library, the notmuch command-line interface, and an emacs-based interface to notmuch. Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian 1.1.4 (or later). Previous versions of Xapian (whether 1.0 or 1.1) had a performance bug that made notmuch very slow when modifying tags. This would cause distracting pauses when reading mail while notmuch would wait for Xapian when removing the "inbox" and "unread" tags from messages in a thread. notmuch-0.23.7/README000066400000000000000000000056121305541522400141450ustar00rootroot00000000000000Notmuch - thread-based email index, search and tagging. Notmuch is a system for indexing, searching, reading, and tagging large collections of email messages in maildir or mh format. It uses the Xapian library to provide fast, full-text search with a convenient search syntax. Notmuch is free software, released under the GNU General Public License version 3 (or later). Building notmuch ---------------- See the INSTALL file for notes on compiling and installing notmuch. Running notmuch --------------- After installing notmuch, start by running "notmuch setup" which will interactively prompt for configuration information such as your name, email address, and the directory which contains your mail archive to be indexed. You can change any answers later by running "notmuch setup" again or by editing the .notmuch-config file in your home directory. With notmuch configured you should next run "notmuch new" which will index all of your existing mail. This can take a long time, (several hours) if you have a lot of email, (hundreds of thousands of files). When new mail is delivered to your mail archive in the future, you will want to run "notmuch new" again. These runs will be much faster as they will only index new messages. Finally, you can prove to yourself that things are working by running some command-line searches such as "notmuch search from:someone@example.com" or "notmuch search subject:topic". See "notmuch help search-terms" for more details on the available search syntax. The command-line search output is not expected to be particularly friendly for day-to-day usage. Instead, it is expected that you will use an email interface that builds on the notmuch command-line tool or the libnotmuch library. Notmuch installs a full-featured email interface for use within emacs. To use this, first add the following line to your .emacs file: (autoload 'notmuch "notmuch" "Notmuch mail" t) Then, either run "emacs -f notmuch" or execute the command "M-x notmuch" from within a running emacs. If you're interested in a non-emacs-based interface to notmuch, then please join the notmuch community. Various other interfaces are already in progress, (an interface within vim, a curses interface, graphical interfaces based on evolution, and various web-based interfaces). The authors of these interfaces would love further testing or contribution. See contact information below. Contacting users and developers ------------------------------- The website for Notmuch is: https://notmuchmail.org The mailing list address for the notmuch community is: notmuch@notmuchmail.org We welcome any sort of questions, comments, kudos, or code there. Subscription is not required, (but if you do subscribe you'll avoid any delay due to moderation). See the website for subscription information. There is also an IRC channel dedicated to talk about using and developing notmuch: IRC server: irc.freenode.net Channel: #notmuch notmuch-0.23.7/README.rst000066400000000000000000000007021305541522400147470ustar00rootroot00000000000000If you're reading this on https://github.com/notmuch/notmuch, this is a read-only mirror of the notmuch project. For more information about the project, see https://notmuchmail.org. Please don't send us pull requests on github. If you have a feature branch that you want us to look at, use ``git send-email`` to send it to notmuch@notmuchmail.org. For more information about contributing to the project, see https://notmuchmail.org/contributing/. notmuch-0.23.7/bindings/000077500000000000000000000000001305541522400150565ustar00rootroot00000000000000notmuch-0.23.7/bindings/Makefile000066400000000000000000000002041305541522400165120ustar00rootroot00000000000000# See Makefile.local for the list of files to be compiled in this # directory. all: $(MAKE) -C .. all .DEFAULT: $(MAKE) -C .. $@ notmuch-0.23.7/bindings/Makefile.local000066400000000000000000000007671305541522400176210ustar00rootroot00000000000000# -*- makefile -*- dir := bindings # force the shared library to be built ruby-bindings: lib/$(LINKER_NAME) ifeq ($(HAVE_RUBY_DEV),1) cd $(dir)/ruby && \ EXTRA_LDFLAGS="$(NO_UNDEFINED_LDFLAGS)" \ LIBNOTMUCH="../../lib/$(LINKER_NAME)" \ ruby extconf.rb --vendor $(MAKE) -C $(dir)/ruby endif CLEAN += $(patsubst %,$(dir)/ruby/%, \ .RUBYARCHDIR.time \ Makefile database.o directory.o filenames.o\ init.o message.o messages.o mkmf.log notmuch.so query.o \ status.o tags.o thread.o threads.o) notmuch-0.23.7/bindings/python/000077500000000000000000000000001305541522400163775ustar00rootroot00000000000000notmuch-0.23.7/bindings/python/.gitignore000066400000000000000000000000471305541522400203700ustar00rootroot00000000000000*.py[co] /docs/build /docs/html build/ notmuch-0.23.7/bindings/python/MANIFEST.in000066400000000000000000000000561305541522400201360ustar00rootroot00000000000000include notmuch #recursive-include docs/html *notmuch-0.23.7/bindings/python/README000066400000000000000000000012241305541522400172560ustar00rootroot00000000000000notmuch -- The python interface to notmuch ========================================== This module makes the functionality of the notmuch library (`https://notmuchmail.org`_) available to python. Successful import of this modul depends on a libnotmuch.so|dll being available on the user's system. If you have downloaded the full source tarball, you can create the documentation with sphinx installed, go to the docs directory and "make html". A static version of the documentation is available at: https://notmuch.readthedocs.io/projects/notmuch-python/ To build the python bindings, do python setup.py install --prefix=path/to/your/preferred/location notmuch-0.23.7/bindings/python/debian/000077500000000000000000000000001305541522400176215ustar00rootroot00000000000000notmuch-0.23.7/bindings/python/debian/changelog000066400000000000000000000002121305541522400214660ustar00rootroot00000000000000cnotmuch (0.2.1-1) karmic; urgency=low * Initial release -- Sebastian Spaeth Tue, 30 Mar 2010 11:31:39 +0200 notmuch-0.23.7/bindings/python/debian/compat000066400000000000000000000000021305541522400210170ustar00rootroot000000000000007 notmuch-0.23.7/bindings/python/debian/control000066400000000000000000000013771305541522400212340ustar00rootroot00000000000000Source: cnotmuch Section: python Priority: extra Maintainer: Sebastian Spaeth Build-Depends: debhelper (>= 7.3.0), python-support (>= 0.5.3) Build-Depends-Indep: python (>= 2.5), python-support Standards-Version: 3.8.1 Homepage: http://pypi.python.org/pypi/cnotmuch Package: cnotmuch Architecture: all XB-Python-Version: ${python:Versions} Depends: ${misc:Depends},${python:Depends}, notmuch (> 0.0+201001211401) Description: Interface to the notmuch mail search and index library The cnotmuch module provides an interface to the notmuch functionality, directly interfacing with a shared notmuch library. Notmuch provides a maildatabase that allows for extremely quick searching and filtering of your email according to various criteria. notmuch-0.23.7/bindings/python/debian/copyright000066400000000000000000000025631305541522400215620ustar00rootroot00000000000000This package was debianized by: Sebastian Spaeth on Tue, 30 Mar 2010 10:02:22 +0200 It was downloaded from: http://pypi.python.org/packages/source/c/cnotmuch/cnotmuch-0.2.1.tar.gz Upstream Author(s): Sebastian Spaeth Copyright: Copyright (C) 2010 Sebastian Spaeth License: This package is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this package; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA On Debian systems, the complete text of the GNU General Public License version 2 can be found in `/usr/share/common-licenses/GPL-2'. The Debian packaging is: Copyright (C) 2010 Sebastian Spaeth and is licensed under the GPL version 3, see `/usr/share/common-licenses/GPL-3'. notmuch-0.23.7/bindings/python/debian/docs000066400000000000000000000000071305541522400204710ustar00rootroot00000000000000README notmuch-0.23.7/bindings/python/debian/rules000077500000000000000000000000361305541522400207000ustar00rootroot00000000000000#!/usr/bin/make -f %: dh $@ notmuch-0.23.7/bindings/python/docs/000077500000000000000000000000001305541522400173275ustar00rootroot00000000000000notmuch-0.23.7/bindings/python/docs/COPYING000066400000000000000000001045161305541522400203710ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . notmuch-0.23.7/bindings/python/docs/Makefile000066400000000000000000000056221305541522400207740ustar00rootroot00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf build/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html @echo @echo "Build finished. The HTML pages are in html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml @echo @echo "Build finished. The HTML pages are in build/dirhtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in build/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in build/qthelp, like this:" @echo "# qcollectiongenerator build/qthelp/pyDNS.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile build/qthelp/pyDNS.qhc" latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex @echo @echo "Build finished; the LaTeX files are in build/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes @echo @echo "The overview file is in build/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in build/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in build/doctest/output.txt." notmuch-0.23.7/bindings/python/docs/source/000077500000000000000000000000001305541522400206275ustar00rootroot00000000000000notmuch-0.23.7/bindings/python/docs/source/conf.py000066400000000000000000000154661305541522400221420ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # pyDNS documentation build configuration file, created by # sphinx-quickstart on Tue Feb 2 10:00:47 2010. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0,os.path.abspath('../..')) class Mock(object): def __init__(self, *args, **kwargs): pass def __call__(self, *args, **kwargs): return Mock() @classmethod def __getattr__(self, name): return Mock() if name not in ('__file__', '__path__') else '/dev/null' MOCK_MODULES = [ 'ctypes', ] for mod_name in MOCK_MODULES: sys.modules[mod_name] = Mock() from notmuch import __VERSION__,__AUTHOR__ # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo'] autoclass_content = "both" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8' # The master toctree document. master_doc = 'index' # General information about the project. project = u'notmuch' copyright = u'2010-2012, ' + __AUTHOR__ # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = __VERSION__ # The full version, including alpha/beta/rc tags. release = __VERSION__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. #unused_docs = [] # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. html_use_modindex = False # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'notmuchdoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'notmuch.tex', u'notmuch Documentation', u'notmuch contributors', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # Additional stuff for the LaTeX preamble. #latex_preamble = '' # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_use_modindex = True # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} notmuch-0.23.7/bindings/python/docs/source/database.rst000066400000000000000000000017401305541522400231270ustar00rootroot00000000000000:class:`Database` -- The underlying notmuch database ==================================================== .. currentmodule:: notmuch .. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]]) .. automethod:: create .. automethod:: open(path, status=MODE.READ_ONLY) .. automethod:: close .. automethod:: get_path .. automethod:: get_version .. automethod:: needs_upgrade .. automethod:: upgrade .. automethod:: begin_atomic .. automethod:: end_atomic .. automethod:: get_directory .. automethod:: add_message .. automethod:: remove_message .. automethod:: find_message .. automethod:: find_message_by_filename .. automethod:: get_all_tags .. automethod:: create_query .. attribute:: Database.MODE Defines constants that are used as the mode in which to open a database. MODE.READ_ONLY Open the database in read-only mode MODE.READ_WRITE Open the database in read-write mode notmuch-0.23.7/bindings/python/docs/source/filesystem.rst000066400000000000000000000014271305541522400235510ustar00rootroot00000000000000Files and directories ===================== .. currentmodule:: notmuch :class:`Filenames` -- An iterator over filenames ------------------------------------------------ .. autoclass:: Filenames .. method:: Filenames.__len__ .. warning:: :meth:`__len__` was removed in version 0.22 as it exhausted the iterator and broke list(Filenames()). Use `len(list(names))` instead. :class:`Directoy` -- A directory entry in the database ------------------------------------------------------ .. autoclass:: Directory .. automethod:: Directory.get_child_files .. automethod:: Directory.get_child_directories .. automethod:: Directory.get_mtime .. automethod:: Directory.set_mtime .. autoattribute:: Directory.mtime .. autoattribute:: Directory.path notmuch-0.23.7/bindings/python/docs/source/index.rst000066400000000000000000000014471305541522400224760ustar00rootroot00000000000000Welcome to :mod:`notmuch`'s documentation ========================================= .. currentmodule:: notmuch The :mod:`notmuch` module provides an interface to the `notmuch `_ functionality, directly interfacing to a shared notmuch library. Within :mod:`notmuch`, the classes :class:`Database`, :class:`Query` provide most of the core functionality, returning :class:`Threads`, :class:`Messages` and :class:`Tags`. .. moduleauthor:: Sebastian Spaeth :License: This module is covered under the GNU GPL v3 (or later). .. toctree:: :maxdepth: 1 quickstart notes status_and_errors database query messages message tags threads thread filesystem Indices and tables ================== * :ref:`genindex` * :ref:`search` notmuch-0.23.7/bindings/python/docs/source/message.rst000066400000000000000000000016601305541522400230100ustar00rootroot00000000000000:class:`Message` -- A single message ==================================== .. currentmodule:: notmuch .. autoclass:: Message .. automethod:: get_message_id .. automethod:: get_thread_id .. automethod:: get_replies .. automethod:: get_filename .. automethod:: get_filenames .. attribute:: FLAG FLAG.MATCH This flag is automatically set by a Query.search_threads on those messages that match the query. This allows us to distinguish matches from the rest of the messages in that thread. .. automethod:: get_flag .. automethod:: set_flag .. automethod:: get_date .. automethod:: get_header .. automethod:: get_tags .. automethod:: maildir_flags_to_tags .. automethod:: tags_to_maildir_flags .. automethod:: remove_tag .. automethod:: add_tag .. automethod:: remove_all_tags .. automethod:: freeze .. automethod:: thaw .. automethod:: __str__ notmuch-0.23.7/bindings/python/docs/source/messages.rst000066400000000000000000000006141305541522400231710ustar00rootroot00000000000000:class:`Messages` -- A bunch of messages ======================================== .. currentmodule:: notmuch .. autoclass:: Messages .. automethod:: collect_tags .. method:: __len__() .. warning:: :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`. notmuch-0.23.7/bindings/python/docs/source/notes.rst000066400000000000000000000002011305541522400225020ustar00rootroot00000000000000Interfacing with notmuch ======================== .. todo:: move the note about talloc out of the code .. automodule:: notmuch notmuch-0.23.7/bindings/python/docs/source/query.rst000066400000000000000000000016721305541522400225340ustar00rootroot00000000000000:class:`Query` -- A search query ================================ .. currentmodule:: notmuch .. autoclass:: Query .. automethod:: create .. attribute:: Query.SORT Defines constants that are used as the mode in which to open a database. SORT.OLDEST_FIRST Sort by message date, oldest first. SORT.NEWEST_FIRST Sort by message date, newest first. SORT.MESSAGE_ID Sort by email message ID. SORT.UNSORTED Do not apply a special sort order (returns results in document id order). .. automethod:: set_sort .. attribute:: sort Instance attribute :attr:`sort` contains the sort order (see :attr:`Query.SORT`) if explicitely specified via :meth:`set_sort`. By default it is set to `None`. .. automethod:: exclude_tag .. automethod:: search_threads .. automethod:: search_messages .. automethod:: count_messages .. automethod:: count_threads notmuch-0.23.7/bindings/python/docs/source/quickstart.rst000066400000000000000000000005341305541522400235550ustar00rootroot00000000000000Quickstart and examples ======================= .. todo:: write a nice introduction .. todo:: improve the examples Notmuch can be imported as:: import notmuch or:: from notmuch import Query, Database db = Database('path', create=True) msgs = Query(db, 'from:myself').search_messages() for msg in msgs: print(msg) notmuch-0.23.7/bindings/python/docs/source/status_and_errors.rst000066400000000000000000000044011305541522400251210ustar00rootroot00000000000000.. currentmodule:: notmuch Status and Errors ================= Some methods return a status, indicating if an operation was successful and what the error was. Most of these status codes are expressed as a specific value, the :class:`notmuch.STATUS`. .. note:: Prior to version 0.12 the exception classes and the enumeration :class:`notmuch.STATUS` were defined in `notmuch.globals`. They have since then been moved into `notmuch.errors`. :class:`STATUS` -- Notmuch operation return value -------------------------------------------------- .. autoclass:: notmuch.STATUS :inherited-members: .. automethod:: notmuch.STATUS.status2str :exc:`NotmuchError` -- A Notmuch execution error ------------------------------------------------ Whenever an error occurs, we throw a special Exception :exc:`NotmuchError`, or a more fine grained Exception which is derived from it. This means it is always safe to check for NotmuchErrors if you want to catch all errors. If you are interested in more fine grained exceptions, you can use those below. .. autoexception:: NotmuchError The following exceptions are all directly derived from NotmuchError. Each of them corresponds to a specific :class:`notmuch.STATUS` value. You can either check the :attr:`status` attribute of a NotmuchError to see if a specific error has occurred, or you can directly check for the following Exception types: .. autoexception:: OutOfMemoryError(message=None) :members: .. autoexception:: ReadOnlyDatabaseError(message=None) :members: .. autoexception:: XapianError(message=None) :members: .. autoexception:: FileError(message=None) :members: .. autoexception:: FileNotEmailError(message=None) :members: .. autoexception:: DuplicateMessageIdError(message=None) :members: .. autoexception:: NullPointerError(message=None) :members: .. autoexception:: TagTooLongError(message=None) :members: .. autoexception:: UnbalancedFreezeThawError(message=None) :members: .. autoexception:: UnbalancedAtomicError(message=None) :members: .. autoexception:: UnsupportedOperationError(message=None) :members: .. autoexception:: UpgradeRequiredError(message=None) :members: .. autoexception:: PathError(message=None) :members: .. autoexception:: NotInitializedError(message=None) :members: notmuch-0.23.7/bindings/python/docs/source/tags.rst000066400000000000000000000006241305541522400223210ustar00rootroot00000000000000:class:`Tags` -- Notmuch tags ----------------------------- .. currentmodule:: notmuch .. autoclass:: Tags :members: .. method:: __len__ .. warning:: :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke list(Tags()). Use :meth:`len(list(msgs))` instead if you need to know the number of tags. .. automethod:: __str__ notmuch-0.23.7/bindings/python/docs/source/thread.rst000066400000000000000000000007141305541522400226320ustar00rootroot00000000000000:class:`Thread` -- A single thread ================================== .. currentmodule:: notmuch .. autoclass:: Thread .. automethod:: get_thread_id .. automethod:: get_total_messages .. automethod:: get_toplevel_messages .. automethod:: get_matched_messages .. automethod:: get_authors .. automethod:: get_subject .. automethod:: get_oldest_date .. automethod:: get_newest_date .. automethod:: get_tags .. automethod:: __str__ notmuch-0.23.7/bindings/python/docs/source/threads.rst000066400000000000000000000005241305541522400230140ustar00rootroot00000000000000:class:`Threads` -- Threads iterator ==================================== .. currentmodule:: notmuch .. autoclass:: Threads .. method:: __len__ .. warning:: :meth:`__len__` was removed in version 0.22 as it exhausted the iterator and broke list(Threads()). Use `len(list(msgs))` instead. .. automethod:: __str__ notmuch-0.23.7/bindings/python/notmuch/000077500000000000000000000000001305541522400200545ustar00rootroot00000000000000notmuch-0.23.7/bindings/python/notmuch/__init__.py000066400000000000000000000056231305541522400221730ustar00rootroot00000000000000"""The :mod:`notmuch` module provides most of the functionality that a user is likely to need. .. note:: The underlying notmuch library is build on a hierarchical memory allocator called talloc. All objects derive from a top-level :class:`Database` object. This means that as soon as an object is deleted, all underlying derived objects such as Queries, Messages, Message, and Tags will be freed by the underlying library as well. Accessing these objects will then lead to segfaults and other unexpected behavior. We implement reference counting, so that parent objects can be automatically freed when they are not needed anymore. For example:: db = Database('path',create=True) msgs = Query(db,'from:myself').search_messages() This returns :class:`Messages` which internally contains a reference to its parent :class:`Query` object. Otherwise the Query() would be immediately freed, taking our *msgs* down with it. In this case, the above Query() object will be automatically freed whenever we delete all derived objects, ie in our case: `del(msgs)` would also delete the parent Query. It would not delete the parent Database() though, as that is still referenced from the variable *db* in which it is stored. Pretty much the same is valid for all other objects in the hierarchy, such as :class:`Query`, :class:`Messages`, :class:`Message`, and :class:`Tags`. """ """ This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010-2011 Sebastian Spaeth """ from .database import Database from .directory import Directory from .filenames import Filenames from .message import Message from .messages import Messages from .query import Query from .tag import Tags from .thread import Thread from .threads import Threads from .globals import nmlib from .errors import ( STATUS, NotmuchError, OutOfMemoryError, ReadOnlyDatabaseError, XapianError, FileError, FileNotEmailError, DuplicateMessageIdError, NullPointerError, TagTooLongError, UnbalancedFreezeThawError, UnbalancedAtomicError, NotInitializedError, UnsupportedOperationError, UpgradeRequiredError, PathError, ) from .version import __VERSION__ __LICENSE__ = "GPL v3+" __AUTHOR__ = 'Sebastian Spaeth ' notmuch-0.23.7/bindings/python/notmuch/compat.py000066400000000000000000000044421305541522400217150ustar00rootroot00000000000000''' This file is part of notmuch. This module handles differences between python2.x and python3.x and allows the notmuch bindings to support both version families with one source tree. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth Copyright 2012 Justus Winter <4winter@informatik.uni-hamburg.de> ''' import sys if sys.version_info[0] == 2: from ConfigParser import SafeConfigParser class Python3StringMixIn(object): def __str__(self): return unicode(self).encode('utf-8') def encode_utf8(value): ''' Ensure a nicely utf-8 encoded string to pass to wrapped libnotmuch functions. C++ code expects strings to be well formatted and unicode strings to have no null bytes. ''' if not isinstance(value, basestring): raise TypeError('Expected str or unicode, got %s' % type(value)) if isinstance(value, unicode): return value.encode('utf-8', 'replace') return value else: from configparser import SafeConfigParser class Python3StringMixIn(object): def __str__(self): return self.__unicode__() def encode_utf8(value): ''' Ensure a nicely utf-8 encoded string to pass to wrapped libnotmuch functions. C++ code expects strings to be well formatted and unicode strings to have no null bytes. ''' if not isinstance(value, str): raise TypeError('Expected str, got %s' % type(value)) return value.encode('utf-8', 'replace') # We import the SafeConfigParser class on behalf of other code to cope # with the differences between Python 2 and 3. SafeConfigParser # avoid warning about unused import notmuch-0.23.7/bindings/python/notmuch/database.py000066400000000000000000000563301305541522400222010ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ import os import codecs from ctypes import c_char_p, c_void_p, c_uint, byref, POINTER from .compat import SafeConfigParser from .globals import ( nmlib, Enum, _str, NotmuchDatabaseP, NotmuchDirectoryP, NotmuchMessageP, NotmuchTagsP, ) from .errors import ( STATUS, FileError, NotmuchError, NullPointerError, NotInitializedError, ) from .message import Message from .tag import Tags from .query import Query from .directory import Directory class Database(object): """The :class:`Database` is the highest-level object that notmuch provides. It references a notmuch database, and can be opened in read-only or read-write mode. A :class:`Query` can be derived from or be applied to a specific database to find messages. Also adding and removing messages to the database happens via this object. Modifications to the database are not atmic by default (see :meth:`begin_atomic`) and once a database has been modified, all other database objects pointing to the same data-base will throw an :exc:`XapianError` as the underlying database has been modified. Close and reopen the database to continue working with it. :class:`Database` objects implement the context manager protocol so you can use the :keyword:`with` statement to ensure that the database is properly closed. See :meth:`close` for more information. .. note:: Any function in this class can and will throw an :exc:`NotInitializedError` if the database was not intitialized properly. """ _std_db_path = None """Class attribute to cache user's default database""" MODE = Enum(['READ_ONLY', 'READ_WRITE']) """Constants: Mode in which to open the database""" """notmuch_database_get_directory""" _get_directory = nmlib.notmuch_database_get_directory _get_directory.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(NotmuchDirectoryP)] _get_directory.restype = c_uint """notmuch_database_get_path""" _get_path = nmlib.notmuch_database_get_path _get_path.argtypes = [NotmuchDatabaseP] _get_path.restype = c_char_p """notmuch_database_get_version""" _get_version = nmlib.notmuch_database_get_version _get_version.argtypes = [NotmuchDatabaseP] _get_version.restype = c_uint """notmuch_database_open""" _open = nmlib.notmuch_database_open _open.argtypes = [c_char_p, c_uint, POINTER(NotmuchDatabaseP)] _open.restype = c_uint """notmuch_database_upgrade""" _upgrade = nmlib.notmuch_database_upgrade _upgrade.argtypes = [NotmuchDatabaseP, c_void_p, c_void_p] _upgrade.restype = c_uint """ notmuch_database_find_message""" _find_message = nmlib.notmuch_database_find_message _find_message.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(NotmuchMessageP)] _find_message.restype = c_uint """notmuch_database_find_message_by_filename""" _find_message_by_filename = nmlib.notmuch_database_find_message_by_filename _find_message_by_filename.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(NotmuchMessageP)] _find_message_by_filename.restype = c_uint """notmuch_database_get_all_tags""" _get_all_tags = nmlib.notmuch_database_get_all_tags _get_all_tags.argtypes = [NotmuchDatabaseP] _get_all_tags.restype = NotmuchTagsP """notmuch_database_create""" _create = nmlib.notmuch_database_create _create.argtypes = [c_char_p, POINTER(NotmuchDatabaseP)] _create.restype = c_uint def __init__(self, path = None, create = False, mode = MODE.READ_ONLY): """If *path* is `None`, we will try to read a users notmuch configuration and use his configured database. The location of the configuration file can be specified through the environment variable *NOTMUCH_CONFIG*, falling back to the default `~/.notmuch-config`. If *create* is `True`, the database will always be created in :attr:`MODE`.READ_WRITE mode. Default mode for opening is READ_ONLY. :param path: Directory to open/create the database in (see above for behavior if `None`) :type path: `str` or `None` :param create: Pass `False` to open an existing, `True` to create a new database. :type create: bool :param mode: Mode to open a database in. Is always :attr:`MODE`.READ_WRITE when creating a new one. :type mode: :attr:`MODE` :raises: :exc:`NotmuchError` or derived exception in case of failure. """ self._db = None self.mode = mode if path is None: # no path specified. use a user's default database if Database._std_db_path is None: #the following line throws a NotmuchError if it fails Database._std_db_path = self._get_user_default_db() path = Database._std_db_path if create == False: self.open(path, mode) else: self.create(path) _destroy = nmlib.notmuch_database_destroy _destroy.argtypes = [NotmuchDatabaseP] _destroy.restype = c_uint def __del__(self): if self._db: status = self._destroy(self._db) if status != STATUS.SUCCESS: raise NotmuchError(status) def _assert_db_is_initialized(self): """Raises :exc:`NotInitializedError` if self._db is `None`""" if not self._db: raise NotInitializedError() def create(self, path): """Creates a new notmuch database This function is used by __init__() and usually does not need to be called directly. It wraps the underlying *notmuch_database_create* function and creates a new notmuch database at *path*. It will always return a database in :attr:`MODE` .READ_WRITE mode as creating an empty database for reading only does not make a great deal of sense. :param path: A directory in which we should create the database. :type path: str :raises: :exc:`NotmuchError` in case of any failure (possibly after printing an error message on stderr). """ if self._db: raise NotmuchError(message="Cannot create db, this Database() " "already has an open one.") db = NotmuchDatabaseP() status = Database._create(_str(path), byref(db)) if status != STATUS.SUCCESS: raise NotmuchError(status) self._db = db return status def open(self, path, mode=0): """Opens an existing database This function is used by __init__() and usually does not need to be called directly. It wraps the underlying *notmuch_database_open* function. :param status: Open the database in read-only or read-write mode :type status: :attr:`MODE` :raises: Raises :exc:`NotmuchError` in case of any failure (possibly after printing an error message on stderr). """ db = NotmuchDatabaseP() status = Database._open(_str(path), mode, byref(db)) if status != STATUS.SUCCESS: raise NotmuchError(status) self._db = db return status _close = nmlib.notmuch_database_close _close.argtypes = [NotmuchDatabaseP] _close.restype = c_uint def close(self): ''' Closes the notmuch database. .. warning:: This function closes the notmuch database. From that point on every method invoked on any object ever derived from the closed database may cease to function and raise a NotmuchError. ''' if self._db: status = self._close(self._db) if status != STATUS.SUCCESS: raise NotmuchError(status) def __enter__(self): ''' Implements the context manager protocol. ''' return self def __exit__(self, exc_type, exc_value, traceback): ''' Implements the context manager protocol. ''' self.close() def get_path(self): """Returns the file path of an open database""" self._assert_db_is_initialized() return Database._get_path(self._db).decode('utf-8') def get_version(self): """Returns the database format version :returns: The database version as positive integer """ self._assert_db_is_initialized() return Database._get_version(self._db) _needs_upgrade = nmlib.notmuch_database_needs_upgrade _needs_upgrade.argtypes = [NotmuchDatabaseP] _needs_upgrade.restype = bool def needs_upgrade(self): """Does this database need to be upgraded before writing to it? If this function returns `True` then no functions that modify the database (:meth:`add_message`, :meth:`Message.add_tag`, :meth:`Directory.set_mtime`, etc.) will work unless :meth:`upgrade` is called successfully first. :returns: `True` or `False` """ self._assert_db_is_initialized() return self._needs_upgrade(self._db) def upgrade(self): """Upgrades the current database After opening a database in read-write mode, the client should check if an upgrade is needed (notmuch_database_needs_upgrade) and if so, upgrade with this function before making any modifications. NOT IMPLEMENTED: The optional progress_notify callback can be used by the caller to provide progress indication to the user. If non-NULL it will be called periodically with 'progress' as a floating-point value in the range of [0.0..1.0] indicating the progress made so far in the upgrade process. :TODO: catch exceptions, document return values and etc... """ self._assert_db_is_initialized() status = Database._upgrade(self._db, None, None) #TODO: catch exceptions, document return values and etc return status _begin_atomic = nmlib.notmuch_database_begin_atomic _begin_atomic.argtypes = [NotmuchDatabaseP] _begin_atomic.restype = c_uint def begin_atomic(self): """Begin an atomic database operation Any modifications performed between a successful :meth:`begin_atomic` and a :meth:`end_atomic` will be applied to the database atomically. Note that, unlike a typical database transaction, this only ensures atomicity, not durability; neither begin nor end necessarily flush modifications to disk. :returns: :attr:`STATUS`.SUCCESS or raises :raises: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION Xapian exception occurred; atomic section not entered. *Added in notmuch 0.9*""" self._assert_db_is_initialized() status = self._begin_atomic(self._db) if status != STATUS.SUCCESS: raise NotmuchError(status) return status _end_atomic = nmlib.notmuch_database_end_atomic _end_atomic.argtypes = [NotmuchDatabaseP] _end_atomic.restype = c_uint def end_atomic(self): """Indicate the end of an atomic database operation See :meth:`begin_atomic` for details. :returns: :attr:`STATUS`.SUCCESS or raises :raises: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION A Xapian exception occurred; atomic section not ended. :attr:`STATUS`.UNBALANCED_ATOMIC: end_atomic has been called more times than begin_atomic. *Added in notmuch 0.9*""" self._assert_db_is_initialized() status = self._end_atomic(self._db) if status != STATUS.SUCCESS: raise NotmuchError(status) return status def get_directory(self, path): """Returns a :class:`Directory` of path, :param path: An unicode string containing the path relative to the path of database (see :meth:`get_path`), or else should be an absolute path with initial components that match the path of 'database'. :returns: :class:`Directory` or raises an exception. :raises: :exc:`FileError` if path is not relative database or absolute with initial components same as database. """ self._assert_db_is_initialized() # sanity checking if path is valid, and make path absolute if path and path[0] == os.sep: # we got an absolute path if not path.startswith(self.get_path()): # but its initial components are not equal to the db path raise FileError('Database().get_directory() called ' 'with a wrong absolute path') abs_dirpath = path else: #we got a relative path, make it absolute abs_dirpath = os.path.abspath(os.path.join(self.get_path(), path)) dir_p = NotmuchDirectoryP() status = Database._get_directory(self._db, _str(path), byref(dir_p)) if status != STATUS.SUCCESS: raise NotmuchError(status) if not dir_p: return None # return the Directory, init it with the absolute path return Directory(abs_dirpath, dir_p, self) _add_message = nmlib.notmuch_database_add_message _add_message.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(NotmuchMessageP)] _add_message.restype = c_uint def add_message(self, filename, sync_maildir_flags=False): """Adds a new message to the database :param filename: should be a path relative to the path of the open database (see :meth:`get_path`), or else should be an absolute filename with initial components that match the path of the database. The file should be a single mail message (not a multi-message mbox) that is expected to remain at its current location, since the notmuch database will reference the filename, and will not copy the entire contents of the file. :param sync_maildir_flags: If the message contains Maildir flags, we will -depending on the notmuch configuration- sync those tags to initial notmuch tags, if set to `True`. It is `False` by default to remain consistent with the libnotmuch API. You might want to look into the underlying method :meth:`Message.maildir_flags_to_tags`. :returns: On success, we return 1) a :class:`Message` object that can be used for things such as adding tags to the just-added message. 2) one of the following :attr:`STATUS` values: :attr:`STATUS`.SUCCESS Message successfully added to database. :attr:`STATUS`.DUPLICATE_MESSAGE_ID Message has the same message ID as another message already in the database. The new filename was successfully added to the list of the filenames for the existing message. :rtype: 2-tuple(:class:`Message`, :attr:`STATUS`) :raises: Raises a :exc:`NotmuchError` with the following meaning. If such an exception occurs, nothing was added to the database. :attr:`STATUS`.FILE_ERROR An error occurred trying to open the file, (such as permission denied, or file not found, etc.). :attr:`STATUS`.FILE_NOT_EMAIL The contents of filename don't look like an email message. :attr:`STATUS`.READ_ONLY_DATABASE Database was opened in read-only mode so no message can be added. """ self._assert_db_is_initialized() msg_p = NotmuchMessageP() status = self._add_message(self._db, _str(filename), byref(msg_p)) if not status in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]: raise NotmuchError(status) #construct Message() and return msg = Message(msg_p, self) #automatic sync initial tags from Maildir flags if sync_maildir_flags: msg.maildir_flags_to_tags() return (msg, status) _remove_message = nmlib.notmuch_database_remove_message _remove_message.argtypes = [NotmuchDatabaseP, c_char_p] _remove_message.restype = c_uint def remove_message(self, filename): """Removes a message (filename) from the given notmuch database Note that only this particular filename association is removed from the database. If the same message (as determined by the message ID) is still available via other filenames, then the message will persist in the database for those filenames. When the last filename is removed for a particular message, the database content for that message will be entirely removed. :returns: A :attr:`STATUS` value with the following meaning: :attr:`STATUS`.SUCCESS The last filename was removed and the message was removed from the database. :attr:`STATUS`.DUPLICATE_MESSAGE_ID This filename was removed but the message persists in the database with at least one other filename. :raises: Raises a :exc:`NotmuchError` with the following meaning. If such an exception occurs, nothing was removed from the database. :attr:`STATUS`.READ_ONLY_DATABASE Database was opened in read-only mode so no message can be removed. """ self._assert_db_is_initialized() status = self._remove_message(self._db, _str(filename)) if status not in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]: raise NotmuchError(status) return status def find_message(self, msgid): """Returns a :class:`Message` as identified by its message ID Wraps the underlying *notmuch_database_find_message* function. :param msgid: The message ID :type msgid: unicode or str :returns: :class:`Message` or `None` if no message is found. :raises: :exc:`OutOfMemoryError` If an Out-of-memory occured while constructing the message. :exc:`XapianError` In case of a Xapian Exception. These exceptions include "Database modified" situations, e.g. when the notmuch database has been modified by another program in the meantime. In this case, you should close and reopen the database and retry. :exc:`NotInitializedError` if the database was not intitialized. """ self._assert_db_is_initialized() msg_p = NotmuchMessageP() status = Database._find_message(self._db, _str(msgid), byref(msg_p)) if status != STATUS.SUCCESS: raise NotmuchError(status) return msg_p and Message(msg_p, self) or None def find_message_by_filename(self, filename): """Find a message with the given filename :returns: If the database contains a message with the given filename, then a class:`Message:` is returned. This function returns None if no message is found with the given filename. :raises: :exc:`OutOfMemoryError` if an Out-of-memory occured while constructing the message. :raises: :exc:`XapianError` in case of a Xapian Exception. These exceptions include "Database modified" situations, e.g. when the notmuch database has been modified by another program in the meantime. In this case, you should close and reopen the database and retry. :raises: :exc:`NotInitializedError` if the database was not intitialized. *Added in notmuch 0.9*""" self._assert_db_is_initialized() msg_p = NotmuchMessageP() status = Database._find_message_by_filename(self._db, _str(filename), byref(msg_p)) if status != STATUS.SUCCESS: raise NotmuchError(status) return msg_p and Message(msg_p, self) or None def get_all_tags(self): """Returns :class:`Tags` with a list of all tags found in the database :returns: :class:`Tags` :execption: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER on error """ self._assert_db_is_initialized() tags_p = Database._get_all_tags(self._db) if not tags_p: raise NullPointerError() return Tags(tags_p, self) def create_query(self, querystring): """Returns a :class:`Query` derived from this database This is a shorthand method for doing:: # short version # Automatically frees the Database() when 'q' is deleted q = Database(dbpath).create_query('from:"Biene Maja"') # long version, which is functionally equivalent but will keep the # Database in the 'db' variable around after we delete 'q': db = Database(dbpath) q = Query(db,'from:"Biene Maja"') This function is a python extension and not in the underlying C API. """ return Query(self, querystring) """notmuch_database_status_string""" _status_string = nmlib.notmuch_database_status_string _status_string.argtypes = [NotmuchDatabaseP] _status_string.restype = c_char_p def status_string(self): """Returns the status string of the database This is sometimes used for additional error reporting """ self._assert_db_is_initialized() s = Database._status_string(self._db) if s: return s.decode('utf-8', 'ignore') return s def __repr__(self): return "'Notmuch DB " + self.get_path() + "'" def _get_user_default_db(self): """ Reads a user's notmuch config and returns his db location Throws a NotmuchError if it cannot find it""" config = SafeConfigParser() conf_f = os.getenv('NOTMUCH_CONFIG', os.path.expanduser('~/.notmuch-config')) config.readfp(codecs.open(conf_f, 'r', 'utf-8')) if not config.has_option('database', 'path'): raise NotmuchError(message="No DB path specified" " and no user default found") return config.get('database', 'path') notmuch-0.23.7/bindings/python/notmuch/directory.py000066400000000000000000000153271305541522400224420ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import c_uint, c_long from .globals import ( nmlib, NotmuchDirectoryP, NotmuchFilenamesP ) from .errors import ( STATUS, NotmuchError, NotInitializedError, ) from .filenames import Filenames class Directory(object): """Represents a directory entry in the notmuch directory Modifying attributes of this object will modify the database, not the real directory attributes. The Directory object is usually derived from another object e.g. via :meth:`Database.get_directory`, and will automatically be become invalid whenever that parent is deleted. You should therefore initialized this object handing it a reference to the parent, preventing the parent from automatically being garbage collected. """ """notmuch_directory_get_mtime""" _get_mtime = nmlib.notmuch_directory_get_mtime _get_mtime.argtypes = [NotmuchDirectoryP] _get_mtime.restype = c_long """notmuch_directory_set_mtime""" _set_mtime = nmlib.notmuch_directory_set_mtime _set_mtime.argtypes = [NotmuchDirectoryP, c_long] _set_mtime.restype = c_uint """notmuch_directory_get_child_files""" _get_child_files = nmlib.notmuch_directory_get_child_files _get_child_files.argtypes = [NotmuchDirectoryP] _get_child_files.restype = NotmuchFilenamesP """notmuch_directory_get_child_directories""" _get_child_directories = nmlib.notmuch_directory_get_child_directories _get_child_directories.argtypes = [NotmuchDirectoryP] _get_child_directories.restype = NotmuchFilenamesP def _assert_dir_is_initialized(self): """Raises a NotmuchError(:attr:`STATUS`.NOT_INITIALIZED) if dir_p is None""" if not self._dir_p: raise NotInitializedError() def __init__(self, path, dir_p, parent): """ :param path: The absolute path of the directory object. :param dir_p: The pointer to an internal notmuch_directory_t object. :param parent: The object this Directory is derived from (usually a :class:`Database`). We do not directly use this, but store a reference to it as long as this Directory object lives. This keeps the parent object alive. """ self._path = path self._dir_p = dir_p self._parent = parent def set_mtime(self, mtime): """Sets the mtime value of this directory in the database The intention is for the caller to use the mtime to allow efficient identification of new messages to be added to the database. The recommended usage is as follows: * Read the mtime of a directory from the filesystem * Call :meth:`Database.add_message` for all mail files in the directory * Call notmuch_directory_set_mtime with the mtime read from the filesystem. Then, when wanting to check for updates to the directory in the future, the client can call :meth:`get_mtime` and know that it only needs to add files if the mtime of the directory and files are newer than the stored timestamp. .. note:: :meth:`get_mtime` function does not allow the caller to distinguish a timestamp of 0 from a non-existent timestamp. So don't store a timestamp of 0 unless you are comfortable with that. :param mtime: A (time_t) timestamp :raises: :exc:`XapianError` a Xapian exception occurred, mtime not stored :raises: :exc:`ReadOnlyDatabaseError` the database was opened in read-only mode so directory mtime cannot be modified :raises: :exc:`NotInitializedError` the directory object has not been initialized """ self._assert_dir_is_initialized() status = Directory._set_mtime(self._dir_p, mtime) if status != STATUS.SUCCESS: raise NotmuchError(status) def get_mtime(self): """Gets the mtime value of this directory in the database Retrieves a previously stored mtime for this directory. :param mtime: A (time_t) timestamp :raises: :exc:`NotmuchError`: :attr:`STATUS`.NOT_INITIALIZED The directory has not been initialized """ self._assert_dir_is_initialized() return Directory._get_mtime(self._dir_p) # Make mtime attribute a property of Directory() mtime = property(get_mtime, set_mtime, doc="""Property that allows getting and setting of the Directory *mtime* (read-write) See :meth:`get_mtime` and :meth:`set_mtime` for usage and possible exceptions.""") def get_child_files(self): """Gets a Filenames iterator listing all the filenames of messages in the database within the given directory. The returned filenames will be the basename-entries only (not complete paths. """ self._assert_dir_is_initialized() files_p = Directory._get_child_files(self._dir_p) return Filenames(files_p, self) def get_child_directories(self): """Gets a :class:`Filenames` iterator listing all the filenames of sub-directories in the database within the given directory The returned filenames will be the basename-entries only (not complete paths. """ self._assert_dir_is_initialized() files_p = Directory._get_child_directories(self._dir_p) return Filenames(files_p, self) @property def path(self): """Returns the absolute path of this Directory (read-only)""" return self._path def __repr__(self): """Object representation""" return "" % self._path _destroy = nmlib.notmuch_directory_destroy _destroy.argtypes = [NotmuchDirectoryP] _destroy.restype = None def __del__(self): """Close and free the Directory""" if self._dir_p: self._destroy(self._dir_p) notmuch-0.23.7/bindings/python/notmuch/errors.py000066400000000000000000000145201305541522400217440ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import c_char_p, c_int from .globals import ( nmlib, Enum, Python3StringMixIn, ) class Status(Enum): """Enum with a string representation of a notmuch_status_t value.""" _status2str = nmlib.notmuch_status_to_string _status2str.restype = c_char_p _status2str.argtypes = [c_int] def __init__(self, statuslist): """It is initialized with a list of strings that are available as Status().string1 - Status().stringn attributes. """ super(Status, self).__init__(statuslist) @classmethod def status2str(self, status): """Get a (unicode) string representation of a notmuch_status_t value.""" # define strings for custom error messages if status == STATUS.NOT_INITIALIZED: return "Operation on uninitialized object impossible." return unicode(Status._status2str(status)) STATUS = Status(['SUCCESS', 'OUT_OF_MEMORY', 'READ_ONLY_DATABASE', 'XAPIAN_EXCEPTION', 'FILE_ERROR', 'FILE_NOT_EMAIL', 'DUPLICATE_MESSAGE_ID', 'NULL_POINTER', 'TAG_TOO_LONG', 'UNBALANCED_FREEZE_THAW', 'UNBALANCED_ATOMIC', 'UNSUPPORTED_OPERATION', 'UPGRADE_REQUIRED', 'PATH_ERROR', 'NOT_INITIALIZED']) """STATUS is a class, whose attributes provide constants that serve as return indicators for notmuch functions. Currently the following ones are defined. For possible return values and specific meaning for each method, see the method description. * SUCCESS * OUT_OF_MEMORY * READ_ONLY_DATABASE * XAPIAN_EXCEPTION * FILE_ERROR * FILE_NOT_EMAIL * DUPLICATE_MESSAGE_ID * NULL_POINTER * TAG_TOO_LONG * UNBALANCED_FREEZE_THAW * UNBALANCED_ATOMIC * UNSUPPORTED_OPERATION * UPGRADE_REQUIRED * PATH_ERROR * NOT_INITIALIZED Invoke the class method `notmuch.STATUS.status2str` with a status value as argument to receive a human readable string""" STATUS.__name__ = 'STATUS' class NotmuchError(Exception, Python3StringMixIn): """Is initiated with a (notmuch.STATUS[, message=None]). It will not return an instance of the class NotmuchError, but a derived instance of a more specific Error Message, e.g. OutOfMemoryError. Each status but SUCCESS has a corresponding subclassed Exception.""" @classmethod def get_exc_subclass(cls, status): """Returns a fine grained Exception() type, detailing the error status""" subclasses = { STATUS.OUT_OF_MEMORY: OutOfMemoryError, STATUS.READ_ONLY_DATABASE: ReadOnlyDatabaseError, STATUS.XAPIAN_EXCEPTION: XapianError, STATUS.FILE_ERROR: FileError, STATUS.FILE_NOT_EMAIL: FileNotEmailError, STATUS.DUPLICATE_MESSAGE_ID: DuplicateMessageIdError, STATUS.NULL_POINTER: NullPointerError, STATUS.TAG_TOO_LONG: TagTooLongError, STATUS.UNBALANCED_FREEZE_THAW: UnbalancedFreezeThawError, STATUS.UNBALANCED_ATOMIC: UnbalancedAtomicError, STATUS.UNSUPPORTED_OPERATION: UnsupportedOperationError, STATUS.UPGRADE_REQUIRED: UpgradeRequiredError, STATUS.PATH_ERROR: PathError, STATUS.NOT_INITIALIZED: NotInitializedError, } assert 0 < status <= len(subclasses) return subclasses[status] def __new__(cls, *args, **kwargs): """Return a correct subclass of NotmuchError if needed We return a NotmuchError instance if status is None (or 0) and a subclass that inherits from NotmuchError depending on the 'status' parameter otherwise.""" # get 'status'. Passed in as arg or kwarg? status = args[0] if len(args) else kwargs.get('status', None) # no 'status' or cls is subclass already, return 'cls' instance if not status or cls != NotmuchError: return super(NotmuchError, cls).__new__(cls) subclass = cls.get_exc_subclass(status) # which class to use? return subclass.__new__(subclass, *args, **kwargs) def __init__(self, status=None, message=None): self.status = status self.message = message def __unicode__(self): if self.message is not None: return self.message elif self.status is not None: return STATUS.status2str(self.status) else: return 'Unknown error' # List of Subclassed exceptions that correspond to STATUS values and are # subclasses of NotmuchError. class OutOfMemoryError(NotmuchError): status = STATUS.OUT_OF_MEMORY class ReadOnlyDatabaseError(NotmuchError): status = STATUS.READ_ONLY_DATABASE class XapianError(NotmuchError): status = STATUS.XAPIAN_EXCEPTION class FileError(NotmuchError): status = STATUS.FILE_ERROR class FileNotEmailError(NotmuchError): status = STATUS.FILE_NOT_EMAIL class DuplicateMessageIdError(NotmuchError): status = STATUS.DUPLICATE_MESSAGE_ID class NullPointerError(NotmuchError): status = STATUS.NULL_POINTER class TagTooLongError(NotmuchError): status = STATUS.TAG_TOO_LONG class UnbalancedFreezeThawError(NotmuchError): status = STATUS.UNBALANCED_FREEZE_THAW class UnbalancedAtomicError(NotmuchError): status = STATUS.UNBALANCED_ATOMIC class UnsupportedOperationError(NotmuchError): status = STATUS.UNSUPPORTED_OPERATION class UpgradeRequiredError(NotmuchError): status = STATUS.UPGRADE_REQUIRED class PathError(NotmuchError): status = STATUS.PATH_ERROR class NotInitializedError(NotmuchError): """Derived from NotmuchError, this occurs if the underlying data structure (e.g. database is not initialized (yet) or an iterator has been exhausted. You can test for NotmuchError with .status = STATUS.NOT_INITIALIZED""" status = STATUS.NOT_INITIALIZED notmuch-0.23.7/bindings/python/notmuch/filenames.py000066400000000000000000000103011305541522400223640ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import c_char_p from .globals import ( nmlib, NotmuchFilenamesP, Python3StringMixIn, ) from .errors import ( NullPointerError, NotInitializedError, ) class Filenames(Python3StringMixIn): """Represents a list of filenames as returned by notmuch Objects of this class implement the iterator protocol. .. note:: The underlying library only provides a one-time iterator (it cannot reset the iterator to the start). Thus iterating over the function will "exhaust" the list of tags, and a subsequent iteration attempt will raise a :exc:`NotInitializedError`. Also note, that any function that uses iteration (nearly all) will also exhaust the tags. So both:: for name in filenames: print name as well as:: list_of_names = list(names) and even a simple:: #str() iterates over all tags to construct a space separated list print(str(filenames)) will "exhaust" the Filenames. However, you can use :meth:`Message.get_filenames` repeatedly to get fresh Filenames objects to perform various actions on filenames. """ #notmuch_filenames_get _get = nmlib.notmuch_filenames_get _get.argtypes = [NotmuchFilenamesP] _get.restype = c_char_p def __init__(self, files_p, parent): """ :param files_p: A pointer to an underlying *notmuch_tags_t* structure. These are not publically exposed, so a user will almost never instantiate a :class:`Tags` object herself. They are usually handed back as a result, e.g. in :meth:`Database.get_all_tags`. *tags_p* must be valid, we will raise an :exc:`NullPointerError` if it is `None`. :type files_p: :class:`ctypes.c_void_p` :param parent: The parent object (ie :class:`Message` these filenames are derived from, and saves a reference to it, so we can automatically delete the db object once all derived objects are dead. """ if not files_p: raise NullPointerError() self._files_p = files_p #save reference to parent object so we keep it alive self._parent = parent def __iter__(self): """ Make Filenames an iterator """ return self _valid = nmlib.notmuch_filenames_valid _valid.argtypes = [NotmuchFilenamesP] _valid.restype = bool _move_to_next = nmlib.notmuch_filenames_move_to_next _move_to_next.argtypes = [NotmuchFilenamesP] _move_to_next.restype = None def __next__(self): if not self._files_p: raise NotInitializedError() if not self._valid(self._files_p): self._files_p = None raise StopIteration file_ = Filenames._get(self._files_p) self._move_to_next(self._files_p) return file_.decode('utf-8', 'ignore') next = __next__ # python2.x iterator protocol compatibility def __unicode__(self): """Represent Filenames() as newline-separated list of full paths .. note:: This method exhausts the iterator object, so you will not be able to iterate over them again. """ return "\n".join(self) _destroy = nmlib.notmuch_filenames_destroy _destroy.argtypes = [NotmuchFilenamesP] _destroy.restype = None def __del__(self): """Close and free the notmuch filenames""" if self._files_p: self._destroy(self._files_p) notmuch-0.23.7/bindings/python/notmuch/globals.py000066400000000000000000000045021305541522400220520ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import CDLL, Structure, POINTER from notmuch.version import SOVERSION #----------------------------------------------------------------------------- #package-global instance of the notmuch library try: from os import uname if uname()[0] == 'Darwin': nmlib = CDLL("libnotmuch.{0:s}.dylib".format(SOVERSION)) else: nmlib = CDLL("libnotmuch.so.{0:s}".format(SOVERSION)) except: raise ImportError("Could not find shared 'notmuch' library.") from .compat import Python3StringMixIn, encode_utf8 as _str # We import these on behalf of other modules. Silence warning about # these symbols not being used. Python3StringMixIn _str class Enum(object): """Provides ENUMS as "code=Enum(['a','b','c'])" where code.a=0 etc...""" def __init__(self, names): for number, name in enumerate(names): setattr(self, name, number) class NotmuchDatabaseS(Structure): pass NotmuchDatabaseP = POINTER(NotmuchDatabaseS) class NotmuchQueryS(Structure): pass NotmuchQueryP = POINTER(NotmuchQueryS) class NotmuchThreadsS(Structure): pass NotmuchThreadsP = POINTER(NotmuchThreadsS) class NotmuchThreadS(Structure): pass NotmuchThreadP = POINTER(NotmuchThreadS) class NotmuchMessagesS(Structure): pass NotmuchMessagesP = POINTER(NotmuchMessagesS) class NotmuchMessageS(Structure): pass NotmuchMessageP = POINTER(NotmuchMessageS) class NotmuchTagsS(Structure): pass NotmuchTagsP = POINTER(NotmuchTagsS) class NotmuchDirectoryS(Structure): pass NotmuchDirectoryP = POINTER(NotmuchDirectoryS) class NotmuchFilenamesS(Structure): pass NotmuchFilenamesP = POINTER(NotmuchFilenamesS) notmuch-0.23.7/bindings/python/notmuch/message.py000066400000000000000000000560161305541522400220620ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth Jesse Rosenthal """ from ctypes import c_char_p, c_long, c_uint, c_int from datetime import date from .globals import ( nmlib, Enum, _str, Python3StringMixIn, NotmuchTagsP, NotmuchMessageP, NotmuchMessagesP, NotmuchFilenamesP, ) from .errors import ( STATUS, NotmuchError, NullPointerError, NotInitializedError, ) from .tag import Tags from .filenames import Filenames import email class Message(Python3StringMixIn): """Represents a single Email message Technically, this wraps the underlying *notmuch_message_t* structure. A user will usually not create these objects themselves but get them as search results. As it implements :meth:`__cmp__`, it is possible to compare two :class:`Message`\s using `if msg1 == msg2: ...`. """ """notmuch_message_get_filename (notmuch_message_t *message)""" _get_filename = nmlib.notmuch_message_get_filename _get_filename.argtypes = [NotmuchMessageP] _get_filename.restype = c_char_p """return all filenames for a message""" _get_filenames = nmlib.notmuch_message_get_filenames _get_filenames.argtypes = [NotmuchMessageP] _get_filenames.restype = NotmuchFilenamesP """notmuch_message_get_flag""" _get_flag = nmlib.notmuch_message_get_flag _get_flag.argtypes = [NotmuchMessageP, c_uint] _get_flag.restype = bool """notmuch_message_set_flag""" _set_flag = nmlib.notmuch_message_set_flag _set_flag.argtypes = [NotmuchMessageP, c_uint, c_int] _set_flag.restype = None """notmuch_message_get_message_id (notmuch_message_t *message)""" _get_message_id = nmlib.notmuch_message_get_message_id _get_message_id.argtypes = [NotmuchMessageP] _get_message_id.restype = c_char_p """notmuch_message_get_thread_id""" _get_thread_id = nmlib.notmuch_message_get_thread_id _get_thread_id.argtypes = [NotmuchMessageP] _get_thread_id.restype = c_char_p """notmuch_message_get_replies""" _get_replies = nmlib.notmuch_message_get_replies _get_replies.argtypes = [NotmuchMessageP] _get_replies.restype = NotmuchMessagesP """notmuch_message_get_tags (notmuch_message_t *message)""" _get_tags = nmlib.notmuch_message_get_tags _get_tags.argtypes = [NotmuchMessageP] _get_tags.restype = NotmuchTagsP _get_date = nmlib.notmuch_message_get_date _get_date.argtypes = [NotmuchMessageP] _get_date.restype = c_long _get_header = nmlib.notmuch_message_get_header _get_header.argtypes = [NotmuchMessageP, c_char_p] _get_header.restype = c_char_p """notmuch_status_t ..._maildir_flags_to_tags (notmuch_message_t *)""" _tags_to_maildir_flags = nmlib.notmuch_message_tags_to_maildir_flags _tags_to_maildir_flags.argtypes = [NotmuchMessageP] _tags_to_maildir_flags.restype = c_int """notmuch_status_t ..._tags_to_maildir_flags (notmuch_message_t *)""" _maildir_flags_to_tags = nmlib.notmuch_message_maildir_flags_to_tags _maildir_flags_to_tags.argtypes = [NotmuchMessageP] _maildir_flags_to_tags.restype = c_int #Constants: Flags that can be set/get with set_flag FLAG = Enum(['MATCH']) def __init__(self, msg_p, parent=None): """ :param msg_p: A pointer to an internal notmuch_message_t Structure. If it is `None`, we will raise an :exc:`NullPointerError`. :param parent: A 'parent' object is passed which this message is derived from. We save a reference to it, so we can automatically delete the parent object once all derived objects are dead. """ if not msg_p: raise NullPointerError() self._msg = msg_p #keep reference to parent, so we keep it alive self._parent = parent def get_message_id(self): """Returns the message ID :returns: String with a message ID :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() return Message._get_message_id(self._msg).decode('utf-8', 'ignore') def get_thread_id(self): """Returns the thread ID The returned string belongs to 'message' will only be valid for as long as the message is valid. This function will not return `None` since Notmuch ensures that every message belongs to a single thread. :returns: String with a thread ID :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() return Message._get_thread_id(self._msg).decode('utf-8', 'ignore') def get_replies(self): """Gets all direct replies to this message as :class:`Messages` iterator .. note:: This call only makes sense if 'message' was ultimately obtained from a :class:`Thread` object, (such as by coming directly from the result of calling :meth:`Thread.get_toplevel_messages` or by any number of subsequent calls to :meth:`get_replies`). If this message was obtained through some non-thread means, (such as by a call to :meth:`Query.search_messages`), then this function will return an empty Messages iterator. :returns: :class:`Messages`. :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() msgs_p = Message._get_replies(self._msg) from .messages import Messages, EmptyMessagesResult if not msgs_p: return EmptyMessagesResult(self) return Messages(msgs_p, self) def get_date(self): """Returns time_t of the message date For the original textual representation of the Date header from the message call notmuch_message_get_header() with a header value of "date". :returns: A time_t timestamp. :rtype: c_unit64 :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() return Message._get_date(self._msg) def get_header(self, header): """Get the value of the specified header. The value will be read from the actual message file, not from the notmuch database. The header name is case insensitive. Returns an empty string ("") if the message does not contain a header line matching 'header'. :param header: The name of the header to be retrieved. It is not case-sensitive. :type header: str :returns: The header value as string :raises: :exc:`NotInitializedError` if the message is not initialized :raises: :exc:`NullPointerError` if any error occured """ if not self._msg: raise NotInitializedError() #Returns NULL if any error occurs. header = Message._get_header(self._msg, _str(header)) if header == None: raise NullPointerError() return header.decode('UTF-8', 'ignore') def get_filename(self): """Returns the file path of the message file :returns: Absolute file path & name of the message file :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() return Message._get_filename(self._msg).decode('utf-8', 'ignore') def get_filenames(self): """Get all filenames for the email corresponding to 'message' Returns a Filenames() generator with all absolute filepaths for messages recorded to have the same Message-ID. These files must not necessarily have identical content.""" if not self._msg: raise NotInitializedError() files_p = Message._get_filenames(self._msg) return Filenames(files_p, self) def get_flag(self, flag): """Checks whether a specific flag is set for this message The method :meth:`Query.search_threads` sets *Message.FLAG.MATCH* for those messages that match the query. This method allows us to get the value of this flag. :param flag: One of the :attr:`Message.FLAG` values (currently only *Message.FLAG.MATCH* :returns: An unsigned int (0/1), indicating whether the flag is set. :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() return Message._get_flag(self._msg, flag) def set_flag(self, flag, value): """Sets/Unsets a specific flag for this message :param flag: One of the :attr:`Message.FLAG` values (currently only *Message.FLAG.MATCH* :param value: A bool indicating whether to set or unset the flag. :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._msg: raise NotInitializedError() self._set_flag(self._msg, flag, value) def get_tags(self): """Returns the message tags :returns: A :class:`Tags` iterator. :raises: :exc:`NotInitializedError` if the message is not initialized :raises: :exc:`NullPointerError` if any error occured """ if not self._msg: raise NotInitializedError() tags_p = Message._get_tags(self._msg) if not tags_p: raise NullPointerError() return Tags(tags_p, self) _add_tag = nmlib.notmuch_message_add_tag _add_tag.argtypes = [NotmuchMessageP, c_char_p] _add_tag.restype = c_uint def add_tag(self, tag, sync_maildir_flags=False): """Adds a tag to the given message Adds a tag to the current message. The maximal tag length is defined in the notmuch library and is currently 200 bytes. :param tag: String with a 'tag' to be added. :param sync_maildir_flags: If notmuch configuration is set to do this, add maildir flags corresponding to notmuch tags. See underlying method :meth:`tags_to_maildir_flags`. Use False if you want to add/remove many tags on a message without having to physically rename the file every time. Do note, that this will do nothing when a message is frozen, as tag changes will not be committed to the database yet. :returns: STATUS.SUCCESS if the tag was successfully added. Raises an exception otherwise. :raises: :exc:`NullPointerError` if the `tag` argument is NULL :raises: :exc:`TagTooLongError` if the length of `tag` exceeds Message.NOTMUCH_TAG_MAX) :raises: :exc:`ReadOnlyDatabaseError` if the database was opened in read-only mode so message cannot be modified :raises: :exc:`NotInitializedError` if message has not been initialized """ if not self._msg: raise NotInitializedError() status = self._add_tag(self._msg, _str(tag)) # bail out on failure if status != STATUS.SUCCESS: raise NotmuchError(status) if sync_maildir_flags: self.tags_to_maildir_flags() return STATUS.SUCCESS _remove_tag = nmlib.notmuch_message_remove_tag _remove_tag.argtypes = [NotmuchMessageP, c_char_p] _remove_tag.restype = c_uint def remove_tag(self, tag, sync_maildir_flags=False): """Removes a tag from the given message If the message has no such tag, this is a non-operation and will report success anyway. :param tag: String with a 'tag' to be removed. :param sync_maildir_flags: If notmuch configuration is set to do this, add maildir flags corresponding to notmuch tags. See underlying method :meth:`tags_to_maildir_flags`. Use False if you want to add/remove many tags on a message without having to physically rename the file every time. Do note, that this will do nothing when a message is frozen, as tag changes will not be committed to the database yet. :returns: STATUS.SUCCESS if the tag was successfully removed or if the message had no such tag. Raises an exception otherwise. :raises: :exc:`NullPointerError` if the `tag` argument is NULL :raises: :exc:`TagTooLongError` if the length of `tag` exceeds Message.NOTMUCH_TAG_MAX) :raises: :exc:`ReadOnlyDatabaseError` if the database was opened in read-only mode so message cannot be modified :raises: :exc:`NotInitializedError` if message has not been initialized """ if not self._msg: raise NotInitializedError() status = self._remove_tag(self._msg, _str(tag)) # bail out on error if status != STATUS.SUCCESS: raise NotmuchError(status) if sync_maildir_flags: self.tags_to_maildir_flags() return STATUS.SUCCESS _remove_all_tags = nmlib.notmuch_message_remove_all_tags _remove_all_tags.argtypes = [NotmuchMessageP] _remove_all_tags.restype = c_uint def remove_all_tags(self, sync_maildir_flags=False): """Removes all tags from the given message. See :meth:`freeze` for an example showing how to safely replace tag values. :param sync_maildir_flags: If notmuch configuration is set to do this, add maildir flags corresponding to notmuch tags. See :meth:`tags_to_maildir_flags`. Use False if you want to add/remove many tags on a message without having to physically rename the file every time. Do note, that this will do nothing when a message is frozen, as tag changes will not be committed to the database yet. :returns: STATUS.SUCCESS if the tags were successfully removed. Raises an exception otherwise. :raises: :exc:`ReadOnlyDatabaseError` if the database was opened in read-only mode so message cannot be modified :raises: :exc:`NotInitializedError` if message has not been initialized """ if not self._msg: raise NotInitializedError() status = self._remove_all_tags(self._msg) # bail out on error if status != STATUS.SUCCESS: raise NotmuchError(status) if sync_maildir_flags: self.tags_to_maildir_flags() return STATUS.SUCCESS _freeze = nmlib.notmuch_message_freeze _freeze.argtypes = [NotmuchMessageP] _freeze.restype = c_uint def freeze(self): """Freezes the current state of 'message' within the database This means that changes to the message state, (via :meth:`add_tag`, :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be committed to the database until the message is :meth:`thaw` ed. Multiple calls to freeze/thaw are valid and these calls will "stack". That is there must be as many calls to thaw as to freeze before a message is actually thawed. The ability to do freeze/thaw allows for safe transactions to change tag values. For example, explicitly setting a message to have a given set of tags might look like this:: msg.freeze() msg.remove_all_tags(False) for tag in new_tags: msg.add_tag(tag, False) msg.thaw() msg.tags_to_maildir_flags() With freeze/thaw used like this, the message in the database is guaranteed to have either the full set of original tag values, or the full set of new tag values, but nothing in between. Imagine the example above without freeze/thaw and the operation somehow getting interrupted. This could result in the message being left with no tags if the interruption happened after :meth:`remove_all_tags` but before :meth:`add_tag`. :returns: STATUS.SUCCESS if the message was successfully frozen. Raises an exception otherwise. :raises: :exc:`ReadOnlyDatabaseError` if the database was opened in read-only mode so message cannot be modified :raises: :exc:`NotInitializedError` if message has not been initialized """ if not self._msg: raise NotInitializedError() status = self._freeze(self._msg) if STATUS.SUCCESS == status: # return on success return status raise NotmuchError(status) _thaw = nmlib.notmuch_message_thaw _thaw.argtypes = [NotmuchMessageP] _thaw.restype = c_uint def thaw(self): """Thaws the current 'message' Thaw the current 'message', synchronizing any changes that may have occurred while 'message' was frozen into the notmuch database. See :meth:`freeze` for an example of how to use this function to safely provide tag changes. Multiple calls to freeze/thaw are valid and these calls with "stack". That is there must be as many calls to thaw as to freeze before a message is actually thawed. :returns: STATUS.SUCCESS if the message was successfully frozen. Raises an exception otherwise. :raises: :exc:`UnbalancedFreezeThawError` if an attempt was made to thaw an unfrozen message. That is, there have been an unbalanced number of calls to :meth:`freeze` and :meth:`thaw`. :raises: :exc:`NotInitializedError` if message has not been initialized """ if not self._msg: raise NotInitializedError() status = self._thaw(self._msg) if STATUS.SUCCESS == status: # return on success return status raise NotmuchError(status) def is_match(self): """(Not implemented)""" return self.get_flag(Message.FLAG.MATCH) def tags_to_maildir_flags(self): """Synchronize notmuch tags to file Maildir flags 'D' if the message has the "draft" tag 'F' if the message has the "flagged" tag 'P' if the message has the "passed" tag 'R' if the message has the "replied" tag 'S' if the message does not have the "unread" tag Any existing flags unmentioned in the list above will be preserved in the renaming. Also, if this filename is in a directory named "new", rename it to be within the neighboring directory named "cur". Do note that calling this method while a message is frozen might not work yet, as the modified tags have not been committed yet to the database. :returns: a :class:`STATUS` value. In short, you want to see notmuch.STATUS.SUCCESS here. See there for details.""" if not self._msg: raise NotInitializedError() return Message._tags_to_maildir_flags(self._msg) def maildir_flags_to_tags(self): """Synchronize file Maildir flags to notmuch tags Flag Action if present ---- ----------------- 'D' Adds the "draft" tag to the message 'F' Adds the "flagged" tag to the message 'P' Adds the "passed" tag to the message 'R' Adds the "replied" tag to the message 'S' Removes the "unread" tag from the message For each flag that is not present, the opposite action (add/remove) is performed for the corresponding tags. If there are multiple filenames associated with this message, the flag is considered present if it appears in one or more filenames. (That is, the flags from the multiple filenames are combined with the logical OR operator.) As a convenience, you can set the sync_maildir_flags parameter in :meth:`Database.add_message` to implicitly call this. :returns: a :class:`STATUS`. In short, you want to see notmuch.STATUS.SUCCESS here. See there for details.""" if not self._msg: raise NotInitializedError() return Message._maildir_flags_to_tags(self._msg) def __repr__(self): """Represent a Message() object by str()""" return self.__str__() def __unicode__(self): format = "%s (%s) (%s)" return format % (self.get_header('from'), self.get_tags(), date.fromtimestamp(self.get_date()), ) def get_message_parts(self): """Output like notmuch show""" fp = open(self.get_filename()) email_msg = email.message_from_file(fp) fp.close() out = [] for msg in email_msg.walk(): if not msg.is_multipart(): out.append(msg) return out def get_part(self, num): """Returns the nth message body part""" parts = self.get_message_parts() if (num <= 0 or num > len(parts)): return "" else: out_part = parts[(num - 1)] return out_part.get_payload(decode=True) def __hash__(self): """Implement hash(), so we can use Message() sets""" file = self.get_filename() if not file: return None return hash(file) def __cmp__(self, other): """Implement cmp(), so we can compare Message()s 2 messages are considered equal if they point to the same Message-Id and if they point to the same file names. If 2 Messages derive from different queries where some files have been added or removed, the same messages would not be considered equal (as they do not point to the same set of files any more).""" res = cmp(self.get_message_id(), other.get_message_id()) if res: res = cmp(list(self.get_filenames()), list(other.get_filenames())) return res _destroy = nmlib.notmuch_message_destroy _destroy.argtypes = [NotmuchMessageP] _destroy.restype = None def __del__(self): """Close and free the notmuch Message""" if self._msg: self._destroy(self._msg) notmuch-0.23.7/bindings/python/notmuch/messages.py000066400000000000000000000155611305541522400222450ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth Jesse Rosenthal """ from .globals import ( nmlib, NotmuchTagsP, NotmuchMessageP, NotmuchMessagesP, ) from .errors import ( NullPointerError, NotInitializedError, ) from .tag import Tags from .message import Message class Messages(object): """Represents a list of notmuch messages This object provides an iterator over a list of notmuch messages (Technically, it provides a wrapper for the underlying *notmuch_messages_t* structure). Do note that the underlying library only provides a one-time iterator (it cannot reset the iterator to the start). Thus iterating over the function will "exhaust" the list of messages, and a subsequent iteration attempt will raise a :exc:`NotInitializedError`. If you need to re-iterate over a list of messages you will need to retrieve a new :class:`Messages` object or cache your :class:`Message`\s in a list via:: msglist = list(msgs) You can store and reuse the single :class:`Message` objects as often as you want as long as you keep the parent :class:`Messages` object around. (Due to hierarchical memory allocation, all derived :class:`Message` objects will be invalid when we delete the parent :class:`Messages` object, even if it was already exhausted.) So this works:: db = Database() msgs = Query(db,'').search_messages() #get a Messages() object msglist = list(msgs) # msgs is "exhausted" now and msgs.next() will raise an exception. # However it will be kept alive until all retrieved Message() # objects are also deleted. If you do e.g. an explicit del(msgs) # here, the following lines would fail. # You can reiterate over *msglist* however as often as you want. # It is simply a list with :class:`Message`s. print (msglist[0].get_filename()) print (msglist[1].get_filename()) print (msglist[0].get_message_id()) As :class:`Message` implements both __hash__() and __cmp__(), it is possible to make sets out of :class:`Messages` and use set arithmetic (this happens in python and will of course be *much* slower than redoing a proper query with the appropriate filters:: s1, s2 = set(msgs1), set(msgs2) s.union(s2) s1 -= s2 ... Be careful when using set arithmetic between message sets derived from different Databases (ie the same database reopened after messages have changed). If messages have added or removed associated files in the meantime, it is possible that the same message would be considered as a different object (as it points to a different file). """ #notmuch_messages_get _get = nmlib.notmuch_messages_get _get.argtypes = [NotmuchMessagesP] _get.restype = NotmuchMessageP _collect_tags = nmlib.notmuch_messages_collect_tags _collect_tags.argtypes = [NotmuchMessagesP] _collect_tags.restype = NotmuchTagsP def __init__(self, msgs_p, parent=None): """ :param msgs_p: A pointer to an underlying *notmuch_messages_t* structure. These are not publically exposed, so a user will almost never instantiate a :class:`Messages` object herself. They are usually handed back as a result, e.g. in :meth:`Query.search_messages`. *msgs_p* must be valid, we will raise an :exc:`NullPointerError` if it is `None`. :type msgs_p: :class:`ctypes.c_void_p` :param parent: The parent object (ie :class:`Query`) these tags are derived from. It saves a reference to it, so we can automatically delete the db object once all derived objects are dead. :TODO: Make the iterator work more than once and cache the tags in the Python object.(?) """ if not msgs_p: raise NullPointerError() self._msgs = msgs_p #store parent, so we keep them alive as long as self is alive self._parent = parent def collect_tags(self): """Return the unique :class:`Tags` in the contained messages :returns: :class:`Tags` :exceptions: :exc:`NotInitializedError` if not init'ed .. note:: :meth:`collect_tags` will iterate over the messages and therefore will not allow further iterations. """ if not self._msgs: raise NotInitializedError() # collect all tags (returns NULL on error) tags_p = Messages._collect_tags(self._msgs) #reset _msgs as we iterated over it and can do so only once self._msgs = None if not tags_p: raise NullPointerError() return Tags(tags_p, self) def __iter__(self): """ Make Messages an iterator """ return self _valid = nmlib.notmuch_messages_valid _valid.argtypes = [NotmuchMessagesP] _valid.restype = bool _move_to_next = nmlib.notmuch_messages_move_to_next _move_to_next.argtypes = [NotmuchMessagesP] _move_to_next.restype = None def __next__(self): if not self._msgs: raise NotInitializedError() if not self._valid(self._msgs): self._msgs = None raise StopIteration msg = Message(Messages._get(self._msgs), self) self._move_to_next(self._msgs) return msg next = __next__ # python2.x iterator protocol compatibility def __nonzero__(self): ''' Implement truth value testing. If __nonzero__ is not implemented, the python runtime would fall back to `len(..) > 0` thus exhausting the iterator. :returns: True if the wrapped iterator has at least one more object left. ''' return self._msgs and self._valid(self._msgs) _destroy = nmlib.notmuch_messages_destroy _destroy.argtypes = [NotmuchMessagesP] _destroy.restype = None def __del__(self): """Close and free the notmuch Messages""" if self._msgs: self._destroy(self._msgs) class EmptyMessagesResult(Messages): def __init__(self, parent): self._msgs = None self._parent = parent def __next__(self): raise StopIteration() next = __next__ notmuch-0.23.7/bindings/python/notmuch/query.py000066400000000000000000000200621305541522400215730ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import c_char_p, c_uint, POINTER, byref from .globals import ( nmlib, Enum, _str, NotmuchQueryP, NotmuchThreadsP, NotmuchDatabaseP, NotmuchMessagesP, ) from .errors import ( NotmuchError, NullPointerError, NotInitializedError, ) from .threads import Threads from .messages import Messages class Query(object): """Represents a search query on an opened :class:`Database`. A query selects and filters a subset of messages from the notmuch database we derive from. :class:`Query` provides an instance attribute :attr:`sort`, which contains the sort order (if specified via :meth:`set_sort`) or `None`. Any function in this class may throw an :exc:`NotInitializedError` in case the underlying query object was not set up correctly. .. note:: Do remember that as soon as we tear down this object, all underlying derived objects such as threads, messages, tags etc will be freed by the underlying library as well. Accessing these objects will lead to segfaults and other unexpected behavior. See above for more details. """ # constants SORT = Enum(['OLDEST_FIRST', 'NEWEST_FIRST', 'MESSAGE_ID', 'UNSORTED']) """Constants: Sort order in which to return results""" def __init__(self, db, querystr): """ :param db: An open database which we derive the Query from. :type db: :class:`Database` :param querystr: The query string for the message. :type querystr: utf-8 encoded str or unicode """ self._db = None self._query = None self.sort = None self.create(db, querystr) def _assert_query_is_initialized(self): """Raises :exc:`NotInitializedError` if self._query is `None`""" if not self._query: raise NotInitializedError() """notmuch_query_create""" _create = nmlib.notmuch_query_create _create.argtypes = [NotmuchDatabaseP, c_char_p] _create.restype = NotmuchQueryP def create(self, db, querystr): """Creates a new query derived from a Database This function is utilized by __init__() and usually does not need to be called directly. :param db: Database to create the query from. :type db: :class:`Database` :param querystr: The query string :type querystr: utf-8 encoded str or unicode :raises: :exc:`NullPointerError` if the query creation failed (e.g. too little memory). :exc:`NotInitializedError` if the underlying db was not intitialized. """ db._assert_db_is_initialized() # create reference to parent db to keep it alive self._db = db # create query, return None if too little mem available query_p = Query._create(db._db, _str(querystr)) if not query_p: raise NullPointerError self._query = query_p _set_sort = nmlib.notmuch_query_set_sort _set_sort.argtypes = [NotmuchQueryP, c_uint] _set_sort.argtypes = None def set_sort(self, sort): """Set the sort order future results will be delivered in :param sort: Sort order (see :attr:`Query.SORT`) """ self._assert_query_is_initialized() self.sort = sort self._set_sort(self._query, sort) _exclude_tag = nmlib.notmuch_query_add_tag_exclude _exclude_tag.argtypes = [NotmuchQueryP, c_char_p] _exclude_tag.resttype = None def exclude_tag(self, tagname): """Add a tag that will be excluded from the query results by default. This exclusion will be overridden if this tag appears explicitly in the query. :param tagname: Name of the tag to be excluded """ self._assert_query_is_initialized() self._exclude_tag(self._query, _str(tagname)) """notmuch_query_search_threads_st""" _search_threads_st = nmlib.notmuch_query_search_threads_st _search_threads_st.argtypes = [NotmuchQueryP, POINTER(NotmuchThreadsP)] _search_threads_st.restype = c_uint def search_threads(self): """Execute a query for threads Execute a query for threads, returning a :class:`Threads` iterator. The returned threads are owned by the query and as such, will only be valid until the Query is deleted. The method sets :attr:`Message.FLAG`\.MATCH for those messages that match the query. The method :meth:`Message.get_flag` allows us to get the value of this flag. :returns: :class:`Threads` :raises: :exc:`NullPointerError` if search_threads failed """ self._assert_query_is_initialized() threads_p = NotmuchThreadsP() # == NULL status = Query._search_threads_st(self._query, byref(threads_p)) if status != 0: raise NotmuchError(status) if not threads_p: raise NullPointerError return Threads(threads_p, self) """notmuch_query_search_messages_st""" _search_messages_st = nmlib.notmuch_query_search_messages_st _search_messages_st.argtypes = [NotmuchQueryP, POINTER(NotmuchMessagesP)] _search_messages_st.restype = c_uint def search_messages(self): """Filter messages according to the query and return :class:`Messages` in the defined sort order :returns: :class:`Messages` :raises: :exc:`NullPointerError` if search_messages failed """ self._assert_query_is_initialized() msgs_p = NotmuchMessagesP() # == NULL status = Query._search_messages_st(self._query, byref(msgs_p)) if status != 0: raise NotmuchError(status) if not msgs_p: raise NullPointerError return Messages(msgs_p, self) _count_messages = nmlib.notmuch_query_count_messages_st _count_messages.argtypes = [NotmuchQueryP, POINTER(c_uint)] _count_messages.restype = c_uint def count_messages(self): ''' This function performs a search and returns Xapian's best guess as to the number of matching messages. :returns: the estimated number of messages matching this query :rtype: int ''' self._assert_query_is_initialized() count = c_uint(0) status = Query._count_messages(self._query, byref(count)) if status != 0: raise NotmuchError(status) return count.value _count_threads = nmlib.notmuch_query_count_threads_st _count_threads.argtypes = [NotmuchQueryP, POINTER(c_uint)] _count_threads.restype = c_uint def count_threads(self): ''' This function performs a search and returns the number of unique thread IDs in the matching messages. This is the same as number of threads matching a search. Note that this is a significantly heavier operation than meth:`Query.count_messages`. :returns: the number of threads returned by this query :rtype: int ''' self._assert_query_is_initialized() count = c_uint(0) status = Query._count_threads(self._query, byref(count)) if status != 0: raise NotmuchError(status) return count.value _destroy = nmlib.notmuch_query_destroy _destroy.argtypes = [NotmuchQueryP] _destroy.restype = None def __del__(self): """Close and free the Query""" if self._query: self._destroy(self._query) notmuch-0.23.7/bindings/python/notmuch/tag.py000066400000000000000000000112021305541522400211750ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import c_char_p from .globals import ( nmlib, Python3StringMixIn, NotmuchTagsP, ) from .errors import ( NullPointerError, NotInitializedError, ) class Tags(Python3StringMixIn): """Represents a list of notmuch tags This object provides an iterator over a list of notmuch tags (which are unicode instances). Do note that the underlying library only provides a one-time iterator (it cannot reset the iterator to the start). Thus iterating over the function will "exhaust" the list of tags, and a subsequent iteration attempt will raise a :exc:`NotInitializedError`. Also note, that any function that uses iteration (nearly all) will also exhaust the tags. So both:: for tag in tags: print tag as well as:: number_of_tags = len(tags) and even a simple:: #str() iterates over all tags to construct a space separated list print(str(tags)) will "exhaust" the Tags. If you need to re-iterate over a list of tags you will need to retrieve a new :class:`Tags` object. """ #notmuch_tags_get _get = nmlib.notmuch_tags_get _get.argtypes = [NotmuchTagsP] _get.restype = c_char_p def __init__(self, tags_p, parent=None): """ :param tags_p: A pointer to an underlying *notmuch_tags_t* structure. These are not publically exposed, so a user will almost never instantiate a :class:`Tags` object herself. They are usually handed back as a result, e.g. in :meth:`Database.get_all_tags`. *tags_p* must be valid, we will raise an :exc:`NullPointerError` if it is `None`. :type tags_p: :class:`ctypes.c_void_p` :param parent: The parent object (ie :class:`Database` or :class:`Message` these tags are derived from, and saves a reference to it, so we can automatically delete the db object once all derived objects are dead. :TODO: Make the iterator optionally work more than once by cache the tags in the Python object(?) """ if not tags_p: raise NullPointerError() self._tags = tags_p #save reference to parent object so we keep it alive self._parent = parent def __iter__(self): """ Make Tags an iterator """ return self _valid = nmlib.notmuch_tags_valid _valid.argtypes = [NotmuchTagsP] _valid.restype = bool _move_to_next = nmlib.notmuch_tags_move_to_next _move_to_next.argtypes = [NotmuchTagsP] _move_to_next.restype = None def __next__(self): if not self._tags: raise NotInitializedError() if not self._valid(self._tags): self._tags = None raise StopIteration tag = Tags._get(self._tags).decode('UTF-8') self._move_to_next(self._tags) return tag next = __next__ # python2.x iterator protocol compatibility def __nonzero__(self): ''' Implement truth value testing. If __nonzero__ is not implemented, the python runtime would fall back to `len(..) > 0` thus exhausting the iterator. :returns: True if the wrapped iterator has at least one more object left. ''' return self._tags and self._valid(self._tags) def __unicode__(self): """string representation of :class:`Tags`: a space separated list of tags .. note:: As this iterates over the tags, we will not be able to iterate over them again (as in retrieve them)! If the tags have been exhausted already, this will raise a :exc:`NotInitializedError`on subsequent attempts. """ return " ".join(self) _destroy = nmlib.notmuch_tags_destroy _destroy.argtypes = [NotmuchTagsP] _destroy.restype = None def __del__(self): """Close and free the notmuch tags""" if self._tags: self._destroy(self._tags) notmuch-0.23.7/bindings/python/notmuch/thread.py000066400000000000000000000232761305541522400217070ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from ctypes import c_char_p, c_long, c_int from .globals import ( nmlib, NotmuchThreadP, NotmuchMessagesP, NotmuchTagsP, ) from .errors import ( NullPointerError, NotInitializedError, ) from .messages import Messages from .tag import Tags from datetime import date class Thread(object): """Represents a single message thread.""" """notmuch_thread_get_thread_id""" _get_thread_id = nmlib.notmuch_thread_get_thread_id _get_thread_id.argtypes = [NotmuchThreadP] _get_thread_id.restype = c_char_p """notmuch_thread_get_authors""" _get_authors = nmlib.notmuch_thread_get_authors _get_authors.argtypes = [NotmuchThreadP] _get_authors.restype = c_char_p """notmuch_thread_get_subject""" _get_subject = nmlib.notmuch_thread_get_subject _get_subject.argtypes = [NotmuchThreadP] _get_subject.restype = c_char_p """notmuch_thread_get_toplevel_messages""" _get_toplevel_messages = nmlib.notmuch_thread_get_toplevel_messages _get_toplevel_messages.argtypes = [NotmuchThreadP] _get_toplevel_messages.restype = NotmuchMessagesP _get_newest_date = nmlib.notmuch_thread_get_newest_date _get_newest_date.argtypes = [NotmuchThreadP] _get_newest_date.restype = c_long _get_oldest_date = nmlib.notmuch_thread_get_oldest_date _get_oldest_date.argtypes = [NotmuchThreadP] _get_oldest_date.restype = c_long """notmuch_thread_get_tags""" _get_tags = nmlib.notmuch_thread_get_tags _get_tags.argtypes = [NotmuchThreadP] _get_tags.restype = NotmuchTagsP def __init__(self, thread_p, parent=None): """ :param thread_p: A pointer to an internal notmuch_thread_t Structure. These are not publically exposed, so a user will almost never instantiate a :class:`Thread` object herself. They are usually handed back as a result, e.g. when iterating through :class:`Threads`. *thread_p* must be valid, we will raise an :exc:`NullPointerError` if it is `None`. :param parent: A 'parent' object is passed which this message is derived from. We save a reference to it, so we can automatically delete the parent object once all derived objects are dead. """ if not thread_p: raise NullPointerError() self._thread = thread_p #keep reference to parent, so we keep it alive self._parent = parent def get_thread_id(self): """Get the thread ID of 'thread' The returned string belongs to 'thread' and will only be valid for as long as the thread is valid. :returns: String with a message ID :raises: :exc:`NotInitializedError` if the thread is not initialized. """ if not self._thread: raise NotInitializedError() return Thread._get_thread_id(self._thread).decode('utf-8', 'ignore') _get_total_messages = nmlib.notmuch_thread_get_total_messages _get_total_messages.argtypes = [NotmuchThreadP] _get_total_messages.restype = c_int def get_total_messages(self): """Get the total number of messages in 'thread' :returns: The number of all messages in the database belonging to this thread. Contrast with :meth:`get_matched_messages`. :raises: :exc:`NotInitializedError` if the thread is not initialized. """ if not self._thread: raise NotInitializedError() return self._get_total_messages(self._thread) def get_toplevel_messages(self): """Returns a :class:`Messages` iterator for the top-level messages in 'thread' This iterator will not necessarily iterate over all of the messages in the thread. It will only iterate over the messages in the thread which are not replies to other messages in the thread. :returns: :class:`Messages` :raises: :exc:`NotInitializedError` if query is not initialized :raises: :exc:`NullPointerError` if search_messages failed """ if not self._thread: raise NotInitializedError() msgs_p = Thread._get_toplevel_messages(self._thread) if not msgs_p: raise NullPointerError() return Messages(msgs_p, self) """notmuch_thread_get_messages""" _get_messages = nmlib.notmuch_thread_get_messages _get_messages.argtypes = [NotmuchThreadP] _get_messages.restype = NotmuchMessagesP def get_messages(self): """Returns a :class:`Messages` iterator for all messages in 'thread' :returns: :class:`Messages` :raises: :exc:`NotInitializedError` if query is not initialized :raises: :exc:`NullPointerError` if get_messages failed """ if not self._thread: raise NotInitializedError() msgs_p = Thread._get_messages(self._thread) if not msgs_p: raise NullPointerError() return Messages(msgs_p, self) _get_matched_messages = nmlib.notmuch_thread_get_matched_messages _get_matched_messages.argtypes = [NotmuchThreadP] _get_matched_messages.restype = c_int def get_matched_messages(self): """Returns the number of messages in 'thread' that matched the query :returns: The number of all messages belonging to this thread that matched the :class:`Query`from which this thread was created. Contrast with :meth:`get_total_messages`. :raises: :exc:`NotInitializedError` if the thread is not initialized. """ if not self._thread: raise NotInitializedError() return self._get_matched_messages(self._thread) def get_authors(self): """Returns the authors of 'thread' The returned string is a comma-separated list of the names of the authors of mail messages in the query results that belong to this thread. The returned string belongs to 'thread' and will only be valid for as long as this Thread() is not deleted. """ if not self._thread: raise NotInitializedError() authors = Thread._get_authors(self._thread) if not authors: return None return authors.decode('UTF-8', 'ignore') def get_subject(self): """Returns the Subject of 'thread' The returned string belongs to 'thread' and will only be valid for as long as this Thread() is not deleted. """ if not self._thread: raise NotInitializedError() subject = Thread._get_subject(self._thread) if not subject: return None return subject.decode('UTF-8', 'ignore') def get_newest_date(self): """Returns time_t of the newest message date :returns: A time_t timestamp. :rtype: c_unit64 :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._thread: raise NotInitializedError() return Thread._get_newest_date(self._thread) def get_oldest_date(self): """Returns time_t of the oldest message date :returns: A time_t timestamp. :rtype: c_unit64 :raises: :exc:`NotInitializedError` if the message is not initialized. """ if not self._thread: raise NotInitializedError() return Thread._get_oldest_date(self._thread) def get_tags(self): """ Returns the message tags In the Notmuch database, tags are stored on individual messages, not on threads. So the tags returned here will be all tags of the messages which matched the search and which belong to this thread. The :class:`Tags` object is owned by the thread and as such, will only be valid for as long as this :class:`Thread` is valid (e.g. until the query from which it derived is explicitely deleted). :returns: A :class:`Tags` iterator. :raises: :exc:`NotInitializedError` if query is not initialized :raises: :exc:`NullPointerError` if search_messages failed """ if not self._thread: raise NotInitializedError() tags_p = Thread._get_tags(self._thread) if not tags_p: raise NullPointerError() return Tags(tags_p, self) def __unicode__(self): frm = "thread:%s %12s [%d/%d] %s; %s (%s)" return frm % (self.get_thread_id(), date.fromtimestamp(self.get_newest_date()), self.get_matched_messages(), self.get_total_messages(), self.get_authors(), self.get_subject(), self.get_tags(), ) _destroy = nmlib.notmuch_thread_destroy _destroy.argtypes = [NotmuchThreadP] _destroy.restype = None def __del__(self): """Close and free the notmuch Thread""" if self._thread: self._destroy(self._thread) notmuch-0.23.7/bindings/python/notmuch/threads.py000066400000000000000000000124621305541522400220650ustar00rootroot00000000000000""" This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ from .globals import ( nmlib, Python3StringMixIn, NotmuchThreadP, NotmuchThreadsP, ) from .errors import ( NullPointerError, NotInitializedError, ) from .thread import Thread class Threads(Python3StringMixIn): """Represents a list of notmuch threads This object provides an iterator over a list of notmuch threads (Technically, it provides a wrapper for the underlying *notmuch_threads_t* structure). Do note that the underlying library only provides a one-time iterator (it cannot reset the iterator to the start). Thus iterating over the function will "exhaust" the list of threads, and a subsequent iteration attempt will raise a :exc:`NotInitializedError`. Also note, that any function that uses iteration will also exhaust the messages. So both:: for thread in threads: print thread as well as:: list_of_threads = list(threads) will "exhaust" the threads. If you need to re-iterate over a list of messages you will need to retrieve a new :class:`Threads` object. Things are not as bad as it seems though, you can store and reuse the single Thread objects as often as you want as long as you keep the parent Threads object around. (Recall that due to hierarchical memory allocation, all derived Threads objects will be invalid when we delete the parent Threads() object, even if it was already "exhausted".) So this works:: db = Database() threads = Query(db,'').search_threads() #get a Threads() object threadlist = [] for thread in threads: threadlist.append(thread) # threads is "exhausted" now. # However it will be kept around until all retrieved Thread() objects are # also deleted. If you did e.g. an explicit del(threads) here, the # following lines would fail. # You can reiterate over *threadlist* however as often as you want. # It is simply a list with Thread objects. print (threadlist[0].get_thread_id()) print (threadlist[1].get_thread_id()) print (threadlist[0].get_total_messages()) """ #notmuch_threads_get _get = nmlib.notmuch_threads_get _get.argtypes = [NotmuchThreadsP] _get.restype = NotmuchThreadP def __init__(self, threads_p, parent=None): """ :param threads_p: A pointer to an underlying *notmuch_threads_t* structure. These are not publically exposed, so a user will almost never instantiate a :class:`Threads` object herself. They are usually handed back as a result, e.g. in :meth:`Query.search_threads`. *threads_p* must be valid, we will raise an :exc:`NullPointerError` if it is `None`. :type threads_p: :class:`ctypes.c_void_p` :param parent: The parent object (ie :class:`Query`) these tags are derived from. It saves a reference to it, so we can automatically delete the db object once all derived objects are dead. :TODO: Make the iterator work more than once and cache the tags in the Python object.(?) """ if not threads_p: raise NullPointerError() self._threads = threads_p #store parent, so we keep them alive as long as self is alive self._parent = parent def __iter__(self): """ Make Threads an iterator """ return self _valid = nmlib.notmuch_threads_valid _valid.argtypes = [NotmuchThreadsP] _valid.restype = bool _move_to_next = nmlib.notmuch_threads_move_to_next _move_to_next.argtypes = [NotmuchThreadsP] _move_to_next.restype = None def __next__(self): if not self._threads: raise NotInitializedError() if not self._valid(self._threads): self._threads = None raise StopIteration thread = Thread(Threads._get(self._threads), self) self._move_to_next(self._threads) return thread next = __next__ # python2.x iterator protocol compatibility def __nonzero__(self): ''' Implement truth value testing. If __nonzero__ is not implemented, the python runtime would fall back to `len(..) > 0` thus exhausting the iterator. :returns: True if the wrapped iterator has at least one more object left. ''' return self._threads and self._valid(self._threads) _destroy = nmlib.notmuch_threads_destroy _destroy.argtypes = [NotmuchThreadsP] _destroy.restype = None def __del__(self): """Close and free the notmuch Threads""" if self._threads: self._destroy(self._threads) notmuch-0.23.7/bindings/python/notmuch/version.py000066400000000000000000000001401305541522400221060ustar00rootroot00000000000000# this file should be kept in sync with ../../../version __VERSION__ = '0.23.7' SOVERSION = '4' notmuch-0.23.7/bindings/python/setup.py000066400000000000000000000052151305541522400201140ustar00rootroot00000000000000#!/usr/bin/env python """ This file is part of notmuch. Notmuch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Notmuch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth """ import os from distutils.core import setup # get the notmuch version number without importing the notmuch module version_file = os.path.join(os.path.dirname(__file__), 'notmuch', 'version.py') exec(compile(open(version_file).read(), version_file, 'exec')) assert '__VERSION__' in globals(), \ 'Failed to read the notmuch binding version number' setup(name='notmuch', version=__VERSION__, description='Python binding of the notmuch mail search and indexing library.', author='Sebastian Spaeth', author_email='Sebastian@SSpaeth.de', url='https://notmuchmail.org/', download_url='https://notmuchmail.org/releases/notmuch-%s.tar.gz' % __VERSION__, packages=['notmuch'], keywords=['library', 'email'], long_description='''Overview ======== The notmuch module provides an interface to the `notmuch `_ functionality, directly interfacing with a shared notmuch library. Notmuch provides a maildatabase that allows for extremely quick searching and filtering of your email according to various criteria. The documentation for the latest notmuch release can be `viewed online `_. Requirements ------------ You need to have notmuch installed (or rather libnotmuch.so.1). Also, notmuch makes use of the ctypes library, and has only been tested with python >= 2.5. It will not work on earlier python versions. ''', classifiers=['Development Status :: 3 - Alpha', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU General Public License (GPL)', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 3', 'Topic :: Communications :: Email', 'Topic :: Software Development :: Libraries' ], platforms='', license='https://www.gnu.org/licenses/gpl-3.0.txt', ) notmuch-0.23.7/bindings/ruby/000077500000000000000000000000001305541522400160375ustar00rootroot00000000000000notmuch-0.23.7/bindings/ruby/.gitignore000066400000000000000000000001231305541522400200230ustar00rootroot00000000000000# .gitignore for bindings/ruby # Generated files Makefile mkmf.log notmuch.so *.o notmuch-0.23.7/bindings/ruby/README000066400000000000000000000003271305541522400167210ustar00rootroot00000000000000To build the the notmuch ruby extension, run the following commands from the *top level* notmuch source directory: % ./configure % make ruby-bindings The generic documentation about building notmuch also applies. notmuch-0.23.7/bindings/ruby/database.c000066400000000000000000000232641305541522400177560ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" VALUE notmuch_rb_database_alloc (VALUE klass) { return Data_Wrap_Struct (klass, NULL, NULL, NULL); } /* * call-seq: Notmuch::Database.new(path [, {:create => false, :mode => Notmuch::MODE_READ_ONLY}]) => DB * * Create or open a notmuch database using the given path. * * If :create is +true+, create the database instead of opening. * * The argument :mode specifies the open mode of the database. */ VALUE notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE self) { const char *path; int create, mode; VALUE pathv, hashv; VALUE modev; notmuch_database_t *database; notmuch_status_t ret; /* Check arguments */ rb_scan_args (argc, argv, "11", &pathv, &hashv); SafeStringValue (pathv); path = RSTRING_PTR (pathv); if (!NIL_P (hashv)) { Check_Type (hashv, T_HASH); create = RTEST (rb_hash_aref (hashv, ID2SYM (ID_db_create))); modev = rb_hash_aref (hashv, ID2SYM (ID_db_mode)); if (NIL_P (modev)) mode = NOTMUCH_DATABASE_MODE_READ_ONLY; else if (!FIXNUM_P (modev)) rb_raise (rb_eTypeError, ":mode isn't a Fixnum"); else { mode = FIX2INT (modev); switch (mode) { case NOTMUCH_DATABASE_MODE_READ_ONLY: case NOTMUCH_DATABASE_MODE_READ_WRITE: break; default: rb_raise ( rb_eTypeError, "Invalid mode"); } } } else { create = 0; mode = NOTMUCH_DATABASE_MODE_READ_ONLY; } Check_Type (self, T_DATA); if (create) ret = notmuch_database_create (path, &database); else ret = notmuch_database_open (path, mode, &database); notmuch_rb_status_raise (ret); DATA_PTR (self) = database; return self; } /* * call-seq: Notmuch::Database.open(path [, ahash]) {|db| ...} * * Identical to new, except that when it is called with a block, it yields with * the new instance and closes it, and returns the result which is returned from * the block. */ VALUE notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass) { VALUE obj; obj = rb_class_new_instance (argc, argv, klass); if (!rb_block_given_p ()) return obj; return rb_ensure (rb_yield, obj, notmuch_rb_database_close, obj); } /* * call-seq: DB.close => nil * * Close the notmuch database. */ VALUE notmuch_rb_database_close (VALUE self) { notmuch_status_t ret; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); ret = notmuch_database_destroy (db); DATA_PTR (self) = NULL; notmuch_rb_status_raise (ret); return Qnil; } /* * call-seq: DB.path => String * * Return the path of the database */ VALUE notmuch_rb_database_path (VALUE self) { notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); return rb_str_new2 (notmuch_database_get_path (db)); } /* * call-seq: DB.version => Fixnum * * Return the version of the database */ VALUE notmuch_rb_database_version (VALUE self) { notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); return INT2FIX (notmuch_database_get_version (db)); } /* * call-seq: DB.needs_upgrade? => true or false * * Return the +true+ if the database needs upgrading, +false+ otherwise */ VALUE notmuch_rb_database_needs_upgrade (VALUE self) { notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); return notmuch_database_needs_upgrade (db) ? Qtrue : Qfalse; } static void notmuch_rb_upgrade_notify (void *closure, double progress) { VALUE *block = (VALUE *) closure; rb_funcall (*block, ID_call, 1, rb_float_new (progress)); } /* * call-seq: DB.upgrade! [{|progress| block }] => nil * * Upgrade the database. * * If a block is given the block is called with a progress indicator as a * floating point value in the range of [0.0..1.0]. */ VALUE notmuch_rb_database_upgrade (VALUE self) { notmuch_status_t ret; void (*pnotify) (void *closure, double progress); notmuch_database_t *db; VALUE block; Data_Get_Notmuch_Database (self, db); if (rb_block_given_p ()) { pnotify = notmuch_rb_upgrade_notify; block = rb_block_proc (); } else pnotify = NULL; ret = notmuch_database_upgrade (db, pnotify, pnotify ? &block : NULL); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: DB.begin_atomic => nil * * Begin an atomic database operation. */ VALUE notmuch_rb_database_begin_atomic (VALUE self) { notmuch_status_t ret; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); ret = notmuch_database_begin_atomic (db); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: DB.end_atomic => nil * * Indicate the end of an atomic database operation. */ VALUE notmuch_rb_database_end_atomic (VALUE self) { notmuch_status_t ret; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); ret = notmuch_database_end_atomic (db); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: DB.get_directory(path) => DIR * * Retrieve a directory object from the database for 'path' */ VALUE notmuch_rb_database_get_directory (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_directory_t *dir; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); SafeStringValue (pathv); path = RSTRING_PTR (pathv); ret = notmuch_database_get_directory (db, path, &dir); notmuch_rb_status_raise (ret); if (dir) return Data_Wrap_Struct (notmuch_rb_cDirectory, NULL, NULL, dir); return Qnil; } /* * call-seq: DB.add_message(path) => MESSAGE, isdup * * Add a message to the database and return it. * * +isdup+ is a boolean that specifies whether the added message was a * duplicate. */ VALUE notmuch_rb_database_add_message (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_message_t *message; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); SafeStringValue (pathv); path = RSTRING_PTR (pathv); ret = notmuch_database_add_message (db, path, &message); notmuch_rb_status_raise (ret); return rb_assoc_new (Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message), (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse); } /* * call-seq: DB.remove_message (path) => isdup * * Remove a message from the database. * * +isdup+ is a boolean that specifies whether the removed message was a * duplicate. */ VALUE notmuch_rb_database_remove_message (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); SafeStringValue (pathv); path = RSTRING_PTR (pathv); ret = notmuch_database_remove_message (db, path); notmuch_rb_status_raise (ret); return (ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) ? Qtrue : Qfalse; } /* * call-seq: DB.find_message(id) => MESSAGE or nil * * Find a message by message id. */ VALUE notmuch_rb_database_find_message (VALUE self, VALUE idv) { const char *id; notmuch_status_t ret; notmuch_database_t *db; notmuch_message_t *message; Data_Get_Notmuch_Database (self, db); SafeStringValue (idv); id = RSTRING_PTR (idv); ret = notmuch_database_find_message (db, id, &message); notmuch_rb_status_raise (ret); if (message) return Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message); return Qnil; } /* * call-seq: DB.find_message_by_filename(path) => MESSAGE or nil * * Find a message by filename. */ VALUE notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv) { const char *path; notmuch_status_t ret; notmuch_database_t *db; notmuch_message_t *message; Data_Get_Notmuch_Database (self, db); SafeStringValue (pathv); path = RSTRING_PTR (pathv); ret = notmuch_database_find_message_by_filename (db, path, &message); notmuch_rb_status_raise (ret); if (message) return Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message); return Qnil; } /* * call-seq: DB.get_all_tags() => TAGS * * Returns a list of all tags found in the database. */ VALUE notmuch_rb_database_get_all_tags (VALUE self) { notmuch_database_t *db; notmuch_tags_t *tags; Data_Get_Notmuch_Database (self, db); tags = notmuch_database_get_all_tags (db); if (!tags) { const char *msg = notmuch_database_status_string (db); if (!msg) msg = "Unknown notmuch error"; rb_raise (notmuch_rb_eBaseError, "%s", msg); } return Data_Wrap_Struct (notmuch_rb_cTags, NULL, NULL, tags); } /* * call-seq: DB.query(query) => QUERY * * Retrieve a query object for the query string 'query' */ VALUE notmuch_rb_database_query_create (VALUE self, VALUE qstrv) { const char *qstr; notmuch_query_t *query; notmuch_database_t *db; Data_Get_Notmuch_Database (self, db); SafeStringValue (qstrv); qstr = RSTRING_PTR (qstrv); query = notmuch_query_create (db, qstr); if (!query) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return Data_Wrap_Struct (notmuch_rb_cQuery, NULL, NULL, query); } notmuch-0.23.7/bindings/ruby/defs.h000066400000000000000000000201651305541522400171350ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011, 2012 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #ifndef DEFS_H #define DEFS_H #include #include extern VALUE notmuch_rb_cDatabase; extern VALUE notmuch_rb_cDirectory; extern VALUE notmuch_rb_cFileNames; extern VALUE notmuch_rb_cQuery; extern VALUE notmuch_rb_cThreads; extern VALUE notmuch_rb_cThread; extern VALUE notmuch_rb_cMessages; extern VALUE notmuch_rb_cMessage; extern VALUE notmuch_rb_cTags; extern VALUE notmuch_rb_eBaseError; extern VALUE notmuch_rb_eDatabaseError; extern VALUE notmuch_rb_eMemoryError; extern VALUE notmuch_rb_eReadOnlyError; extern VALUE notmuch_rb_eXapianError; extern VALUE notmuch_rb_eFileError; extern VALUE notmuch_rb_eFileNotEmailError; extern VALUE notmuch_rb_eNullPointerError; extern VALUE notmuch_rb_eTagTooLongError; extern VALUE notmuch_rb_eUnbalancedFreezeThawError; extern VALUE notmuch_rb_eUnbalancedAtomicError; extern ID ID_call; extern ID ID_db_create; extern ID ID_db_mode; /* RSTRING_PTR() is new in ruby-1.9 */ #if !defined(RSTRING_PTR) # define RSTRING_PTR(v) (RSTRING((v))->ptr) #endif /* !defined (RSTRING_PTR) */ #define Data_Get_Notmuch_Database(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "database closed"); \ Data_Get_Struct ((obj), notmuch_database_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Directory(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "directory destroyed"); \ Data_Get_Struct ((obj), notmuch_directory_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_FileNames(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "filenames destroyed"); \ Data_Get_Struct ((obj), notmuch_filenames_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Query(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "query destroyed"); \ Data_Get_Struct ((obj), notmuch_query_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Threads(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "threads destroyed"); \ Data_Get_Struct ((obj), notmuch_threads_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Messages(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "messages destroyed"); \ Data_Get_Struct ((obj), notmuch_messages_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Thread(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "thread destroyed"); \ Data_Get_Struct ((obj), notmuch_thread_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Message(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "message destroyed"); \ Data_Get_Struct ((obj), notmuch_message_t, (ptr)); \ } while (0) #define Data_Get_Notmuch_Tags(obj, ptr) \ do { \ Check_Type ((obj), T_DATA); \ if (DATA_PTR ((obj)) == NULL) \ rb_raise (rb_eRuntimeError, "tags destroyed"); \ Data_Get_Struct ((obj), notmuch_tags_t, (ptr)); \ } while (0) /* status.c */ void notmuch_rb_status_raise (notmuch_status_t status); /* database.c */ VALUE notmuch_rb_database_alloc (VALUE klass); VALUE notmuch_rb_database_initialize (int argc, VALUE *argv, VALUE klass); VALUE notmuch_rb_database_open (int argc, VALUE *argv, VALUE klass); VALUE notmuch_rb_database_close (VALUE self); VALUE notmuch_rb_database_path (VALUE self); VALUE notmuch_rb_database_version (VALUE self); VALUE notmuch_rb_database_needs_upgrade (VALUE self); VALUE notmuch_rb_database_upgrade (VALUE self); VALUE notmuch_rb_database_begin_atomic (VALUE self); VALUE notmuch_rb_database_end_atomic (VALUE self); VALUE notmuch_rb_database_get_directory (VALUE self, VALUE pathv); VALUE notmuch_rb_database_add_message (VALUE self, VALUE pathv); VALUE notmuch_rb_database_remove_message (VALUE self, VALUE pathv); VALUE notmuch_rb_database_find_message (VALUE self, VALUE idv); VALUE notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv); VALUE notmuch_rb_database_get_all_tags (VALUE self); VALUE notmuch_rb_database_query_create (VALUE self, VALUE qstrv); /* directory.c */ VALUE notmuch_rb_directory_destroy (VALUE self); VALUE notmuch_rb_directory_get_mtime (VALUE self); VALUE notmuch_rb_directory_set_mtime (VALUE self, VALUE mtimev); VALUE notmuch_rb_directory_get_child_files (VALUE self); VALUE notmuch_rb_directory_get_child_directories (VALUE self); /* filenames.c */ VALUE notmuch_rb_filenames_destroy (VALUE self); VALUE notmuch_rb_filenames_each (VALUE self); /* query.c */ VALUE notmuch_rb_query_destroy (VALUE self); VALUE notmuch_rb_query_get_sort (VALUE self); VALUE notmuch_rb_query_set_sort (VALUE self, VALUE sortv); VALUE notmuch_rb_query_get_string (VALUE self); VALUE notmuch_rb_query_add_tag_exclude (VALUE self, VALUE tagv); VALUE notmuch_rb_query_set_omit_excluded (VALUE self, VALUE omitv); VALUE notmuch_rb_query_search_threads (VALUE self); VALUE notmuch_rb_query_search_messages (VALUE self); VALUE notmuch_rb_query_count_messages (VALUE self); VALUE notmuch_rb_query_count_threads (VALUE self); /* threads.c */ VALUE notmuch_rb_threads_destroy (VALUE self); VALUE notmuch_rb_threads_each (VALUE self); /* messages.c */ VALUE notmuch_rb_messages_destroy (VALUE self); VALUE notmuch_rb_messages_each (VALUE self); VALUE notmuch_rb_messages_collect_tags (VALUE self); /* thread.c */ VALUE notmuch_rb_thread_destroy (VALUE self); VALUE notmuch_rb_thread_get_thread_id (VALUE self); VALUE notmuch_rb_thread_get_total_messages (VALUE self); VALUE notmuch_rb_thread_get_toplevel_messages (VALUE self); VALUE notmuch_rb_thread_get_messages (VALUE self); VALUE notmuch_rb_thread_get_matched_messages (VALUE self); VALUE notmuch_rb_thread_get_authors (VALUE self); VALUE notmuch_rb_thread_get_subject (VALUE self); VALUE notmuch_rb_thread_get_oldest_date (VALUE self); VALUE notmuch_rb_thread_get_newest_date (VALUE self); VALUE notmuch_rb_thread_get_tags (VALUE self); /* message.c */ VALUE notmuch_rb_message_destroy (VALUE self); VALUE notmuch_rb_message_get_message_id (VALUE self); VALUE notmuch_rb_message_get_thread_id (VALUE self); VALUE notmuch_rb_message_get_replies (VALUE self); VALUE notmuch_rb_message_get_filename (VALUE self); VALUE notmuch_rb_message_get_filenames (VALUE self); VALUE notmuch_rb_message_get_flag (VALUE self, VALUE flagv); VALUE notmuch_rb_message_set_flag (VALUE self, VALUE flagv, VALUE valuev); VALUE notmuch_rb_message_get_date (VALUE self); VALUE notmuch_rb_message_get_header (VALUE self, VALUE headerv); VALUE notmuch_rb_message_get_tags (VALUE self); VALUE notmuch_rb_message_add_tag (VALUE self, VALUE tagv); VALUE notmuch_rb_message_remove_tag (VALUE self, VALUE tagv); VALUE notmuch_rb_message_remove_all_tags (VALUE self); VALUE notmuch_rb_message_maildir_flags_to_tags (VALUE self); VALUE notmuch_rb_message_tags_to_maildir_flags (VALUE self); VALUE notmuch_rb_message_freeze (VALUE self); VALUE notmuch_rb_message_thaw (VALUE self); /* tags.c */ VALUE notmuch_rb_tags_destroy (VALUE self); VALUE notmuch_rb_tags_each (VALUE self); /* init.c */ void Init_notmuch (void); #endif notmuch-0.23.7/bindings/ruby/directory.c000066400000000000000000000056131305541522400202140ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: DIR.destroy! => nil * * Destroys the directory, freeing all resources allocated for it. */ VALUE notmuch_rb_directory_destroy (VALUE self) { notmuch_directory_t *dir; Data_Get_Struct (self, notmuch_directory_t, dir); notmuch_directory_destroy (dir); DATA_PTR (self) = NULL; return Qnil; } /* * call-seq: DIR.mtime => fixnum * * Returns the mtime of the directory or +0+ if no mtime has been previously * stored. */ VALUE notmuch_rb_directory_get_mtime (VALUE self) { notmuch_directory_t *dir; Data_Get_Notmuch_Directory (self, dir); return UINT2NUM (notmuch_directory_get_mtime (dir)); } /* * call-seq: DIR.mtime=(fixnum) => nil * * Store an mtime within the database for the directory object. */ VALUE notmuch_rb_directory_set_mtime (VALUE self, VALUE mtimev) { notmuch_status_t ret; notmuch_directory_t *dir; Data_Get_Notmuch_Directory (self, dir); if (!FIXNUM_P (mtimev)) rb_raise (rb_eTypeError, "First argument not a fixnum"); ret = notmuch_directory_set_mtime (dir, FIX2UINT (mtimev)); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: DIR.child_files => FILENAMES * * Return a Notmuch::FileNames object, which is an +Enumerable+ listing all the * filenames of messages in the database within the given directory. */ VALUE notmuch_rb_directory_get_child_files (VALUE self) { notmuch_directory_t *dir; notmuch_filenames_t *fnames; Data_Get_Notmuch_Directory (self, dir); fnames = notmuch_directory_get_child_files (dir); return Data_Wrap_Struct (notmuch_rb_cFileNames, NULL, NULL, fnames); } /* * call-seq: DIR.child_directories => FILENAMES * * Return a Notmuch::FileNames object, which is an +Enumerable+ listing all the * directories in the database within the given directory. */ VALUE notmuch_rb_directory_get_child_directories (VALUE self) { notmuch_directory_t *dir; notmuch_filenames_t *fnames; Data_Get_Notmuch_Directory (self, dir); fnames = notmuch_directory_get_child_directories (dir); return Data_Wrap_Struct (notmuch_rb_cFileNames, NULL, NULL, fnames); } notmuch-0.23.7/bindings/ruby/extconf.rb000066400000000000000000000007321305541522400200340ustar00rootroot00000000000000#!/usr/bin/env ruby # coding: utf-8 # Copyright 2010, 2011, 2012 Ali Polatel # Distributed under the terms of the GNU General Public License v3 require 'mkmf' dir = File.join('..', '..', 'lib') # includes $INCFLAGS = "-I#{dir} #{$INCFLAGS}" if ENV['EXTRA_LDFLAGS'] $LDFLAGS += " " + ENV['EXTRA_LDFLAGS'] end if not ENV['LIBNOTMUCH'] exit 1 end $LOCAL_LIBS += ENV['LIBNOTMUCH'] # Create Makefile dir_config('notmuch') create_makefile('notmuch') notmuch-0.23.7/bindings/ruby/filenames.c000066400000000000000000000030671305541522400201540ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: FILENAMES.destroy! => nil * * Destroys the filenames, freeing all resources allocated for it. */ VALUE notmuch_rb_filenames_destroy (VALUE self) { notmuch_filenames_t *fnames; Data_Get_Notmuch_FileNames (self, fnames); notmuch_filenames_destroy (fnames); DATA_PTR (self) = NULL; return Qnil; } /* * call-seq: FILENAMES.each {|item| block } => FILENAMES * * Calls +block+ once for each element in +self+, passing that element as a * parameter. */ VALUE notmuch_rb_filenames_each (VALUE self) { notmuch_filenames_t *fnames; Data_Get_Notmuch_FileNames (self, fnames); for (; notmuch_filenames_valid (fnames); notmuch_filenames_move_to_next (fnames)) rb_yield (rb_str_new2 (notmuch_filenames_get (fnames))); return self; } notmuch-0.23.7/bindings/ruby/init.c000066400000000000000000000403661305541522400171570ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011, 2012 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" VALUE notmuch_rb_cDatabase; VALUE notmuch_rb_cDirectory; VALUE notmuch_rb_cFileNames; VALUE notmuch_rb_cQuery; VALUE notmuch_rb_cThreads; VALUE notmuch_rb_cThread; VALUE notmuch_rb_cMessages; VALUE notmuch_rb_cMessage; VALUE notmuch_rb_cTags; VALUE notmuch_rb_eBaseError; VALUE notmuch_rb_eDatabaseError; VALUE notmuch_rb_eMemoryError; VALUE notmuch_rb_eReadOnlyError; VALUE notmuch_rb_eXapianError; VALUE notmuch_rb_eFileError; VALUE notmuch_rb_eFileNotEmailError; VALUE notmuch_rb_eNullPointerError; VALUE notmuch_rb_eTagTooLongError; VALUE notmuch_rb_eUnbalancedFreezeThawError; VALUE notmuch_rb_eUnbalancedAtomicError; ID ID_call; ID ID_db_create; ID ID_db_mode; /* * Document-module: Notmuch * * == Summary * * Ruby extension to the notmuch mail library. * * == Classes * * Following are the classes that are most likely to be of interest to * the user: * * - Notmuch::Database * - Notmuch::FileNames * - Notmuch::Query * - Notmuch::Threads * - Notmuch::Messages * - Notmuch::Thread * - Notmuch::Message * - Notmuch::Tags */ void Init_notmuch (void) { VALUE mod; ID_call = rb_intern ("call"); ID_db_create = rb_intern ("create"); ID_db_mode = rb_intern ("mode"); mod = rb_define_module ("Notmuch"); /* * Document-const: Notmuch::MODE_READ_ONLY * * Open the database in read only mode */ rb_define_const (mod, "MODE_READ_ONLY", INT2FIX (NOTMUCH_DATABASE_MODE_READ_ONLY)); /* * Document-const: Notmuch::MODE_READ_WRITE * * Open the database in read write mode */ rb_define_const (mod, "MODE_READ_WRITE", INT2FIX (NOTMUCH_DATABASE_MODE_READ_WRITE)); /* * Document-const: Notmuch::SORT_OLDEST_FIRST * * Sort query results by oldest first */ rb_define_const (mod, "SORT_OLDEST_FIRST", INT2FIX (NOTMUCH_SORT_OLDEST_FIRST)); /* * Document-const: Notmuch::SORT_NEWEST_FIRST * * Sort query results by newest first */ rb_define_const (mod, "SORT_NEWEST_FIRST", INT2FIX (NOTMUCH_SORT_NEWEST_FIRST)); /* * Document-const: Notmuch::SORT_MESSAGE_ID * * Sort query results by message id */ rb_define_const (mod, "SORT_MESSAGE_ID", INT2FIX (NOTMUCH_SORT_MESSAGE_ID)); /* * Document-const: Notmuch::SORT_UNSORTED * * Do not sort query results */ rb_define_const (mod, "SORT_UNSORTED", INT2FIX (NOTMUCH_SORT_UNSORTED)); /* * Document-const: Notmuch::MESSAGE_FLAG_MATCH * * Message flag "match" */ rb_define_const (mod, "MESSAGE_FLAG_MATCH", INT2FIX (NOTMUCH_MESSAGE_FLAG_MATCH)); /* * Document-const: Notmuch::MESSAGE_FLAG_EXCLUDED * * Message flag "excluded" */ rb_define_const (mod, "MESSAGE_FLAG_EXCLUDED", INT2FIX (NOTMUCH_MESSAGE_FLAG_EXCLUDED)); /* * Document-const: Notmuch::TAG_MAX * * Maximum allowed length of a tag */ rb_define_const (mod, "TAG_MAX", INT2FIX (NOTMUCH_TAG_MAX)); /* * Document-class: Notmuch::BaseError * * Base class for all notmuch exceptions */ notmuch_rb_eBaseError = rb_define_class_under (mod, "BaseError", rb_eStandardError); /* * Document-class: Notmuch::DatabaseError * * Raised when the database can't be created or opened. */ notmuch_rb_eDatabaseError = rb_define_class_under (mod, "DatabaseError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::MemoryError * * Raised when notmuch is out of memory */ notmuch_rb_eMemoryError = rb_define_class_under (mod, "MemoryError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::ReadOnlyError * * Raised when an attempt was made to write to a database opened in read-only * mode. */ notmuch_rb_eReadOnlyError = rb_define_class_under (mod, "ReadOnlyError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::XapianError * * Raised when a Xapian exception occurs */ notmuch_rb_eXapianError = rb_define_class_under (mod, "XapianError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::FileError * * Raised when an error occurs trying to read or write to a file. */ notmuch_rb_eFileError = rb_define_class_under (mod, "FileError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::FileNotEmailError * * Raised when a file is presented that doesn't appear to be an email message. */ notmuch_rb_eFileNotEmailError = rb_define_class_under (mod, "FileNotEmailError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::NullPointerError * * Raised when the user erroneously passes a +NULL+ pointer to a notmuch * function. */ notmuch_rb_eNullPointerError = rb_define_class_under (mod, "NullPointerError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::TagTooLongError * * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX) */ notmuch_rb_eTagTooLongError = rb_define_class_under (mod, "TagTooLongError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::UnbalancedFreezeThawError * * Raised when the notmuch_message_thaw function has been called more times * than notmuch_message_freeze. */ notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under (mod, "UnbalancedFreezeThawError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::UnbalancedAtomicError * * Raised when notmuch_database_end_atomic has been called more times than * notmuch_database_begin_atomic */ notmuch_rb_eUnbalancedAtomicError = rb_define_class_under (mod, "UnbalancedAtomicError", notmuch_rb_eBaseError); /* * Document-class: Notmuch::Database * * Notmuch database interaction */ notmuch_rb_cDatabase = rb_define_class_under (mod, "Database", rb_cData); rb_define_alloc_func (notmuch_rb_cDatabase, notmuch_rb_database_alloc); rb_define_singleton_method (notmuch_rb_cDatabase, "open", notmuch_rb_database_open, -1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "initialize", notmuch_rb_database_initialize, -1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "begin_atomic", notmuch_rb_database_begin_atomic, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "end_atomic", notmuch_rb_database_end_atomic, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "find_message", notmuch_rb_database_find_message, 1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename", notmuch_rb_database_find_message_by_filename, 1); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "all_tags", notmuch_rb_database_get_all_tags, 0); /* in database.c */ rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1); /* in database.c */ /* * Document-class: Notmuch::Directory * * Notmuch directory */ notmuch_rb_cDirectory = rb_define_class_under (mod, "Directory", rb_cData); rb_undef_method (notmuch_rb_cDirectory, "initialize"); rb_define_method (notmuch_rb_cDirectory, "destroy!", notmuch_rb_directory_destroy, 0); /* in directory.c */ rb_define_method (notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0); /* in directory.c */ rb_define_method (notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1); /* in directory.c */ rb_define_method (notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0); /* in directory.c */ rb_define_method (notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0); /* in directory.c */ /* * Document-class: Notmuch::FileNames * * Notmuch file names */ notmuch_rb_cFileNames = rb_define_class_under (mod, "FileNames", rb_cData); rb_undef_method (notmuch_rb_cFileNames, "initialize"); rb_define_method (notmuch_rb_cFileNames, "destroy!", notmuch_rb_filenames_destroy, 0); /* in filenames.c */ rb_define_method (notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0); /* in filenames.c */ rb_include_module (notmuch_rb_cFileNames, rb_mEnumerable); /* * Document-class: Notmuch::Query * * Notmuch query */ notmuch_rb_cQuery = rb_define_class_under (mod, "Query", rb_cData); rb_undef_method (notmuch_rb_cQuery, "initialize"); rb_define_method (notmuch_rb_cQuery, "destroy!", notmuch_rb_query_destroy, 0); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "sort", notmuch_rb_query_get_sort, 0); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "to_s", notmuch_rb_query_get_string, 0); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "add_tag_exclude", notmuch_rb_query_add_tag_exclude, 1); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "omit_excluded=", notmuch_rb_query_set_omit_excluded, 1); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "count_messages", notmuch_rb_query_count_messages, 0); /* in query.c */ rb_define_method (notmuch_rb_cQuery, "count_threads", notmuch_rb_query_count_threads, 0); /* in query.c */ /* * Document-class: Notmuch::Threads * * Notmuch threads */ notmuch_rb_cThreads = rb_define_class_under (mod, "Threads", rb_cData); rb_undef_method (notmuch_rb_cThreads, "initialize"); rb_define_method (notmuch_rb_cThreads, "destroy!", notmuch_rb_threads_destroy, 0); /* in threads.c */ rb_define_method (notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0); /* in threads.c */ rb_include_module (notmuch_rb_cThreads, rb_mEnumerable); /* * Document-class: Notmuch::Messages * * Notmuch messages */ notmuch_rb_cMessages = rb_define_class_under (mod, "Messages", rb_cData); rb_undef_method (notmuch_rb_cMessages, "initialize"); rb_define_method (notmuch_rb_cMessages, "destroy!", notmuch_rb_messages_destroy, 0); /* in messages.c */ rb_define_method (notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0); /* in messages.c */ rb_define_method (notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0); /* in messages.c */ rb_include_module (notmuch_rb_cMessages, rb_mEnumerable); /* * Document-class: Notmuch::Thread * * Notmuch thread */ notmuch_rb_cThread = rb_define_class_under (mod, "Thread", rb_cData); rb_undef_method (notmuch_rb_cThread, "initialize"); rb_define_method (notmuch_rb_cThread, "destroy!", notmuch_rb_thread_destroy, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "messages", notmuch_rb_thread_get_messages, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0); /* in thread.c */ rb_define_method (notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0); /* in thread.c */ /* * Document-class: Notmuch::Message * * Notmuch message */ notmuch_rb_cMessage = rb_define_class_under (mod, "Message", rb_cData); rb_undef_method (notmuch_rb_cMessage, "initialize"); rb_define_method (notmuch_rb_cMessage, "destroy!", notmuch_rb_message_destroy, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "filenames", notmuch_rb_message_get_filenames, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1); /* in message.c */ rb_define_alias (notmuch_rb_cMessage, "[]", "header"); rb_define_method (notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1); /* in message.c */ rb_define_alias (notmuch_rb_cMessage, "<<", "add_tag"); rb_define_method (notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "maildir_flags_to_tags", notmuch_rb_message_maildir_flags_to_tags, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "tags_to_maildir_flags", notmuch_rb_message_tags_to_maildir_flags, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0); /* in message.c */ rb_define_method (notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0); /* in message.c */ /* * Document-class: Notmuch::Tags * * Notmuch tags */ notmuch_rb_cTags = rb_define_class_under (mod, "Tags", rb_cData); rb_undef_method (notmuch_rb_cTags, "initialize"); rb_define_method (notmuch_rb_cTags, "destroy!", notmuch_rb_tags_destroy, 0); /* in tags.c */ rb_define_method (notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0); /* in tags.c */ rb_include_module (notmuch_rb_cTags, rb_mEnumerable); } notmuch-0.23.7/bindings/ruby/message.c000066400000000000000000000172231305541522400176340ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: MESSAGE.destroy! => nil * * Destroys the message, freeing all resources allocated for it. */ VALUE notmuch_rb_message_destroy (VALUE self) { notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); notmuch_message_destroy (message); DATA_PTR (self) = NULL; return Qnil; } /* * call-seq: MESSAGE.message_id => String * * Get the message ID of 'message'. */ VALUE notmuch_rb_message_get_message_id (VALUE self) { const char *msgid; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); msgid = notmuch_message_get_message_id (message); return rb_str_new2 (msgid); } /* * call-seq: MESSAGE.thread_id => String * * Get the thread ID of 'message'. */ VALUE notmuch_rb_message_get_thread_id (VALUE self) { const char *tid; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); tid = notmuch_message_get_thread_id (message); return rb_str_new2 (tid); } /* * call-seq: MESSAGE.replies => MESSAGES * * Get a Notmuch::Messages enumerable for all of the replies to 'message'. */ VALUE notmuch_rb_message_get_replies (VALUE self) { notmuch_messages_t *messages; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); messages = notmuch_message_get_replies (message); return Data_Wrap_Struct (notmuch_rb_cMessages, NULL, NULL, messages); } /* * call-seq: MESSAGE.filename => String * * Get a filename for the email corresponding to 'message' */ VALUE notmuch_rb_message_get_filename (VALUE self) { const char *fname; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); fname = notmuch_message_get_filename (message); return rb_str_new2 (fname); } /* * call-seq: MESSAGE.filenames => FILENAMES * * Get all filenames for the email corresponding to MESSAGE. */ VALUE notmuch_rb_message_get_filenames (VALUE self) { notmuch_filenames_t *fnames; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); fnames = notmuch_message_get_filenames (message); return Data_Wrap_Struct (notmuch_rb_cFileNames, NULL, NULL, fnames); } /* * call-seq: MESSAGE.get_flag (flag) => true or false * * Get a value of a flag for the email corresponding to 'message' */ VALUE notmuch_rb_message_get_flag (VALUE self, VALUE flagv) { notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); if (!FIXNUM_P (flagv)) rb_raise (rb_eTypeError, "Flag not a Fixnum"); return notmuch_message_get_flag (message, FIX2INT (flagv)) ? Qtrue : Qfalse; } /* * call-seq: MESSAGE.set_flag (flag, value) => nil * * Set a value of a flag for the email corresponding to 'message' */ VALUE notmuch_rb_message_set_flag (VALUE self, VALUE flagv, VALUE valuev) { notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); if (!FIXNUM_P (flagv)) rb_raise (rb_eTypeError, "Flag not a Fixnum"); notmuch_message_set_flag (message, FIX2INT (flagv), RTEST (valuev)); return Qnil; } /* * call-seq: MESSAGE.date => Fixnum * * Get the date of 'message' */ VALUE notmuch_rb_message_get_date (VALUE self) { notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); return UINT2NUM (notmuch_message_get_date (message)); } /* * call-seq: MESSAGE.header (name) => String * * Get the value of the specified header from 'message' */ VALUE notmuch_rb_message_get_header (VALUE self, VALUE headerv) { const char *header, *value; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); SafeStringValue (headerv); header = RSTRING_PTR (headerv); value = notmuch_message_get_header (message, header); if (!value) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return rb_str_new2 (value); } /* * call-seq: MESSAGE.tags => TAGS * * Get a Notmuch::Tags enumerable for all of the tags of 'message'. */ VALUE notmuch_rb_message_get_tags (VALUE self) { notmuch_message_t *message; notmuch_tags_t *tags; Data_Get_Notmuch_Message (self, message); tags = notmuch_message_get_tags (message); if (!tags) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return Data_Wrap_Struct (notmuch_rb_cTags, NULL, NULL, tags); } /* * call-seq: MESSAGE.add_tag (tag) => true * * Add a tag to the 'message' */ VALUE notmuch_rb_message_add_tag (VALUE self, VALUE tagv) { const char *tag; notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); SafeStringValue (tagv); tag = RSTRING_PTR (tagv); ret = notmuch_message_add_tag (message, tag); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: MESSAGE.remove_tag (tag) => true * * Remove a tag from the 'message' */ VALUE notmuch_rb_message_remove_tag (VALUE self, VALUE tagv) { const char *tag; notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); SafeStringValue (tagv); tag = RSTRING_PTR (tagv); ret = notmuch_message_remove_tag (message, tag); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: MESSAGE.remove_all_tags => true * * Remove all tags of the 'message' */ VALUE notmuch_rb_message_remove_all_tags (VALUE self) { notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); ret = notmuch_message_remove_all_tags (message); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: MESSAGE.maildir_flags_to_tags => true * * Add/remove tags according to maildir flags in the message filename (s) */ VALUE notmuch_rb_message_maildir_flags_to_tags (VALUE self) { notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); ret = notmuch_message_maildir_flags_to_tags (message); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: MESSAGE.tags_to_maildir_flags => true * * Rename message filename (s) to encode tags as maildir flags */ VALUE notmuch_rb_message_tags_to_maildir_flags (VALUE self) { notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); ret = notmuch_message_tags_to_maildir_flags (message); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: MESSAGE.freeze => true * * Freeze the 'message' */ VALUE notmuch_rb_message_freeze (VALUE self) { notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); ret = notmuch_message_freeze (message); notmuch_rb_status_raise (ret); return Qtrue; } /* * call-seq: MESSAGE.thaw => true * * Thaw a 'message' */ VALUE notmuch_rb_message_thaw (VALUE self) { notmuch_status_t ret; notmuch_message_t *message; Data_Get_Notmuch_Message (self, message); ret = notmuch_message_thaw (message); notmuch_rb_status_raise (ret); return Qtrue; } notmuch-0.23.7/bindings/ruby/messages.c000066400000000000000000000041211305541522400200100ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: MESSAGES.destroy! => nil * * Destroys the messages, freeing all resources allocated for it. */ VALUE notmuch_rb_messages_destroy (VALUE self) { notmuch_messages_t *messages; Data_Get_Notmuch_Messages (self, messages); notmuch_messages_destroy (messages); DATA_PTR (self) = NULL; return Qnil; } /* call-seq: MESSAGES.each {|item| block } => MESSAGES * * Calls +block+ once for each message in +self+, passing that element as a * parameter. */ VALUE notmuch_rb_messages_each (VALUE self) { notmuch_message_t *message; notmuch_messages_t *messages; Data_Get_Notmuch_Messages (self, messages); for (; notmuch_messages_valid (messages); notmuch_messages_move_to_next (messages)) { message = notmuch_messages_get (messages); rb_yield (Data_Wrap_Struct (notmuch_rb_cMessage, NULL, NULL, message)); } return self; } /* * call-seq: MESSAGES.tags => TAGS * * Collect tags from the messages */ VALUE notmuch_rb_messages_collect_tags (VALUE self) { notmuch_tags_t *tags; notmuch_messages_t *messages; Data_Get_Notmuch_Messages (self, messages); tags = notmuch_messages_collect_tags (messages); if (!tags) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return Data_Wrap_Struct (notmuch_rb_cTags, NULL, NULL, tags); } notmuch-0.23.7/bindings/ruby/query.c000066400000000000000000000107331305541522400173540ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011, 2012 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: QUERY.destroy! => nil * * Destroys the query, freeing all resources allocated for it. */ VALUE notmuch_rb_query_destroy (VALUE self) { notmuch_query_t *query; Data_Get_Notmuch_Query (self, query); notmuch_query_destroy (query); DATA_PTR (self) = NULL; return Qnil; } /* * call-seq: QUERY.sort => fixnum * * Get sort type of the +QUERY+ */ VALUE notmuch_rb_query_get_sort (VALUE self) { notmuch_query_t *query; Data_Get_Notmuch_Query (self, query); return FIX2INT (notmuch_query_get_sort (query)); } /* * call-seq: QUERY.sort=(fixnum) => nil * * Set sort type of the +QUERY+ */ VALUE notmuch_rb_query_set_sort (VALUE self, VALUE sortv) { notmuch_query_t *query; Data_Get_Notmuch_Query (self, query); if (!FIXNUM_P (sortv)) rb_raise (rb_eTypeError, "Not a Fixnum"); notmuch_query_set_sort (query, FIX2UINT (sortv)); return Qnil; } /* * call-seq: QUERY.to_s => string * * Get query string of the +QUERY+ */ VALUE notmuch_rb_query_get_string (VALUE self) { notmuch_query_t *query; Data_Get_Notmuch_Query (self, query); return rb_str_new2 (notmuch_query_get_query_string (query)); } /* * call-seq: QUERY.add_tag_exclude(tag) => nil * * Add a tag that will be excluded from the query results by default. */ VALUE notmuch_rb_query_add_tag_exclude (VALUE self, VALUE tagv) { notmuch_query_t *query; const char *tag; Data_Get_Notmuch_Query (self, query); tag = RSTRING_PTR(tagv); notmuch_query_add_tag_exclude(query, tag); return Qnil; } /* * call-seq: QUERY.omit_excluded=(boolean) => nil * * Specify whether to omit excluded results or simply flag them. * By default, this is set to +true+. */ VALUE notmuch_rb_query_set_omit_excluded (VALUE self, VALUE omitv) { notmuch_query_t *query; Data_Get_Notmuch_Query (self, query); notmuch_query_set_omit_excluded (query, RTEST (omitv)); return Qnil; } /* * call-seq: QUERY.search_threads => THREADS * * Search for threads */ VALUE notmuch_rb_query_search_threads (VALUE self) { notmuch_query_t *query; notmuch_threads_t *threads; notmuch_status_t status; Data_Get_Notmuch_Query (self, query); status = notmuch_query_search_threads_st (query, &threads); if (status) notmuch_rb_status_raise (status); return Data_Wrap_Struct (notmuch_rb_cThreads, NULL, NULL, threads); } /* * call-seq: QUERY.search_messages => MESSAGES * * Search for messages */ VALUE notmuch_rb_query_search_messages (VALUE self) { notmuch_query_t *query; notmuch_messages_t *messages; notmuch_status_t status; Data_Get_Notmuch_Query (self, query); status = notmuch_query_search_messages_st (query, &messages); if (status) notmuch_rb_status_raise (status); return Data_Wrap_Struct (notmuch_rb_cMessages, NULL, NULL, messages); } /* * call-seq: QUERY.count_messages => Fixnum * * Return an estimate of the number of messages matching a search */ VALUE notmuch_rb_query_count_messages (VALUE self) { notmuch_query_t *query; notmuch_status_t status; unsigned int count; Data_Get_Notmuch_Query (self, query); status = notmuch_query_count_messages_st (query, &count); if (status) notmuch_rb_status_raise (status); return UINT2NUM(count); } /* * call-seq: QUERY.count_threads => Fixnum * * Return an estimate of the number of threads matching a search */ VALUE notmuch_rb_query_count_threads (VALUE self) { notmuch_query_t *query; notmuch_status_t status; unsigned int count; Data_Get_Notmuch_Query (self, query); status = notmuch_query_count_threads_st (query, &count); if (status) notmuch_rb_status_raise (status); return UINT2NUM(count); } notmuch-0.23.7/bindings/ruby/rdoc.sh000077500000000000000000000005131305541522400173240ustar00rootroot00000000000000#!/bin/sh if test -z "$RDOC"; then RDOC=rdoc if which rdoc19 >/dev/null 2>&1; then RDOC=rdoc19 fi fi set -e set -x $RDOC --main 'Notmuch' --title 'Notmuch Ruby API' --op ruby *.c if test "$1" = "--upload"; then rsync -avze ssh --delete --partial --progress ruby bach.exherbo.org:public_html/notmuch/ fi notmuch-0.23.7/bindings/ruby/status.c000066400000000000000000000036761305541522400175420ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" void notmuch_rb_status_raise (notmuch_status_t status) { switch (status) { case NOTMUCH_STATUS_SUCCESS: case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: break; case NOTMUCH_STATUS_OUT_OF_MEMORY: rb_raise (notmuch_rb_eMemoryError, "out of memory"); case NOTMUCH_STATUS_READ_ONLY_DATABASE: rb_raise (notmuch_rb_eReadOnlyError, "read-only database"); case NOTMUCH_STATUS_XAPIAN_EXCEPTION: rb_raise (notmuch_rb_eXapianError, "xapian exception"); case NOTMUCH_STATUS_FILE_ERROR: rb_raise (notmuch_rb_eFileError, "failed to read/write file"); case NOTMUCH_STATUS_FILE_NOT_EMAIL: rb_raise (notmuch_rb_eFileNotEmailError, "file not email"); case NOTMUCH_STATUS_NULL_POINTER: rb_raise (notmuch_rb_eNullPointerError, "null pointer"); case NOTMUCH_STATUS_TAG_TOO_LONG: rb_raise (notmuch_rb_eTagTooLongError, "tag too long"); case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: rb_raise (notmuch_rb_eUnbalancedFreezeThawError, "unbalanced freeze/thaw"); case NOTMUCH_STATUS_UNBALANCED_ATOMIC: rb_raise (notmuch_rb_eUnbalancedAtomicError, "unbalanced atomic"); default: rb_raise (notmuch_rb_eBaseError, "unknown notmuch error"); } } notmuch-0.23.7/bindings/ruby/tags.c000066400000000000000000000030201305541522400171340ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: TAGS.destroy! => nil * * Destroys the tags, freeing all resources allocated for it. */ VALUE notmuch_rb_tags_destroy (VALUE self) { notmuch_tags_t *tags; Data_Get_Notmuch_Tags (self, tags); notmuch_tags_destroy (tags); DATA_PTR (self) = NULL; return Qnil; } /* * call-seq: TAGS.each {|item| block } => TAGS * * Calls +block+ once for each element in +self+, passing that element as a * parameter. */ VALUE notmuch_rb_tags_each (VALUE self) { const char *tag; notmuch_tags_t *tags; Data_Get_Notmuch_Tags (self, tags); for (; notmuch_tags_valid (tags); notmuch_tags_move_to_next (tags)) { tag = notmuch_tags_get (tags); rb_yield (rb_str_new2 (tag)); } return self; } notmuch-0.23.7/bindings/ruby/thread.c000066400000000000000000000112411305541522400174510ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: THREAD.destroy! => nil * * Destroys the thread, freeing all resources allocated for it. */ VALUE notmuch_rb_thread_destroy (VALUE self) { notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); notmuch_thread_destroy (thread); DATA_PTR (self) = NULL; return Qnil; } /* * call-seq: THREAD.thread_id => String * * Returns the thread id */ VALUE notmuch_rb_thread_get_thread_id (VALUE self) { const char *tid; notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); tid = notmuch_thread_get_thread_id (thread); return rb_str_new2 (tid); } /* * call-seq: THREAD.total_messages => fixnum * * Returns the number of total messages */ VALUE notmuch_rb_thread_get_total_messages (VALUE self) { notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); return INT2FIX (notmuch_thread_get_total_messages (thread)); } /* * call-seq: THREAD.toplevel_messages => MESSAGES * * Get a Notmuch::Messages iterator for the top level messages in thread. */ VALUE notmuch_rb_thread_get_toplevel_messages (VALUE self) { notmuch_messages_t *messages; notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); messages = notmuch_thread_get_toplevel_messages (thread); if (!messages) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return Data_Wrap_Struct (notmuch_rb_cMessages, NULL, NULL, messages); } /* * call-seq: THREAD.messages => MESSAGES * * Get a Notmuch::Messages iterator for the all messages in thread. */ VALUE notmuch_rb_thread_get_messages (VALUE self) { notmuch_messages_t *messages; notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); messages = notmuch_thread_get_messages (thread); if (!messages) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return Data_Wrap_Struct (notmuch_rb_cMessages, NULL, NULL, messages); } /* * call-seq: THREAD.matched_messages => fixnum * * Get the number of messages in thread that matched the search */ VALUE notmuch_rb_thread_get_matched_messages (VALUE self) { notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); return INT2FIX (notmuch_thread_get_matched_messages (thread)); } /* * call-seq: THREAD.authors => String * * Get a comma-separated list of the names of the authors. */ VALUE notmuch_rb_thread_get_authors (VALUE self) { const char *authors; notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); authors = notmuch_thread_get_authors (thread); return rb_str_new2 (authors); } /* * call-seq: THREAD.subject => String * * Returns the subject of the thread */ VALUE notmuch_rb_thread_get_subject (VALUE self) { const char *subject; notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); subject = notmuch_thread_get_subject (thread); return rb_str_new2 (subject); } /* * call-seq: THREAD.oldest_date => Fixnum * * Get the date of the oldest message in thread. */ VALUE notmuch_rb_thread_get_oldest_date (VALUE self) { notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); return UINT2NUM (notmuch_thread_get_oldest_date (thread)); } /* * call-seq: THREAD.newest_date => fixnum * * Get the date of the newest message in thread. */ VALUE notmuch_rb_thread_get_newest_date (VALUE self) { notmuch_thread_t *thread; Data_Get_Notmuch_Thread (self, thread); return UINT2NUM (notmuch_thread_get_newest_date (thread)); } /* * call-seq: THREAD.tags => TAGS * * Get a Notmuch::Tags iterator for the tags of the thread */ VALUE notmuch_rb_thread_get_tags (VALUE self) { notmuch_thread_t *thread; notmuch_tags_t *tags; Data_Get_Notmuch_Thread (self, thread); tags = notmuch_thread_get_tags (thread); if (!tags) rb_raise (notmuch_rb_eMemoryError, "Out of memory"); return Data_Wrap_Struct (notmuch_rb_cTags, NULL, NULL, tags); } notmuch-0.23.7/bindings/ruby/threads.c000066400000000000000000000032141305541522400176350ustar00rootroot00000000000000/* The Ruby interface to the notmuch mail library * * Copyright © 2010, 2011 Ali Polatel * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Ali Polatel */ #include "defs.h" /* * call-seq: THREADS.destroy! => nil * * Destroys the threads, freeing all resources allocated for it. */ VALUE notmuch_rb_threads_destroy (VALUE self) { notmuch_threads_t *threads; Data_Get_Struct (self, notmuch_threads_t, threads); notmuch_threads_destroy (threads); DATA_PTR (self) = NULL; return Qnil; } /* call-seq: THREADS.each {|item| block } => THREADS * * Calls +block+ once for each thread in +self+, passing that element as a * parameter. */ VALUE notmuch_rb_threads_each (VALUE self) { notmuch_thread_t *thread; notmuch_threads_t *threads; Data_Get_Notmuch_Threads (self, threads); for (; notmuch_threads_valid (threads); notmuch_threads_move_to_next (threads)) { thread = notmuch_threads_get (threads); rb_yield (Data_Wrap_Struct (notmuch_rb_cThread, NULL, NULL, thread)); } return self; } notmuch-0.23.7/command-line-arguments.c000066400000000000000000000127711305541522400200030ustar00rootroot00000000000000#include #include #include #include "error_util.h" #include "command-line-arguments.h" /* Search the array of keywords for a given argument, assigning the output variable to the corresponding value. Return FALSE if nothing matches. */ static notmuch_bool_t _process_keyword_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) { const notmuch_keyword_t *keywords = arg_desc->keywords; if (next == '\0') { /* No keyword given */ arg_str = ""; } while (keywords->name) { if (strcmp (arg_str, keywords->name) == 0) { if (arg_desc->output_var) { if (arg_desc->opt_type == NOTMUCH_OPT_KEYWORD_FLAGS) *((int *)arg_desc->output_var) |= keywords->value; else *((int *)arg_desc->output_var) = keywords->value; } return TRUE; } keywords++; } if (next != '\0') fprintf (stderr, "Unknown keyword argument \"%s\" for option \"%s\".\n", arg_str, arg_desc->name); else fprintf (stderr, "Option \"%s\" needs a keyword argument.\n", arg_desc->name); return FALSE; } static notmuch_bool_t _process_boolean_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) { if (next == '\0') { *((notmuch_bool_t *)arg_desc->output_var) = TRUE; return TRUE; } if (strcmp (arg_str, "false") == 0) { *((notmuch_bool_t *)arg_desc->output_var) = FALSE; return TRUE; } if (strcmp (arg_str, "true") == 0) { *((notmuch_bool_t *)arg_desc->output_var) = TRUE; return TRUE; } fprintf (stderr, "Unknown argument \"%s\" for (boolean) option \"%s\".\n", arg_str, arg_desc->name); return FALSE; } static notmuch_bool_t _process_int_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) { char *endptr; if (next == '\0' || arg_str[0] == '\0') { fprintf (stderr, "Option \"%s\" needs an integer argument.\n", arg_desc->name); return FALSE; } *((int *)arg_desc->output_var) = strtol (arg_str, &endptr, 10); if (*endptr == '\0') return TRUE; fprintf (stderr, "Unable to parse argument \"%s\" for option \"%s\" as an integer.\n", arg_str, arg_desc->name); return FALSE; } static notmuch_bool_t _process_string_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) { if (next == '\0') { fprintf (stderr, "Option \"%s\" needs a string argument.\n", arg_desc->name); return FALSE; } if (arg_str[0] == '\0') { fprintf (stderr, "String argument for option \"%s\" must be non-empty.\n", arg_desc->name); return FALSE; } *((const char **)arg_desc->output_var) = arg_str; return TRUE; } /* Search for the {pos_arg_index}th position argument, return FALSE if that does not exist. */ notmuch_bool_t parse_position_arg (const char *arg_str, int pos_arg_index, const notmuch_opt_desc_t *arg_desc) { int pos_arg_counter = 0; while (arg_desc->opt_type != NOTMUCH_OPT_END){ if (arg_desc->opt_type == NOTMUCH_OPT_POSITION) { if (pos_arg_counter == pos_arg_index) { if (arg_desc->output_var) { *((const char **)arg_desc->output_var) = arg_str; } return TRUE; } pos_arg_counter++; } arg_desc++; } return FALSE; } /* * Search for a non-positional (i.e. starting with --) argument matching arg, * parse a possible value, and assign to *output_var */ notmuch_bool_t parse_option (const char *_arg, const notmuch_opt_desc_t *options) { assert(_arg); assert(options); const char *arg = _arg + 2; /* _arg starts with -- */ const notmuch_opt_desc_t *try; for (try = options; try->opt_type != NOTMUCH_OPT_END; try++) { if (try->opt_type == NOTMUCH_OPT_INHERIT && parse_option (_arg, try->output_var)) return TRUE; if (! try->name) continue; if (strncmp (arg, try->name, strlen (try->name)) != 0) continue; char next = arg[strlen (try->name)]; const char *value = arg + strlen(try->name) + 1; /* * If we have not reached the end of the argument (i.e. the * next character is not a space or delimiter) then the * argument could still match a longer option name later in * the option table. */ if (next != '=' && next != ':' && next != '\0') continue; if (try->output_var == NULL) INTERNAL_ERROR ("output pointer NULL for option %s", try->name); switch (try->opt_type) { case NOTMUCH_OPT_KEYWORD: case NOTMUCH_OPT_KEYWORD_FLAGS: return _process_keyword_arg (try, next, value); case NOTMUCH_OPT_BOOLEAN: return _process_boolean_arg (try, next, value); case NOTMUCH_OPT_INT: return _process_int_arg (try, next, value); case NOTMUCH_OPT_STRING: return _process_string_arg (try, next, value); case NOTMUCH_OPT_POSITION: case NOTMUCH_OPT_END: default: INTERNAL_ERROR ("unknown or unhandled option type %d", try->opt_type); /*UNREACHED*/ } } return FALSE; } /* See command-line-arguments.h for description */ int parse_arguments (int argc, char **argv, const notmuch_opt_desc_t *options, int opt_index) { int pos_arg_index = 0; notmuch_bool_t more_args = TRUE; while (more_args && opt_index < argc) { if (strncmp (argv[opt_index],"--",2) != 0) { more_args = parse_position_arg (argv[opt_index], pos_arg_index, options); if (more_args) { pos_arg_index++; opt_index++; } } else { if (strlen (argv[opt_index]) == 2) return opt_index+1; more_args = parse_option (argv[opt_index], options); if (more_args) { opt_index++; } else { fprintf (stderr, "Unrecognized option: %s\n", argv[opt_index]); opt_index = -1; } } } return opt_index; } notmuch-0.23.7/command-line-arguments.h000066400000000000000000000043301305541522400200000ustar00rootroot00000000000000#ifndef NOTMUCH_OPTS_H #define NOTMUCH_OPTS_H #include "notmuch.h" enum notmuch_opt_type { NOTMUCH_OPT_END = 0, NOTMUCH_OPT_INHERIT, /* another options table */ NOTMUCH_OPT_BOOLEAN, /* --verbose */ NOTMUCH_OPT_INT, /* --frob=8 */ NOTMUCH_OPT_KEYWORD, /* --format=raw|json|text */ NOTMUCH_OPT_KEYWORD_FLAGS, /* the above with values OR'd together */ NOTMUCH_OPT_STRING, /* --file=/tmp/gnarf.txt */ NOTMUCH_OPT_POSITION /* notmuch dump pos_arg */ }; /* * Describe one of the possibilities for a keyword option * 'value' will be copied to the output variable */ typedef struct notmuch_keyword { const char *name; int value; } notmuch_keyword_t; /* * Describe one option. * * First two parameters are mandatory. * * name is mandatory _except_ for positional arguments. * * arg_id is currently unused, but could define short arguments. * * keywords is a (possibly NULL) pointer to an array of keywords */ typedef struct notmuch_opt_desc { enum notmuch_opt_type opt_type; void *output_var; const char *name; int arg_id; const struct notmuch_keyword *keywords; } notmuch_opt_desc_t; /* This is the main entry point for command line argument parsing. Parse command line arguments according to structure options, starting at position opt_index. All output of parsed values is via pointers in options. Parsing stops at -- (consumed) or at the (k+1)st argument not starting with -- (a "positional argument") if options contains k positional argument descriptors. Returns the index of first non-parsed argument, or -1 in case of error. */ int parse_arguments (int argc, char **argv, const notmuch_opt_desc_t *options, int opt_index); /* * If the argument parsing loop provided by parse_arguments is not * flexible enough, then the user might be interested in the following * routines, but note that the API to parse_option might have to * change. See command-line-arguments.c for descriptions of these * functions. */ notmuch_bool_t parse_option (const char *arg, const notmuch_opt_desc_t* options); notmuch_bool_t parse_position_arg (const char *arg, int position_arg_index, const notmuch_opt_desc_t* options); #endif notmuch-0.23.7/compat/000077500000000000000000000000001305541522400145445ustar00rootroot00000000000000notmuch-0.23.7/compat/.gitignore000066400000000000000000000000101305541522400165230ustar00rootroot00000000000000zlib.pc notmuch-0.23.7/compat/Makefile000066400000000000000000000000651305541522400162050ustar00rootroot00000000000000all: $(MAKE) -C .. all .DEFAULT: $(MAKE) -C .. $@ notmuch-0.23.7/compat/Makefile.local000066400000000000000000000010441305541522400172740ustar00rootroot00000000000000# -*- makefile -*- dir := compat extra_cflags += -I$(srcdir)/$(dir) notmuch_compat_srcs := ifneq ($(HAVE_CANONICALIZE_FILE_NAME),1) notmuch_compat_srcs += $(dir)/canonicalize_file_name.c endif ifneq ($(HAVE_GETLINE),1) notmuch_compat_srcs += $(dir)/getline.c $(dir)/getdelim.c endif ifneq ($(HAVE_STRCASESTR),1) notmuch_compat_srcs += $(dir)/strcasestr.c endif ifneq ($(HAVE_STRSEP),1) notmuch_compat_srcs += $(dir)/strsep.c endif ifneq ($(HAVE_TIMEGM),1) notmuch_compat_srcs += $(dir)/timegm.c endif SRCS := $(SRCS) $(notmuch_compat_srcs) notmuch-0.23.7/compat/README000066400000000000000000000011301305541522400154170ustar00rootroot00000000000000notmuch/compat This directory consists of three things: 1. Small programs used by the notmuch configure script to test for the availability of certain system features, (library functions, etc.). For example: have_getline.c 2. Compatibility implementations of those system features for systems that don't provide their own versions. For example: getline.c The compilation of these files is made conditional on the output of the test programs from [1]. 3. Macro definitions abstracting compiler differences (e.g. function attributes). For example: function-attributes.h notmuch-0.23.7/compat/canonicalize_file_name.c000066400000000000000000000005711305541522400213510ustar00rootroot00000000000000#include "compat.h" #include #undef _GNU_SOURCE #include char * canonicalize_file_name (const char * path) { #ifdef PATH_MAX char *resolved_path = malloc (PATH_MAX+1); if (resolved_path == NULL) return NULL; return realpath (path, resolved_path); #else #error undefined PATH_MAX _and_ missing canonicalize_file_name not supported #endif } notmuch-0.23.7/compat/check_asctime.c000066400000000000000000000001731305541522400174730ustar00rootroot00000000000000#include #include int main() { struct tm tm; (void) asctime_r (&tm, NULL); return (0); } notmuch-0.23.7/compat/check_getpwuid.c000066400000000000000000000002411305541522400176720ustar00rootroot00000000000000#include #include int main() { struct passwd passwd, *ignored; (void) getpwuid_r (0, &passwd, NULL, 0, &ignored); return (0); } notmuch-0.23.7/compat/compat.h000066400000000000000000000043101305541522400161760ustar00rootroot00000000000000/* notmuch - Not much of an email library, (just index and search) * * Copyright © 2009 Carl Worth * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Carl Worth */ /* This header file defines functions that will only be conditionally * compiled for compatibility on systems that don't provide their own * implementations of the functions. */ #ifndef NOTMUCH_COMPAT_H #define NOTMUCH_COMPAT_H #ifdef __cplusplus extern "C" { #endif #if !STD_GETPWUID #define _POSIX_PTHREAD_SEMANTICS 1 #endif #if !STD_ASCTIME #define _POSIX_PTHREAD_SEMANTICS 1 #endif #if !HAVE_CANONICALIZE_FILE_NAME /* we only call this function from C, and this makes testing easier */ #ifndef __cplusplus char * canonicalize_file_name (const char *path); #endif #endif #if !HAVE_GETLINE #include #include ssize_t getline (char **lineptr, size_t *n, FILE *stream); ssize_t getdelim (char **lineptr, size_t *n, int delimiter, FILE *fp); #endif /* !HAVE_GETLINE */ #if !HAVE_STRCASESTR char* strcasestr(const char *haystack, const char *needle); #endif /* !HAVE_STRCASESTR */ #if !HAVE_STRSEP char *strsep(char **stringp, const char *delim); #endif /* !HAVE_STRSEP */ #if !HAVE_TIMEGM #include time_t timegm (struct tm *tm); #endif /* !HAVE_TIMEGM */ /* Silence gcc warnings about unused results. These warnings exist * for a reason; any use of this needs to be justified. */ #ifdef __GNUC__ #define IGNORE_RESULT(x) ({ __typeof__(x) __z = (x); (void)(__z = __z); }) #else /* !__GNUC__ */ #define IGNORE_RESULT(x) x #endif /* __GNUC__ */ #ifdef __cplusplus } #endif #endif /* NOTMUCH_COMPAT_H */ notmuch-0.23.7/compat/function-attributes.h000066400000000000000000000030511305541522400207250ustar00rootroot00000000000000/* function-attributes.h - Provides compiler abstractions for * function attributes * * Copyright (c) 2012 Justus Winter <4winter@informatik.uni-hamburg.de> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . */ #ifndef FUNCTION_ATTRIBUTES_H #define FUNCTION_ATTRIBUTES_H /* clang provides this macro to test for support for function * attributes. If it isn't defined, this provides a compatibility * macro for other compilers. */ #ifndef __has_attribute #define __has_attribute(x) 0 #endif /* Provide a NORETURN_ATTRIBUTE macro similar to PRINTF_ATTRIBUTE from * talloc. * * This attribute is understood by gcc since version 2.5. clang * provides support for testing for function attributes. */ #ifndef NORETURN_ATTRIBUTE #if (__GNUC__ >= 3 || \ (__GNUC__ == 2 && __GNUC_MINOR__ >= 5) || \ __has_attribute (noreturn)) #define NORETURN_ATTRIBUTE __attribute__ ((noreturn)) #else #define NORETURN_ATTRIBUTE #endif #endif #endif notmuch-0.23.7/compat/gen_zlib_pc.c000066400000000000000000000004611305541522400171640ustar00rootroot00000000000000#include #include static const char *template = "prefix=/usr\n" "exec_prefix=${prefix}\n" "libdir=${exec_prefix}/lib\n" "\n" "Name: zlib\n" "Description: zlib compression library\n" "Version: %s\n" "Libs: -lz\n"; int main(void) { printf(template, ZLIB_VERSION); return 0; } notmuch-0.23.7/compat/getdelim.c000066400000000000000000000063501305541522400165060ustar00rootroot00000000000000/* getdelim.c --- Implementation of replacement getdelim function. Copyright (C) 1994, 1996, 1997, 1998, 2001, 2003, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /* Ported from glibc by Simon Josefsson. */ #include "compat.h" #include #include #include #include #include #ifndef SSIZE_MAX # define SSIZE_MAX ((ssize_t) (SIZE_MAX / 2)) #endif #if USE_UNLOCKED_IO # include "unlocked-io.h" # define getc_maybe_unlocked(fp) getc(fp) #elif !HAVE_FLOCKFILE || !HAVE_FUNLOCKFILE || !HAVE_DECL_GETC_UNLOCKED # undef flockfile # undef funlockfile # define flockfile(x) ((void) 0) # define funlockfile(x) ((void) 0) # define getc_maybe_unlocked(fp) getc(fp) #else # define getc_maybe_unlocked(fp) getc_unlocked(fp) #endif /* Read up to (and including) a DELIMITER from FP into *LINEPTR (and NUL-terminate it). *LINEPTR is a pointer returned from malloc (or NULL), pointing to *N characters of space. It is realloc'ed as necessary. Returns the number of characters read (not including the null terminator), or -1 on error or EOF. */ ssize_t getdelim (char **lineptr, size_t *n, int delimiter, FILE *fp) { ssize_t result = -1; size_t cur_len = 0; if (lineptr == NULL || n == NULL || fp == NULL) { errno = EINVAL; return -1; } flockfile (fp); if (*lineptr == NULL || *n == 0) { char *new_lineptr; *n = 120; new_lineptr = (char *) realloc (*lineptr, *n); if (new_lineptr == NULL) { result = -1; goto unlock_return; } *lineptr = new_lineptr; } for (;;) { int i; i = getc_maybe_unlocked (fp); if (i == EOF) { result = -1; break; } /* Make enough space for len+1 (for final NUL) bytes. */ if (cur_len + 1 >= *n) { size_t needed_max = SSIZE_MAX < SIZE_MAX ? (size_t) SSIZE_MAX + 1 : SIZE_MAX; size_t needed = 2 * *n + 1; /* Be generous. */ char *new_lineptr; if (needed_max < needed) needed = needed_max; if (cur_len + 1 >= needed) { result = -1; errno = EOVERFLOW; goto unlock_return; } new_lineptr = (char *) realloc (*lineptr, needed); if (new_lineptr == NULL) { result = -1; goto unlock_return; } *lineptr = new_lineptr; *n = needed; } (*lineptr)[cur_len] = i; cur_len++; if (i == delimiter) break; } (*lineptr)[cur_len] = '\0'; result = cur_len ? (ssize_t) cur_len : result; unlock_return: funlockfile (fp); /* doesn't set errno */ return result; } notmuch-0.23.7/compat/getline.c000066400000000000000000000017761305541522400163520ustar00rootroot00000000000000/* getline.c --- Implementation of replacement getline function. Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /* Written by Simon Josefsson. */ #include "compat.h" #include ssize_t getline (char **lineptr, size_t *n, FILE *stream) { return getdelim (lineptr, n, '\n', stream); } notmuch-0.23.7/compat/have_canonicalize_file_name.c000066400000000000000000000002111305541522400223430ustar00rootroot00000000000000#define _GNU_SOURCE #include int main() { char *found; char *string; found = canonicalize_file_name (string); } notmuch-0.23.7/compat/have_d_type.c000066400000000000000000000001421305541522400171740ustar00rootroot00000000000000#include int main() { struct dirent ent; (void) ent.d_type; return 0; } notmuch-0.23.7/compat/have_getline.c000066400000000000000000000003261305541522400173430ustar00rootroot00000000000000#define _GNU_SOURCE #include #include int main() { ssize_t count = 0; size_t n = 0; char **lineptr = NULL; FILE *stream = NULL; count = getline(lineptr, &n, stream); } notmuch-0.23.7/compat/have_strcasestr.c000066400000000000000000000002301305541522400201030ustar00rootroot00000000000000#define _GNU_SOURCE #include int main() { char *found; const char *haystack, *needle; found = strcasestr(haystack, needle); } notmuch-0.23.7/compat/have_strsep.c000066400000000000000000000002311305541522400172270ustar00rootroot00000000000000#define _GNU_SOURCE #include int main() { char *found; char **stringp; const char *delim; found = strsep(stringp, delim); } notmuch-0.23.7/compat/have_timegm.c000066400000000000000000000001371305541522400171760ustar00rootroot00000000000000#include #include "compat.h" int main() { return (int) timegm((struct tm *)0); } notmuch-0.23.7/compat/strcasestr.c000066400000000000000000000023371305541522400171120ustar00rootroot00000000000000/* * slow simplistic reimplementation of strcasestr for systems that * don't include it in their library * * based on a GPL implementation in OpenTTD found under GPL v2 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /* Imported into notmuch by Dirk Hohndel - original author unknown. */ #include #include "compat.h" char *strcasestr(const char *haystack, const char *needle) { size_t hay_len = strlen(haystack); size_t needle_len = strlen(needle); while (hay_len >= needle_len) { if (strncasecmp(haystack, needle, needle_len) == 0) return (char *) haystack; haystack++; hay_len--; } return NULL; } notmuch-0.23.7/compat/strsep.c000066400000000000000000000034431305541522400162340ustar00rootroot00000000000000/* Copyright (C) 1992, 93, 96, 97, 98, 99, 2004 Free Software Foundation, Inc. This file is part of the GNU C Library. The GNU C Library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. The GNU C Library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with the GNU C Library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. */ #include /* Taken from glibc 2.6.1 */ char *strsep (char **stringp, const char *delim) { char *begin, *end; begin = *stringp; if (begin == NULL) return NULL; /* A frequent case is when the delimiter string contains only one character. Here we don't need to call the expensive `strpbrk' function and instead work using `strchr'. */ if (delim[0] == '\0' || delim[1] == '\0') { char ch = delim[0]; if (ch == '\0') end = NULL; else { if (*begin == ch) end = begin; else if (*begin == '\0') end = NULL; else end = strchr (begin + 1, ch); } } else /* Find the end of the token. */ end = strpbrk (begin, delim); if (end) { /* Terminate the token and set *STRINGP past NUL character. */ *end++ = '\0'; *stringp = end; } else /* No more delimiters; this is the last token. */ *stringp = NULL; return begin; } notmuch-0.23.7/compat/timegm.c000066400000000000000000000033461305541522400162000ustar00rootroot00000000000000/* timegm.c --- Implementation of replacement timegm function. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /* Copyright 2013 Blake Jones. */ #include #include "compat.h" static int leapyear (int year) { return ((year % 4) == 0 && ((year % 100) != 0 || (year % 400) == 0)); } /* * This is a simple implementation of timegm() which does what is needed * by create_output() -- just turns the "struct tm" into a GMT time_t. * It does not normalize any of the fields of the "struct tm", nor does * it set tm_wday or tm_yday. */ time_t timegm (struct tm *tm) { int monthlen[2][12] = { { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }, { 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }, }; int year, month, days; days = 365 * (tm->tm_year - 70); for (year = 70; year < tm->tm_year; year++) { if (leapyear(1900 + year)) { days++; } } for (month = 0; month < tm->tm_mon; month++) { days += monthlen[leapyear(1900 + year)][month]; } days += tm->tm_mday - 1; return ((((days * 24) + tm->tm_hour) * 60 + tm->tm_min) * 60 + tm->tm_sec); } notmuch-0.23.7/completion/000077500000000000000000000000001305541522400154325ustar00rootroot00000000000000notmuch-0.23.7/completion/Makefile000066400000000000000000000002041305541522400170660ustar00rootroot00000000000000# See Makefile.local for the list of files to be compiled in this # directory. all: $(MAKE) -C .. all .DEFAULT: $(MAKE) -C .. $@ notmuch-0.23.7/completion/Makefile.local000066400000000000000000000012531305541522400201640ustar00rootroot00000000000000# -*- makefile -*- dir := completion # The dir variable will be re-assigned to later, so we can't use it # directly in any shell commands. Instead we save its value in other, # private variables that we can use in the commands. bash_script := $(srcdir)/$(dir)/notmuch-completion.bash zsh_script := $(srcdir)/$(dir)/notmuch-completion.zsh install: install-$(dir) install-$(dir): @echo $@ ifeq ($(WITH_BASH),1) mkdir -p "$(DESTDIR)$(bash_completion_dir)" install -m0644 $(bash_script) "$(DESTDIR)$(bash_completion_dir)/notmuch" endif ifeq ($(WITH_ZSH),1) mkdir -p "$(DESTDIR)$(zsh_completion_dir)" install -m0644 $(zsh_script) "$(DESTDIR)$(zsh_completion_dir)/_notmuch" endif notmuch-0.23.7/completion/README000066400000000000000000000006601305541522400163140ustar00rootroot00000000000000notmuch completion This directory contains support for various shells to automatically complete partially entered notmuch command lines. notmuch-completion.bash Command-line completion for the bash shell. This depends on bash-completion package [1] version 2.0, which depends on bash version 3.2 or later. [1] https://github.com/scop/bash-completion notmuch-completion.zsh Command-line completion for the zsh shell. notmuch-0.23.7/completion/notmuch-completion.bash000066400000000000000000000275251305541522400221300ustar00rootroot00000000000000# bash completion for notmuch -*- shell-script -*- # # Copyright © 2013 Jani Nikula # # Based on the bash-completion package: # https://github.com/scop/bash-completion # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see https://www.gnu.org/licenses/ . # # Author: Jani Nikula # # # BUGS: # # Add space after an --option without parameter (e.g. reply --decrypt) # on completion. # _notmuch_shared_options="--help --uuid= --version" # $1: current input of the form prefix:partialinput, where prefix is # to or from. _notmuch_email() { local output prefix cur prefix="${1%%:*}" cur="${1#*:}" # Cut the input to be completed at punctuation because # (apparently) Xapian does not support the trailing wildcard '*' # operator for input with punctuation. We let compgen handle the # extra filtering required. cur="${cur%%[^a-zA-Z0-9]*}" case "$prefix" in # Note: It would be more accurate and less surprising to have # output=recipients here for to: addresses, but as gathering # the recipient addresses requires disk access for each # matching message, this becomes prohibitively slow. to|from) output=sender;; *) return;; esac # Only emit plain, lower case, unique addresses. notmuch address --output=$output $prefix:"${cur}*" | \ sed 's/[^<]*<\([^>]*\)>/\1/' | tr "[:upper:]" "[:lower:]" | sort -u } _notmuch_search_terms() { local cur prev words cword split # handle search prefixes and tags with colons and equal signs _init_completion -n := || return case "${cur}" in tag:*) COMPREPLY=( $(compgen -P "tag:" -W "`notmuch search --output=tags \*`" -- ${cur##tag:}) ) ;; to:*) COMPREPLY=( $(compgen -P "to:" -W "`_notmuch_email ${cur}`" -- ${cur##to:}) ) ;; from:*) COMPREPLY=( $(compgen -P "from:" -W "`_notmuch_email ${cur}`" -- ${cur##from:}) ) ;; path:*) local path=`notmuch config get database.path` compopt -o nospace COMPREPLY=( $(compgen -d "$path/${cur##path:}" | sed "s|^$path/||" ) ) ;; folder:*) local path=`notmuch config get database.path` compopt -o nospace COMPREPLY=( $(compgen -d "$path/${cur##folder:}" | \ sed "s|^$path/||" | grep -v "\(^\|/\)\(cur\|new\|tmp\)$" ) ) ;; *) local search_terms="from: to: subject: attachment: mimetype: tag: id: thread: folder: path: date: lastmod:" compopt -o nospace COMPREPLY=( $(compgen -W "${search_terms}" -- ${cur}) ) ;; esac # handle search prefixes and tags with colons __ltrim_colon_completions "${cur}" } _notmuch_compact() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --backup) _filedir -d return ;; esac ! $split && case "${cur}" in -*) local options="--backup= --quiet ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; esac } _notmuch_config() { local cur prev words cword split _init_completion || return case "${prev}" in config) COMPREPLY=( $(compgen -W "get set list" -- ${cur}) ) ;; get|set) COMPREPLY=( $(compgen -W "`notmuch config list | sed 's/=.*\$//'`" -- ${cur}) ) ;; # these will also complete on config get, but we don't care database.path) _filedir -d ;; maildir.synchronize_flags) COMPREPLY=( $(compgen -W "true false" -- ${cur}) ) ;; esac } _notmuch_count() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --output) COMPREPLY=( $( compgen -W "messages threads files" -- "${cur}" ) ) return ;; --exclude) COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) ) return ;; --input) _filedir return ;; esac ! $split && case "${cur}" in -*) local options="--output= --exclude= --batch --input= --lastmod ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; *) _notmuch_search_terms ;; esac } _notmuch_dump() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --format) COMPREPLY=( $( compgen -W "sup batch-tag" -- "${cur}" ) ) return ;; --output) _filedir return ;; esac ! $split && case "${cur}" in -*) local options="--gzip --format= --output= ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; *) _notmuch_search_terms ;; esac } _notmuch_insert() { local cur prev words cword split # handle tags with colons and equal signs _init_completion -s -n := || return $split && case "${prev}" in --folder) local path=`notmuch config get database.path` compopt -o nospace COMPREPLY=( $(compgen -d "$path/${cur}" | \ sed "s|^$path/||" | grep -v "\(^\|/\)\(cur\|new\|tmp\)$" ) ) return ;; esac ! $split && case "${cur}" in --*) local options="--create-folder --folder= --keep --no-hooks ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) return ;; +*) COMPREPLY=( $(compgen -P "+" -W "`notmuch search --output=tags \*`" -- ${cur##+}) ) ;; -*) COMPREPLY=( $(compgen -P "-" -W "`notmuch search --output=tags \*`" -- ${cur##-}) ) ;; esac # handle tags with colons __ltrim_colon_completions "${cur}" } _notmuch_new() { local cur prev words cword split _init_completion || return case "${cur}" in -*) local options="--no-hooks --quiet ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "${options}" -- ${cur}) ) ;; esac } _notmuch_reply() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --format) COMPREPLY=( $( compgen -W "default json sexp headers-only" -- "${cur}" ) ) return ;; --reply-to) COMPREPLY=( $( compgen -W "all sender" -- "${cur}" ) ) return ;; esac ! $split && case "${cur}" in -*) local options="--format= --format-version= --reply-to= --decrypt ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; *) _notmuch_search_terms ;; esac } _notmuch_restore() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --format) COMPREPLY=( $( compgen -W "sup batch-tag auto" -- "${cur}" ) ) return ;; --input) _filedir return ;; esac ! $split && case "${cur}" in -*) local options="--format= --accumulate --input= ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; esac } _notmuch_search() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --format) COMPREPLY=( $( compgen -W "json sexp text text0" -- "${cur}" ) ) return ;; --output) COMPREPLY=( $( compgen -W "summary threads messages files tags" -- "${cur}" ) ) return ;; --sort) COMPREPLY=( $( compgen -W "newest-first oldest-first" -- "${cur}" ) ) return ;; --exclude) COMPREPLY=( $( compgen -W "true false flag all" -- "${cur}" ) ) return ;; esac ! $split && case "${cur}" in -*) local options="--format= --output= --sort= --offset= --limit= --exclude= --duplicate= ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; *) _notmuch_search_terms ;; esac } _notmuch_address() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --format) COMPREPLY=( $( compgen -W "json sexp text text0" -- "${cur}" ) ) return ;; --output) COMPREPLY=( $( compgen -W "sender recipients count" -- "${cur}" ) ) return ;; --sort) COMPREPLY=( $( compgen -W "newest-first oldest-first" -- "${cur}" ) ) return ;; --exclude) COMPREPLY=( $( compgen -W "true false flag all" -- "${cur}" ) ) return ;; --deduplicate) COMPREPLY=( $( compgen -W "no mailbox address" -- "${cur}" ) ) return ;; esac ! $split && case "${cur}" in -*) local options="--format= --output= --sort= --exclude= --deduplicate= ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; *) _notmuch_search_terms ;; esac } _notmuch_show() { local cur prev words cword split _init_completion -s || return $split && case "${prev}" in --entire-thread) COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) ) return ;; --format) COMPREPLY=( $( compgen -W "text json sexp mbox raw" -- "${cur}" ) ) return ;; --exclude|--body) COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) ) return ;; esac ! $split && case "${cur}" in -*) local options="--entire-thread= --format= --exclude= --body= --format-version= --part= --verify --decrypt --include-html ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) ;; *) _notmuch_search_terms ;; esac } _notmuch_tag() { local cur prev words cword split # handle tags with colons and equal signs _init_completion -s -n := || return $split && case "${prev}" in --input) _filedir return ;; esac ! $split && case "${cur}" in --*) local options="--batch --input= --remove-all ${_notmuch_shared_options}" compopt -o nospace COMPREPLY=( $(compgen -W "$options" -- ${cur}) ) return ;; +*) COMPREPLY=( $(compgen -P "+" -W "`notmuch search --output=tags \*`" -- ${cur##+}) ) ;; -*) COMPREPLY=( $(compgen -P "-" -W "`notmuch search --output=tags \*`" -- ${cur##-}) ) ;; *) _notmuch_search_terms return ;; esac # handle tags with colons __ltrim_colon_completions "${cur}" } _notmuch() { local _notmuch_commands="compact config count dump help insert new reply restore search address setup show tag" local arg cur prev words cword split # require bash-completion with _init_completion type -t _init_completion >/dev/null 2>&1 || return _init_completion || return COMPREPLY=() # subcommand _get_first_arg # complete --help option like the subcommand if [ -z "${arg}" -a "${prev}" = "--help" ]; then arg="help" fi if [ -z "${arg}" ]; then # top level completion case "${cur}" in -*) # XXX: handle ${_notmuch_shared_options} and --config= local options="--help --version" COMPREPLY=( $(compgen -W "${options}" -- ${cur}) ) ;; *) COMPREPLY=( $(compgen -W "${_notmuch_commands}" -- ${cur}) ) ;; esac elif [ "${arg}" = "help" ]; then # handle help command specially due to _notmuch_commands usage local help_topics="$_notmuch_commands hooks search-terms" COMPREPLY=( $(compgen -W "${help_topics}" -- ${cur}) ) else # complete using _notmuch_subcommand if one exist local completion_func="_notmuch_${arg//-/_}" declare -f $completion_func >/dev/null && $completion_func fi } && complete -F _notmuch notmuch notmuch-0.23.7/completion/notmuch-completion.zsh000066400000000000000000000045231305541522400220100ustar00rootroot00000000000000#compdef notmuch # ZSH completion for `notmuch` # Copyright © 2009 Ingmar Vanhassel _notmuch_commands() { local -a notmuch_commands notmuch_commands=( 'help:display documentation for a subcommand' 'setup:interactively configure notmuch' 'address:output addresses from matching messages' 'compact:compact the notmuch database' 'config:access notmuch configuration file' 'count:count messages matching the given search terms' 'dump:creates a plain-text dump of the tags of each message' 'insert:add a message to the maildir and notmuch database' 'new:incorporate new mail into the notmuch database' 'reply:constructs a reply template for a set of messages' 'restore:restores the tags from the given file (see notmuch dump)' 'search:search for messages matching the given search terms' 'show:show messages matching the given search terms' 'tag:add/remove tags for all messages matching the search terms' ) _describe -t command 'command' notmuch_commands } _notmuch_dump() { _files } _notmuch_help_topics() { local -a notmuch_help_topics notmuch_help_topics=( 'search-terms:show common search-terms syntax' ) _describe -t notmuch-help-topics 'topic' notmuch_help_topics } _notmuch_help() { _alternative \ _notmuch_commands \ _notmuch_help_topics } _notmuch_restore() { _files } _notmuch_search() { _arguments -s : \ '--max-threads=[display only the first x threads from the search results]:number of threads to show: ' \ '--first=[omit the first x threads from the search results]:number of threads to omit: ' \ '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \ '--output=[select what to output]:output:((summary threads messages files tags))' } _notmuch_address() { _arguments -s : \ '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \ '--output=[select what to output]:output:((sender recipients count))' } _notmuch() { if (( CURRENT > 2 )) ; then local cmd=${words[2]} curcontext="${curcontext%:*:*}:notmuch-$cmd" (( CURRENT-- )) shift words _call_function ret _notmuch_$cmd return ret else _notmuch_commands fi } _notmuch "$@" # vim: set sw=2 sts=2 ts=2 et ft=zsh : notmuch-0.23.7/configure000077500000000000000000001063251305541522400151770ustar00rootroot00000000000000#! /bin/sh set -u # Test whether this shell is capable of parameter substring processing. ( option='a/b'; : ${option#*/} ) 2>/dev/null || { echo " The shell interpreting '$0' is lacking some required features. To work around this problem you may try to execute: ksh $0 $* or bash $0 $* " exit 1 } # Store original IFS value so it can be changed (and restored) in many places. readonly DEFAULT_IFS="$IFS" srcdir=$(dirname "$0") subdirs="util compat lib parse-time-string completion doc emacs" subdirs="${subdirs} performance-test test test/test-databases" subdirs="${subdirs} bindings" # For a non-srcdir configure invocation (such as ../configure), create # the directory structure and copy Makefiles. if [ "$srcdir" != "." ]; then for dir in . ${subdirs}; do mkdir -p "$dir" cp "$srcdir"/"$dir"/Makefile.local "$dir" cp "$srcdir"/"$dir"/Makefile "$dir" done # Easiest way to get the test suite to work is to just copy the # whole thing into the build directory. cp -a "$srcdir"/test/* test # Emacs only likes to generate compiled files next to the .el files # by default so copy these as well (which is not ideal). cp -a "$srcdir"/emacs/*.el emacs fi # Set several defaults (optionally specified by the user in # environment variables) CC=${CC:-cc} CXX=${CXX:-c++} CFLAGS=${CFLAGS:--g -O2} CPPFLAGS=${CPPFLAGS:-} CXXFLAGS_for_sh=${CXXFLAGS:-${CFLAGS}} CXXFLAGS=${CXXFLAGS:-\$(CFLAGS)} LDFLAGS=${LDFLAGS:-} XAPIAN_CONFIG=${XAPIAN_CONFIG:-} PYTHON=${PYTHON:-} # We don't allow the EMACS or GZIP Makefile variables inherit values # from the environment as we do with CC and CXX above. The reason is # that these names as environment variables have existing uses other # than the program name that we want. (EMACS is set to 't' when a # shell is running within emacs and GZIP specifies arguments to pass # on the gzip command line). # Set the defaults for values the user can specify with command-line # options. PREFIX=/usr/local LIBDIR= WITH_DOCS=1 WITH_API_DOCS=1 WITH_EMACS=1 WITH_BASH=1 WITH_RUBY=1 WITH_ZSH=1 WITH_RETRY_LOCK=1 usage () { cat <-- Currently ignored --host=-- Currently ignored --infodir=DIR Currently ignored --datadir=DIR Currently ignored --localstatedir=DIR Currently ignored --libexecdir=DIR Currently ignored --disable-maintainer-mode Currently ignored --disable-dependency-tracking Currently ignored EOF } # Parse command-line options for option; do if [ "${option}" = '--help' ] ; then usage exit 0 elif [ "${option%%=*}" = '--prefix' ] ; then PREFIX="${option#*=}" elif [ "${option%%=*}" = '--libdir' ] ; then LIBDIR="${option#*=}" elif [ "${option%%=*}" = '--includedir' ] ; then INCLUDEDIR="${option#*=}" elif [ "${option%%=*}" = '--mandir' ] ; then MANDIR="${option#*=}" elif [ "${option%%=*}" = '--sysconfdir' ] ; then SYSCONFDIR="${option#*=}" elif [ "${option%%=*}" = '--emacslispdir' ] ; then EMACSLISPDIR="${option#*=}" elif [ "${option%%=*}" = '--emacsetcdir' ] ; then EMACSETCDIR="${option#*=}" elif [ "${option%%=*}" = '--bashcompletiondir' ] ; then BASHCOMPLETIONDIR="${option#*=}" elif [ "${option%%=*}" = '--zshcompletiondir' ] ; then ZSHCOMLETIONDIR="${option#*=}" elif [ "${option%%=*}" = '--with-docs' ]; then if [ "${option#*=}" = 'no' ]; then WITH_DOCS=0 WITH_API_DOCS=0 else WITH_DOCS=1 fi elif [ "${option}" = '--without-docs' ] ; then WITH_DOCS=0 WITH_API_DOCS=0 elif [ "${option%%=*}" = '--with-api-docs' ]; then if [ "${option#*=}" = 'no' ]; then WITH_API_DOCS=0 else WITH_API_DOCS=1 fi elif [ "${option}" = '--without-api-docs' ] ; then WITH_API_DOCS=0 elif [ "${option%%=*}" = '--with-emacs' ]; then if [ "${option#*=}" = 'no' ]; then WITH_EMACS=0 else WITH_EMACS=1 fi elif [ "${option}" = '--without-emacs' ] ; then WITH_EMACS=0 elif [ "${option%%=*}" = '--with-bash-completion' ]; then if [ "${option#*=}" = 'no' ]; then WITH_BASH=0 else WITH_BASH=1 fi elif [ "${option}" = '--without-bash-completion' ] ; then WITH_BASH=0 elif [ "${option%%=*}" = '--with-ruby' ]; then if [ "${option#*=}" = 'no' ]; then WITH_RUBY=0 else WITH_RUBY=1 fi elif [ "${option}" = '--without-ruby' ] ; then WITH_RUBY=0 elif [ "${option%%=*}" = '--with-retry-lock' ]; then if [ "${option#*=}" = 'no' ]; then WITH_RETRY_LOCK=0 else WITH_RETRY_LOCK=1 fi elif [ "${option}" = '--without-retry-lock' ] ; then WITH_RETRY_LOCK=0 elif [ "${option%%=*}" = '--with-zsh-completion' ]; then if [ "${option#*=}" = 'no' ]; then WITH_ZSH=0 else WITH_ZSH=1 fi elif [ "${option}" = '--without-zsh-completion' ] ; then WITH_ZSH=0 elif [ "${option%%=*}" = '--build' ] ; then true elif [ "${option%%=*}" = '--host' ] ; then true elif [ "${option%%=*}" = '--infodir' ] ; then true elif [ "${option%%=*}" = '--datadir' ] ; then true elif [ "${option%%=*}" = '--localstatedir' ] ; then true elif [ "${option%%=*}" = '--libexecdir' ] ; then true elif [ "${option}" = '--disable-maintainer-mode' ] ; then true elif [ "${option}" = '--disable-dependency-tracking' ] ; then true else echo "Unrecognized option: ${option}" echo "See:" echo " $0 --help" echo "" exit 1 fi done # We set this value early, (rather than just while printing the # Makefile.config file later like most values), because we need to # actually investigate this value compared to the ldconfig_paths value # below. if [ -z "$LIBDIR" ] ; then libdir_expanded="${PREFIX}/lib" else # very non-general variable expansion libdir_expanded=$(printf %s "$LIBDIR" | sed "s|\${prefix}|${PREFIX}|; s|\$prefix\>|${PREFIX}|; s|//*|/|g") fi cat < minimal.c printf "Sanity checking C compilation environment... " if ${CC} ${CFLAGS} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal > /dev/null 2>&1 then printf "OK.\n" else printf "Fail.\n" errors=$((errors + 1)) fi printf "Sanity checking C++ compilation environment... " if ${CXX} ${CXXFLAGS_for_sh} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal > /dev/null 2>&1 then printf "OK.\n" else printf "Fail.\n" errors=$((errors + 1)) fi if [ $errors -gt 0 ]; then cat < _libversion.c < #include "lib/notmuch.h" int main(void) { printf("libnotmuch_version_major=%d\n", LIBNOTMUCH_MAJOR_VERSION); printf("libnotmuch_version_minor=%d\n", LIBNOTMUCH_MINOR_VERSION); printf("libnotmuch_version_release=%d\n", LIBNOTMUCH_MICRO_VERSION); return 0; } EOF if ${CC} ${CFLAGS} _libversion.c -o _libversion > /dev/null 2>&1 && \ ./_libversion > _libversion.sh && . ./_libversion.sh then printf "OK.\n" else cat < /dev/null 2>&1; then have_pkg_config=1 else have_pkg_config=0 fi printf "Checking for Xapian development files... " have_xapian=0 for xapian_config in ${XAPIAN_CONFIG} xapian-config xapian-config-1.3; do if ${xapian_config} --version > /dev/null 2>&1; then xapian_version=$(${xapian_config} --version | sed -e 's/.* //') printf "Yes (%s).\n" ${xapian_version} have_xapian=1 xapian_cxxflags=$(${xapian_config} --cxxflags) xapian_ldflags=$(${xapian_config} --libs) break fi done if [ ${have_xapian} = "0" ]; then printf "No.\n" errors=$((errors + 1)) fi have_xapian_compact=0 have_xapian_field_processor=0 if [ ${have_xapian} = "1" ]; then printf "Checking for Xapian compaction support... " cat>_compact.cc< class TestCompactor : public Xapian::Compactor { }; EOF if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _compact.cc -o _compact.o > /dev/null 2>&1 then have_xapian_compact=1 printf "Yes.\n" else printf "No.\n" errors=$((errors + 1)) fi rm -f _compact.o _compact.cc printf "Checking for Xapian FieldProcessor API... " cat>_field_processor.cc< class TitleFieldProcessor : public Xapian::FieldProcessor { }; EOF if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _field_processor.cc -o _field_processor.o > /dev/null 2>&1 then have_xapian_field_processor=1 printf "Yes.\n" else printf "No. (optional)\n" fi rm -f _field_processor.o _field_processor.cc default_xapian_backend="" # DB_RETRY_LOCK is only supported on Xapian > 1.3.2 have_xapian_db_retry_lock=0 if [ $WITH_RETRY_LOCK = "1" ]; then printf "Checking for Xapian lock retry support... " cat>_retry.cc< int flag = Xapian::DB_RETRY_LOCK; EOF if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _retry.cc -o _retry.o > /dev/null 2>&1 then have_xapian_db_retry_lock=1 printf "Yes.\n" else printf "No. (optional)\n" fi rm -f _retry.o _retry.cc fi printf "Testing default Xapian backend... " cat >_default_backend.cc < int main(int argc, char** argv) { Xapian::WritableDatabase db("test.db",Xapian::DB_CREATE_OR_OPEN); } EOF ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} _default_backend.cc -o _default_backend ${xapian_ldflags} ./_default_backend if [ -f test.db/iamglass ]; then default_xapian_backend=glass else default_xapian_backend=chert fi printf "%s\n" "${default_xapian_backend}"; rm -rf test.db _default_backend _default_backend.cc fi # we need to have a version >= 2.6.5 to avoid a crypto bug. We need # 2.6.7 for permissive "From " header handling. GMIME_MINVER=2.6.7 printf "Checking for GMime development files... " if pkg-config --exists "gmime-2.6 >= $GMIME_MINVER"; then printf "Yes.\n" have_gmime=1 gmime_cflags=$(pkg-config --cflags gmime-2.6) gmime_ldflags=$(pkg-config --libs gmime-2.6) else have_gmime=0 printf "No.\n" errors=$((errors + 1)) fi # GMime already depends on Glib >= 2.12, but we use at least one Glib # function that only exists as of 2.22, (g_array_unref) printf "Checking for Glib development files (>= 2.22)... " have_glib=0 if pkg-config --exists 'glib-2.0 >= 2.22'; then printf "Yes.\n" have_glib=1 # these are included in gmime cflags and ldflags # glib_cflags=$(pkg-config --cflags glib-2.0) # glib_ldflags=$(pkg-config --libs glib-2.0) else printf "No.\n" errors=$((errors + 1)) fi if ! pkg-config --exists zlib; then ${CC} ${zlib_cflags} -o compat/gen_zlib_pc \ "$srcdir"/compat/gen_zlib_pc.c ${zlib_ldflags} > /dev/null 2>&1 && compat/gen_zlib_pc > compat/zlib.pc && PKG_CONFIG_PATH="$PKG_CONFIG_PATH":compat && export PKG_CONFIG_PATH rm -f compat/gen_zlib_pc fi printf "Checking for zlib (>= 1.2.5.2)... " have_zlib=0 if pkg-config --atleast-version=1.2.5.2 zlib; then printf "Yes.\n" have_zlib=1 zlib_cflags=$(pkg-config --cflags zlib) zlib_ldflags=$(pkg-config --libs zlib) else printf "No.\n" errors=$((errors + 1)) fi printf "Checking for talloc development files... " if pkg-config --exists talloc; then printf "Yes.\n" have_talloc=1 talloc_cflags=$(pkg-config --cflags talloc) talloc_ldflags=$(pkg-config --libs talloc) else printf "No.\n" have_talloc=0 talloc_cflags= errors=$((errors + 1)) fi printf "Checking for python... " have_python=0 for name in ${PYTHON} python python2 python3; do if command -v $name > /dev/null; then have_python=1 python=$name printf "Yes (%s).\n" "$name" break fi done if [ $have_python -eq 0 ]; then printf "No.\n" errors=$((errors + 1)) fi printf "Checking for valgrind development files... " if pkg-config --exists valgrind; then printf "Yes.\n" have_valgrind=1 valgrind_cflags=$(pkg-config --cflags valgrind) else printf "No (but that's fine).\n" have_valgrind=0 valgrind_cflags= fi printf "Checking for bash-completion (>= 1.90)... " if pkg-config --atleast-version=1.90 bash-completion; then printf "Yes.\n" else printf "No (will not install bash completion).\n" WITH_BASH=0 fi if [ -z "${EMACSLISPDIR-}" ]; then EMACSLISPDIR="\$(prefix)/share/emacs/site-lisp" fi if [ -z "${EMACSETCDIR-}" ]; then EMACSETCDIR="\$(prefix)/share/emacs/site-lisp" fi printf "Checking if emacs is available... " if emacs --quick --batch > /dev/null 2>&1; then printf "Yes.\n" have_emacs=1 else printf "No (so will not byte-compile emacs code)\n" have_emacs=0 fi have_doxygen=0 if [ $WITH_API_DOCS = "1" ] ; then printf "Checking if doxygen is available... " if command -v doxygen > /dev/null; then printf "Yes.\n" have_doxygen=1 else printf "No (so will not install api docs)\n" fi fi have_ruby_dev=0 if [ $WITH_RUBY = "1" ] ; then printf "Checking for ruby development files... " if ruby -e "require 'mkmf'"> /dev/null 2>&1; then printf "Yes.\n" have_ruby_dev=1 else printf "No (skipping ruby bindings)\n" fi fi have_sphinx=0 if [ $WITH_DOCS = "1" ] ; then printf "Checking if sphinx is available and supports nroff output... " if command -v sphinx-build > /dev/null && ${python} -m sphinx.writers.manpage > /dev/null 2>&1 ; then printf "Yes.\n" have_sphinx=1 else printf "No (so will not install man pages).\n" fi fi libdir_in_ldconfig=0 printf "Checking which platform we are on... " uname=$(uname) if [ $uname = "Darwin" ] ; then printf "Mac OS X.\n" platform=MACOSX linker_resolves_library_dependencies=0 elif [ $uname = "SunOS" ] ; then printf "Solaris.\n" platform=SOLARIS linker_resolves_library_dependencies=0 elif [ $uname = "FreeBSD" ] ; then printf "FreeBSD.\n" platform=FREEBSD linker_resolves_library_dependencies=0 elif [ $uname = "OpenBSD" ] ; then printf "OpenBSD.\n" platform=OPENBSD linker_resolves_library_dependencies=0 elif [ $uname = "Linux" ] || [ $uname = "GNU" ] ; then printf "%s\n" "$uname" platform="$uname" linker_resolves_library_dependencies=1 printf "Checking for %s in ldconfig... " "$libdir_expanded" ldconfig_paths=$(/sbin/ldconfig -N -X -v 2>/dev/null | sed -n -e 's,^\(/.*\):\( (.*)\)\?$,\1,p') # Separate ldconfig_paths only on newline (not on any potential # embedded space characters in any filenames). Note, we use a # literal newline in the source here rather than something like: # # IFS=$(printf '\n') # # because the shell's command substitution deletes any trailing newlines. IFS=" " for path in $ldconfig_paths; do if [ "$path" = "$libdir_expanded" ]; then libdir_in_ldconfig=1 fi done IFS=$DEFAULT_IFS if [ "$libdir_in_ldconfig" = '0' ]; then printf "No (will set RPATH)\n" else printf "Yes\n" fi else printf "Unknown.\n" platform="$uname" linker_resolves_library_dependencies=0 cat < _byteorder.c < #include uint32_t test = 0x34333231; int main() { printf("%.4s\n", (const char*)&test); return 0; } EOF ${CC} ${CFLAGS} _byteorder.c -o _byteorder > /dev/null 2>&1 util_byte_order=$(./_byteorder) echo $util_byte_order rm -f _byteorder _byteorder.c if [ $errors -gt 0 ]; then cat <= version 1.2.6, including development files such as headers)" echo " https://xapian.org/" fi if [ $have_zlib -eq 0 ]; then echo " zlib library (>= version 1.2.5.2, including development files such as headers)" echo " http://zlib.net/" echo fi if [ $have_gmime -eq 0 ]; then echo " GMime 2.6 library >= $GMIME_MINVER" echo " (including development files such as headers)" echo " http://spruce.sourceforge.net/gmime/" echo fi if [ $have_glib -eq 0 ]; then echo " Glib library >= 2.22 (including development files such as headers)" echo " http://ftp.gnome.org/pub/gnome/sources/glib/" echo fi if [ $have_talloc -eq 0 ]; then echo " The talloc library (including development files such as headers)" echo " https://talloc.samba.org/" echo fi cat < /dev/null 2>&1 then printf "Yes.\n" have_canonicalize_file_name=1 else printf "No (will use our own instead).\n" have_canonicalize_file_name=0 fi rm -f compat/have_canonicalize_file_name printf "Checking for getline... " if ${CC} -o compat/have_getline "$srcdir"/compat/have_getline.c > /dev/null 2>&1 then printf "Yes.\n" have_getline=1 else printf "No (will use our own instead).\n" have_getline=0 fi rm -f compat/have_getline printf "Checking for strcasestr... " if ${CC} -o compat/have_strcasestr "$srcdir"/compat/have_strcasestr.c > /dev/null 2>&1 then printf "Yes.\n" have_strcasestr=1 else printf "No (will use our own instead).\n" have_strcasestr=0 fi rm -f compat/have_strcasestr printf "Checking for strsep... " if ${CC} -o compat/have_strsep "$srcdir"/compat/have_strsep.c > /dev/null 2>&1 then printf "Yes.\n" have_strsep="1" else printf "No (will use our own instead).\n" have_strsep="0" fi rm -f compat/have_strsep printf "Checking for timegm... " if ${CC} -o compat/have_timegm "$srcdir"/compat/have_timegm.c > /dev/null 2>&1 then printf "Yes.\n" have_timegm="1" else printf "No (will use our own instead).\n" have_timegm="0" fi rm -f compat/have_timegm printf "Checking for dirent.d_type... " if ${CC} -o compat/have_d_type "$srcdir"/compat/have_d_type.c > /dev/null 2>&1 then printf "Yes.\n" have_d_type="1" else printf "No (will use stat instead).\n" have_d_type="0" fi rm -f compat/have_d_type printf "Checking for standard version of getpwuid_r... " if ${CC} -o compat/check_getpwuid "$srcdir"/compat/check_getpwuid.c > /dev/null 2>&1 then printf "Yes.\n" std_getpwuid=1 else printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n" std_getpwuid=0 fi rm -f compat/check_getpwuid printf "Checking for standard version of asctime_r... " if ${CC} -o compat/check_asctime "$srcdir"/compat/check_asctime.c > /dev/null 2>&1 then printf "Yes.\n" std_asctime=1 else printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n" std_asctime=0 fi rm -f compat/check_asctime printf "Checking for rpath support... " if ${CC} -Wl,--enable-new-dtags -Wl,-rpath,/tmp/ -o minimal minimal.c >/dev/null 2>&1 then printf "Yes.\n" rpath_ldflags="-Wl,--enable-new-dtags -Wl,-rpath,\$(libdir)" else printf "No (nothing to worry about).\n" rpath_ldflags="" fi printf "Checking for -Wl,--as-needed... " if ${CC} -Wl,--as-needed -o minimal minimal.c >/dev/null 2>&1 then printf "Yes.\n" as_needed_ldflags="-Wl,--as-needed" else printf "No (nothing to worry about).\n" as_needed_ldflags="" fi printf "Checking for -Wl,--no-undefined... " if ${CC} -Wl,--no-undefined -o minimal minimal.c >/dev/null 2>&1 then printf "Yes.\n" no_undefined_ldflags="-Wl,--no-undefined" else printf "No (nothing to worry about).\n" no_undefined_ldflags="" fi WARN_CXXFLAGS="" printf "Checking for available C++ compiler warning flags... " for flag in -Wall -Wextra -Wwrite-strings; do if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1 then WARN_CXXFLAGS="${WARN_CXXFLAGS}${WARN_CXXFLAGS:+ }${flag}" fi done printf "\n\t%s\n" "${WARN_CXXFLAGS}" WARN_CFLAGS="${WARN_CXXFLAGS}" printf "Checking for available C compiler warning flags... " for flag in -Wmissing-declarations; do if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1 then WARN_CFLAGS="${WARN_CFLAGS}${WARN_CFLAGS:+ }${flag}" fi done printf "\n\t%s\n" "${WARN_CFLAGS}" rm -f minimal minimal.c _libversion.c _libversion _libversion.sh # construct the Makefile.config cat > Makefile.config < sh.config < Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! notmuch-0.23.7/contrib/go/Makefile000066400000000000000000000015271305541522400167730ustar00rootroot00000000000000# Makefile for the go bindings of notmuch export GOPATH ?= $(shell pwd) export CGO_CFLAGS ?= -I../../../../lib export CGO_LDFLAGS ?= -L../../../../lib GO ?= go GOFMT ?= gofmt all: notmuch notmuch-addrlookup .PHONY: notmuch notmuch: $(GO) install notmuch .PHONY: goconfig goconfig: if [ ! -d github.com/msbranco/goconfig ]; then \ $(GO) get github.com/msbranco/goconfig; \ fi .PHONY: notmuch-addrlookup notmuch-addrlookup: notmuch goconfig $(GO) install notmuch-addrlookup .PHONY: format format: $(GOFMT) -w=true $(GOFMT_OPTS) src/notmuch $(GOFMT) -w=true $(GOFMT_OPTS) src/notmuch-addrlookup .PHONY: check-format check-format: $(GOFMT) -d=true $(GOFMT_OPTS) src/notmuch $(GOFMT) -d=true $(GOFMT_OPTS) src/notmuch-addrlookup .PHONY: clean clean: $(GO) clean notmuch $(GO) clean notmuch-addrlookup rm -rf pkg bin notmuch-0.23.7/contrib/go/README000066400000000000000000000004761305541522400162150ustar00rootroot00000000000000go-notmuch ========== simple go bindings to the libnotmuch library[1]. they are heavily inspired from the vala bindings from Sebastian Spaeth: https://github.com/spaetz/vala-notmuch note: the whole library hasn't been wrapped (yet?) todo ---- - improve notmuch-addrlookup regexp [1] https://notmuchmail.org/ notmuch-0.23.7/contrib/go/src/000077500000000000000000000000001305541522400161155ustar00rootroot00000000000000notmuch-0.23.7/contrib/go/src/notmuch-addrlookup/000077500000000000000000000000001305541522400217345ustar00rootroot00000000000000notmuch-0.23.7/contrib/go/src/notmuch-addrlookup/addrlookup.go000066400000000000000000000137371305541522400244420ustar00rootroot00000000000000package main // stdlib imports import "os" import "path" import "log" import "fmt" import "regexp" import "strings" import "sort" // 3rd-party imports import "notmuch" import "github.com/msbranco/goconfig" type mail_addr_freq struct { addr string count [3]uint } type frequencies map[string]uint /* Used to sort the email addresses from most to least used */ func sort_by_freq(m1, m2 *mail_addr_freq) int { if m1.count[0] == m2.count[0] && m1.count[1] == m2.count[1] && m1.count[2] == m2.count[2] { return 0 } if m1.count[0] > m2.count[0] || m1.count[0] == m2.count[0] && m1.count[1] > m2.count[1] || m1.count[0] == m2.count[0] && m1.count[1] == m2.count[1] && m1.count[2] > m2.count[2] { return -1 } return 1 } type maddresses []*mail_addr_freq func (self *maddresses) Len() int { return len(*self) } func (self *maddresses) Less(i, j int) bool { m1 := (*self)[i] m2 := (*self)[j] v := sort_by_freq(m1, m2) if v <= 0 { return true } return false } func (self *maddresses) Swap(i, j int) { (*self)[i], (*self)[j] = (*self)[j], (*self)[i] } // find most frequent real name for each mail address func frequent_fullname(freqs frequencies) string { var maxfreq uint = 0 fullname := "" freqs_sz := len(freqs) for mail, freq := range freqs { if (freq > maxfreq && mail != "") || freqs_sz == 1 { // only use the entry if it has a real name // or if this is the only entry maxfreq = freq fullname = mail } } return fullname } func addresses_by_frequency(msgs *notmuch.Messages, name string, pass uint, addr_to_realname *map[string]*frequencies) *frequencies { freqs := make(frequencies) pattern := `\s*(("(\.|[^"])*"|[^,])*?)` // pattern := "\\s*((\\\"(\\\\.|[^\\\\\"])*\\\"|[^,])*" + // "\\b\\w+([-+.]\\w+)*\\@\\w+[-\\.\\w]*\\.([-\\.\\w]+)*\\w\\b)>?)" pattern = `.*` + strings.ToLower(name) + `.*` var re *regexp.Regexp = nil var err error = nil if re, err = regexp.Compile(pattern); err != nil { log.Printf("error: %v\n", err) return &freqs } headers := []string{"from"} if pass == 1 { headers = append(headers, "to", "cc", "bcc") } for ; msgs.Valid(); msgs.MoveToNext() { msg := msgs.Get() //println("==> msg [", msg.GetMessageId(), "]") for _, header := range headers { froms := strings.ToLower(msg.GetHeader(header)) //println(" froms: ["+froms+"]") for _, from := range strings.Split(froms, ",") { from = strings.Trim(from, " ") match := re.FindString(from) //println(" -> match: ["+match+"]") occ, ok := freqs[match] if !ok { freqs[match] = 0 occ = 0 } freqs[match] = occ + 1 } } } return &freqs } func search_address_passes(queries [3]*notmuch.Query, name string) []string { var val []string addr_freq := make(map[string]*mail_addr_freq) addr_to_realname := make(map[string]*frequencies) var pass uint = 0 // 0-based for _, query := range queries { if query == nil { //println("**warning: idx [",idx,"] contains a nil query") continue } msgs := query.SearchMessages() ht := addresses_by_frequency(msgs, name, pass, &addr_to_realname) for addr, count := range *ht { freq, ok := addr_freq[addr] if !ok { freq = &mail_addr_freq{addr: addr, count: [3]uint{0, 0, 0}} } freq.count[pass] = count addr_freq[addr] = freq } msgs.Destroy() pass += 1 } addrs := make(maddresses, len(addr_freq)) { iaddr := 0 for _, freq := range addr_freq { addrs[iaddr] = freq iaddr += 1 } } sort.Sort(&addrs) for _, addr := range addrs { freqs, ok := addr_to_realname[addr.addr] if ok { val = append(val, frequent_fullname(*freqs)) } else { val = append(val, addr.addr) } } //println("val:",val) return val } type address_matcher struct { // the notmuch database db *notmuch.Database // full path of the notmuch database user_db_path string // user primary email user_primary_email string // user tag to mark from addresses as in the address book user_addrbook_tag string } func new_address_matcher() *address_matcher { // honor NOTMUCH_CONFIG home := os.Getenv("NOTMUCH_CONFIG") if home == "" { home = os.Getenv("HOME") } cfg, err := goconfig.ReadConfigFile(path.Join(home, ".notmuch-config")) if err != nil { log.Fatalf("error loading config file:", err) } db_path, _ := cfg.GetString("database", "path") primary_email, _ := cfg.GetString("user", "primary_email") addrbook_tag, err := cfg.GetString("user", "addrbook_tag") if err != nil { addrbook_tag = "addressbook" } self := &address_matcher{db: nil, user_db_path: db_path, user_primary_email: primary_email, user_addrbook_tag: addrbook_tag} return self } func (self *address_matcher) run(name string) { queries := [3]*notmuch.Query{} // open the database if db, status := notmuch.OpenDatabase(self.user_db_path, notmuch.DATABASE_MODE_READ_ONLY); status == notmuch.STATUS_SUCCESS { self.db = db } else { log.Fatalf("Failed to open the database: %v\n", status) } // pass 1: look at all from: addresses with the address book tag query := "tag:" + self.user_addrbook_tag if name != "" { query = query + " and from:" + name + "*" } queries[0] = self.db.CreateQuery(query) // pass 2: look at all to: addresses sent from our primary mail query = "" if name != "" { query = "to:" + name + "*" } if self.user_primary_email != "" { query = query + " from:" + self.user_primary_email } queries[1] = self.db.CreateQuery(query) // if that leads only to a few hits, we check every from too if queries[0].CountMessages()+queries[1].CountMessages() < 10 { query = "" if name != "" { query = "from:" + name + "*" } queries[2] = self.db.CreateQuery(query) } // actually retrieve and sort addresses results := search_address_passes(queries, name) for _, v := range results { if v != "" && v != "\n" { fmt.Println(v) } } return } func main() { //fmt.Println("args:",os.Args) app := new_address_matcher() name := "" if len(os.Args) > 1 { name = os.Args[1] } app.run(name) } notmuch-0.23.7/contrib/go/src/notmuch/000077500000000000000000000000001305541522400175725ustar00rootroot00000000000000notmuch-0.23.7/contrib/go/src/notmuch/notmuch.go000066400000000000000000001160301305541522400215770ustar00rootroot00000000000000// Wrapper around the notmuch library package notmuch /* #cgo LDFLAGS: -lnotmuch #include #include #include #include "notmuch.h" */ import "C" import "unsafe" // Status codes used for the return values of most functions type Status C.notmuch_status_t const ( STATUS_SUCCESS Status = iota STATUS_OUT_OF_MEMORY STATUS_READ_ONLY_DATABASE STATUS_XAPIAN_EXCEPTION STATUS_FILE_ERROR STATUS_FILE_NOT_EMAIL STATUS_DUPLICATE_MESSAGE_ID STATUS_NULL_POINTER STATUS_TAG_TOO_LONG STATUS_UNBALANCED_FREEZE_THAW STATUS_UNBALANCED_ATOMIC STATUS_LAST_STATUS ) func (self Status) String() string { var p *C.char // p is read-only p = C.notmuch_status_to_string(C.notmuch_status_t(self)) if p != nil { s := C.GoString(p) return s } return "" } /* Various opaque data types. For each notmuch__t see the various * notmuch_ functions below. */ type Database struct { db *C.notmuch_database_t } type Query struct { query *C.notmuch_query_t } type Threads struct { threads *C.notmuch_threads_t } type Thread struct { thread *C.notmuch_thread_t } type Messages struct { messages *C.notmuch_messages_t } type Message struct { message *C.notmuch_message_t } type Tags struct { tags *C.notmuch_tags_t } type Directory struct { dir *C.notmuch_directory_t } type Filenames struct { fnames *C.notmuch_filenames_t } type DatabaseMode C.notmuch_database_mode_t const ( DATABASE_MODE_READ_ONLY DatabaseMode = iota DATABASE_MODE_READ_WRITE ) // Create a new, empty notmuch database located at 'path' func NewDatabase(path string) (*Database, Status) { var c_path *C.char = C.CString(path) defer C.free(unsafe.Pointer(c_path)) if c_path == nil { return nil, STATUS_OUT_OF_MEMORY } self := &Database{db: nil} st := Status(C.notmuch_database_create(c_path, &self.db)) if st != STATUS_SUCCESS { return nil, st } return self, st } /* Open an existing notmuch database located at 'path'. * * The database should have been created at some time in the past, * (not necessarily by this process), by calling * notmuch_database_create with 'path'. By default the database should be * opened for reading only. In order to write to the database you need to * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode. * * An existing notmuch database can be identified by the presence of a * directory named ".notmuch" below 'path'. * * The caller should call notmuch_database_destroy when finished with * this database. * * In case of any failure, this function returns NULL, (after printing * an error message on stderr). */ func OpenDatabase(path string, mode DatabaseMode) (*Database, Status) { var c_path *C.char = C.CString(path) defer C.free(unsafe.Pointer(c_path)) if c_path == nil { return nil, STATUS_OUT_OF_MEMORY } self := &Database{db: nil} st := Status(C.notmuch_database_open(c_path, C.notmuch_database_mode_t(mode), &self.db)) if st != STATUS_SUCCESS { return nil, st } return self, st } /* Close the given notmuch database, freeing all associated * resources. See notmuch_database_open. */ func (self *Database) Close() Status { return Status(C.notmuch_database_destroy(self.db)) } /* Return the database path of the given database. */ func (self *Database) GetPath() string { /* The return value is a string owned by notmuch so should not be * modified nor freed by the caller. */ var p *C.char = C.notmuch_database_get_path(self.db) if p != nil { s := C.GoString(p) return s } return "" } /* Return the database format version of the given database. */ func (self *Database) GetVersion() uint { return uint(C.notmuch_database_get_version(self.db)) } /* Does this database need to be upgraded before writing to it? * * If this function returns TRUE then no functions that modify the * database (notmuch_database_add_message, notmuch_message_add_tag, * notmuch_directory_set_mtime, etc.) will work unless the function * notmuch_database_upgrade is called successfully first. */ func (self *Database) NeedsUpgrade() bool { do_upgrade := C.notmuch_database_needs_upgrade(self.db) if do_upgrade == 0 { return false } return true } // TODO: notmuch_database_upgrade /* Retrieve a directory object from the database for 'path'. * * Here, 'path' should be a path relative to the path of 'database' * (see notmuch_database_get_path), or else should be an absolute path * with initial components that match the path of 'database'. * * Can return NULL if a Xapian exception occurs. */ func (self *Database) GetDirectory(path string) (*Directory, Status) { var c_path *C.char = C.CString(path) defer C.free(unsafe.Pointer(c_path)) if c_path == nil { return nil, STATUS_OUT_OF_MEMORY } var c_dir *C.notmuch_directory_t st := Status(C.notmuch_database_get_directory(self.db, c_path, &c_dir)) if st != STATUS_SUCCESS || c_dir == nil { return nil, st } return &Directory{dir: c_dir}, st } /* Add a new message to the given notmuch database. * * Here,'filename' should be a path relative to the path of * 'database' (see notmuch_database_get_path), or else should be an * absolute filename with initial components that match the path of * 'database'. * * The file should be a single mail message (not a multi-message mbox) * that is expected to remain at its current location, (since the * notmuch database will reference the filename, and will not copy the * entire contents of the file. * * If 'message' is not NULL, then, on successful return '*message' * will be initialized to a message object that can be used for things * such as adding tags to the just-added message. The user should call * notmuch_message_destroy when done with the message. On any failure * '*message' will be set to NULL. * * Return value: * * NOTMUCH_STATUS_SUCCESS: Message successfully added to database. * * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred, * message not added. * * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message * ID as another message already in the database. The new * filename was successfully added to the message in the database * (if not already present). * * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the * file, (such as permission denied, or file not found, * etc.). Nothing added to the database. * * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look * like an email message. Nothing added to the database. * * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only * mode so no message can be added. */ func (self *Database) AddMessage(fname string) (*Message, Status) { var c_fname *C.char = C.CString(fname) defer C.free(unsafe.Pointer(c_fname)) if c_fname == nil { return nil, STATUS_OUT_OF_MEMORY } var c_msg *C.notmuch_message_t = new(C.notmuch_message_t) st := Status(C.notmuch_database_add_message(self.db, c_fname, &c_msg)) return &Message{message: c_msg}, st } /* Remove a message from the given notmuch database. * * Note that only this particular filename association is removed from * the database. If the same message (as determined by the message ID) * is still available via other filenames, then the message will * persist in the database for those filenames. When the last filename * is removed for a particular message, the database content for that * message will be entirely removed. * * Return value: * * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the * message was removed from the database. * * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred, * message not removed. * * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but * the message persists in the database with at least one other * filename. * * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only * mode so no message can be removed. */ func (self *Database) RemoveMessage(fname string) Status { var c_fname *C.char = C.CString(fname) defer C.free(unsafe.Pointer(c_fname)) if c_fname == nil { return STATUS_OUT_OF_MEMORY } st := C.notmuch_database_remove_message(self.db, c_fname) return Status(st) } /* Find a message with the given message_id. * * If the database contains a message with the given message_id, then * a new notmuch_message_t object is returned. The caller should call * notmuch_message_destroy when done with the message. * * This function returns NULL in the following situations: * * * No message is found with the given message_id * * An out-of-memory situation occurs * * A Xapian exception occurs */ func (self *Database) FindMessage(message_id string) (*Message, Status) { var c_msg_id *C.char = C.CString(message_id) defer C.free(unsafe.Pointer(c_msg_id)) if c_msg_id == nil { return nil, STATUS_OUT_OF_MEMORY } msg := &Message{message: nil} st := Status(C.notmuch_database_find_message(self.db, c_msg_id, &msg.message)) if st != STATUS_SUCCESS { return nil, st } return msg, st } /* Return a list of all tags found in the database. * * This function creates a list of all tags found in the database. The * resulting list contains all tags from all messages found in the database. * * On error this function returns NULL. */ func (self *Database) GetAllTags() *Tags { tags := C.notmuch_database_get_all_tags(self.db) if tags == nil { return nil } return &Tags{tags: tags} } /* Create a new query for 'database'. * * Here, 'database' should be an open database, (see * notmuch_database_open and notmuch_database_create). * * For the query string, we'll document the syntax here more * completely in the future, but it's likely to be a specialized * version of the general Xapian query syntax: * * https://xapian.org/docs/queryparser.html * * As a special case, passing either a length-zero string, (that is ""), * or a string consisting of a single asterisk (that is "*"), will * result in a query that returns all messages in the database. * * See notmuch_query_set_sort for controlling the order of results. * See notmuch_query_search_messages and notmuch_query_search_threads * to actually execute the query. * * User should call notmuch_query_destroy when finished with this * query. * * Will return NULL if insufficient memory is available. */ func (self *Database) CreateQuery(query string) *Query { var c_query *C.char = C.CString(query) defer C.free(unsafe.Pointer(c_query)) if c_query == nil { return nil } q := C.notmuch_query_create(self.db, c_query) if q == nil { return nil } return &Query{query: q} } /* Sort values for notmuch_query_set_sort */ type Sort C.notmuch_sort_t const ( SORT_OLDEST_FIRST Sort = 0 SORT_NEWEST_FIRST SORT_MESSAGE_ID SORT_UNSORTED ) /* Return the query_string of this query. See notmuch_query_create. */ func (self *Query) String() string { // FIXME: do we own 'q' or not ? q := C.notmuch_query_get_query_string(self.query) //defer C.free(unsafe.Pointer(q)) if q != nil { s := C.GoString(q) return s } return "" } /* Specify the sorting desired for this query. */ func (self *Query) SetSort(sort Sort) { C.notmuch_query_set_sort(self.query, C.notmuch_sort_t(sort)) } /* Return the sort specified for this query. See notmuch_query_set_sort. */ func (self *Query) GetSort() Sort { return Sort(C.notmuch_query_get_sort(self.query)) } /* Execute a query for threads, returning a notmuch_threads_t object * which can be used to iterate over the results. The returned threads * object is owned by the query and as such, will only be valid until * notmuch_query_destroy. * * Typical usage might be: * * notmuch_query_t *query; * notmuch_threads_t *threads; * notmuch_thread_t *thread; * * query = notmuch_query_create (database, query_string); * * for (threads = notmuch_query_search_threads (query); * notmuch_threads_valid (threads); * notmuch_threads_move_to_next (threads)) * { * thread = notmuch_threads_get (threads); * .... * notmuch_thread_destroy (thread); * } * * notmuch_query_destroy (query); * * Note: If you are finished with a thread before its containing * query, you can call notmuch_thread_destroy to clean up some memory * sooner (as in the above example). Otherwise, if your thread objects * are long-lived, then you don't need to call notmuch_thread_destroy * and all the memory will still be reclaimed when the query is * destroyed. * * Note that there's no explicit destructor needed for the * notmuch_threads_t object. (For consistency, we do provide a * notmuch_threads_destroy function, but there's no good reason * to call it if the query is about to be destroyed). * * If a Xapian exception occurs this function will return NULL. */ func (self *Query) SearchThreads() *Threads { threads := C.notmuch_query_search_threads(self.query) if threads == nil { return nil } return &Threads{threads: threads} } /* Execute a query for messages, returning a notmuch_messages_t object * which can be used to iterate over the results. The returned * messages object is owned by the query and as such, will only be * valid until notmuch_query_destroy. * * Typical usage might be: * * notmuch_query_t *query; * notmuch_messages_t *messages; * notmuch_message_t *message; * * query = notmuch_query_create (database, query_string); * * for (messages = notmuch_query_search_messages (query); * notmuch_messages_valid (messages); * notmuch_messages_move_to_next (messages)) * { * message = notmuch_messages_get (messages); * .... * notmuch_message_destroy (message); * } * * notmuch_query_destroy (query); * * Note: If you are finished with a message before its containing * query, you can call notmuch_message_destroy to clean up some memory * sooner (as in the above example). Otherwise, if your message * objects are long-lived, then you don't need to call * notmuch_message_destroy and all the memory will still be reclaimed * when the query is destroyed. * * Note that there's no explicit destructor needed for the * notmuch_messages_t object. (For consistency, we do provide a * notmuch_messages_destroy function, but there's no good * reason to call it if the query is about to be destroyed). * * If a Xapian exception occurs this function will return NULL. */ func (self *Query) SearchMessages() *Messages { msgs := C.notmuch_query_search_messages(self.query) if msgs == nil { return nil } return &Messages{messages: msgs} } /* Destroy a notmuch_query_t along with any associated resources. * * This will in turn destroy any notmuch_threads_t and * notmuch_messages_t objects generated by this query, (and in * turn any notmuch_thread_t and notmuch_message_t objects generated * from those results, etc.), if such objects haven't already been * destroyed. */ func (self *Query) Destroy() { if self.query != nil { C.notmuch_query_destroy(self.query) } } /* Return an estimate of the number of messages matching a search * * This function performs a search and returns Xapian's best * guess as to number of matching messages. * * If a Xapian exception occurs, this function may return 0 (after * printing a message). */ func (self *Query) CountMessages() uint { return uint(C.notmuch_query_count_messages(self.query)) } /* Is the given 'threads' iterator pointing at a valid thread. * * When this function returns TRUE, notmuch_threads_get will return a * valid object. Whereas when this function returns FALSE, * notmuch_threads_get will return NULL. * * See the documentation of notmuch_query_search_threads for example * code showing how to iterate over a notmuch_threads_t object. */ func (self *Threads) Valid() bool { if self.threads == nil { return false } valid := C.notmuch_threads_valid(self.threads) if valid == 0 { return false } return true } /* Get the current thread from 'threads' as a notmuch_thread_t. * * Note: The returned thread belongs to 'threads' and has a lifetime * identical to it (and the query to which it belongs). * * See the documentation of notmuch_query_search_threads for example * code showing how to iterate over a notmuch_threads_t object. * * If an out-of-memory situation occurs, this function will return * NULL. */ func (self *Threads) Get() *Thread { if self.threads == nil { return nil } thread := C.notmuch_threads_get(self.threads) if thread == nil { return nil } return &Thread{thread} } /* Move the 'threads' iterator to the next thread. * * If 'threads' is already pointing at the last thread then the * iterator will be moved to a point just beyond that last thread, * (where notmuch_threads_valid will return FALSE and * notmuch_threads_get will return NULL). * * See the documentation of notmuch_query_search_threads for example * code showing how to iterate over a notmuch_threads_t object. */ func (self *Threads) MoveToNext() { if self.threads == nil { return } C.notmuch_threads_move_to_next(self.threads) } /* Destroy a notmuch_threads_t object. * * It's not strictly necessary to call this function. All memory from * the notmuch_threads_t object will be reclaimed when the * containg query object is destroyed. */ func (self *Threads) Destroy() { if self.threads != nil { C.notmuch_threads_destroy(self.threads) } } /** * Get the thread ID of 'thread'. * * The returned string belongs to 'thread' and as such, should not be * modified by the caller and will only be valid for as long as the * thread is valid, (which is until notmuch_thread_destroy or until * the query from which it derived is destroyed). */ func (self *Thread) GetThreadId() string { if self.thread == nil { return "" } id := C.notmuch_thread_get_thread_id(self.thread) if id == nil { return "" } return C.GoString(id) } /** * Get the total number of messages in 'thread'. * * This count consists of all messages in the database belonging to * this thread. Contrast with notmuch_thread_get_matched_messages() . */ func (self *Thread) GetTotalMessages() int { if self.thread == nil { return 0 } return int(C.notmuch_thread_get_total_messages(self.thread)) } /** * Get a notmuch_messages_t iterator for the top-level messages in * 'thread' in oldest-first order. * * This iterator will not necessarily iterate over all of the messages * in the thread. It will only iterate over the messages in the thread * which are not replies to other messages in the thread. * * The returned list will be destroyed when the thread is destroyed. */ func (self *Thread) GetToplevelMessages() (*Messages, Status) { if self.thread == nil { return nil, STATUS_NULL_POINTER } msgs := C.notmuch_thread_get_toplevel_messages(self.thread) if msgs == nil { return nil, STATUS_NULL_POINTER } return &Messages{msgs}, STATUS_SUCCESS } /** * Get a notmuch_thread_t iterator for all messages in 'thread' in * oldest-first order. * * The returned list will be destroyed when the thread is destroyed. */ func (self *Thread) GetMessages() (*Messages, Status) { if self.thread == nil { return nil, STATUS_NULL_POINTER } msgs := C.notmuch_thread_get_messages(self.thread) if msgs == nil { return nil, STATUS_NULL_POINTER } return &Messages{msgs}, STATUS_SUCCESS } /** * Get the number of messages in 'thread' that matched the search. * * This count includes only the messages in this thread that were * matched by the search from which the thread was created and were * not excluded by any exclude tags passed in with the query (see * notmuch_query_add_tag_exclude). Contrast with * notmuch_thread_get_total_messages() . */ func (self *Thread) GetMatchedMessages() int { if self.thread == nil { return 0 } return int(C.notmuch_thread_get_matched_messages(self.thread)) } /** * Get the authors of 'thread' as a UTF-8 string. * * The returned string is a comma-separated list of the names of the * authors of mail messages in the query results that belong to this * thread. * * The string contains authors of messages matching the query first, then * non-matched authors (with the two groups separated by '|'). Within * each group, authors are ordered by date. * * The returned string belongs to 'thread' and as such, should not be * modified by the caller and will only be valid for as long as the * thread is valid, (which is until notmuch_thread_destroy or until * the query from which it derived is destroyed). */ func (self *Thread) GetAuthors() string { if self.thread == nil { return "" } str := C.notmuch_thread_get_authors(self.thread) if str == nil { return "" } return C.GoString(str) } /** * Get the subject of 'thread' as a UTF-8 string. * * The subject is taken from the first message (according to the query * order---see notmuch_query_set_sort) in the query results that * belongs to this thread. * * The returned string belongs to 'thread' and as such, should not be * modified by the caller and will only be valid for as long as the * thread is valid, (which is until notmuch_thread_destroy or until * the query from which it derived is destroyed). */ func (self *Thread) GetSubject() string { if self.thread == nil { return "" } str := C.notmuch_thread_get_subject(self.thread) if str == nil { return "" } return C.GoString(str) } /** * Get the date of the oldest message in 'thread' as a time_t value. */ func (self *Thread) GetOldestDate() int64 { if self.thread == nil { return 0 } date := C.notmuch_thread_get_oldest_date(self.thread) return int64(date) } /** * Get the date of the newest message in 'thread' as a time_t value. */ func (self *Thread) GetNewestDate() int64 { if self.thread == nil { return 0 } date := C.notmuch_thread_get_newest_date(self.thread) return int64(date) } /** * Get the tags for 'thread', returning a notmuch_tags_t object which * can be used to iterate over all tags. * * Note: In the Notmuch database, tags are stored on individual * messages, not on threads. So the tags returned here will be all * tags of the messages which matched the search and which belong to * this thread. * * The tags object is owned by the thread and as such, will only be * valid for as long as the thread is valid, (for example, until * notmuch_thread_destroy or until the query from which it derived is * destroyed). * * Typical usage might be: * * notmuch_thread_t *thread; * notmuch_tags_t *tags; * const char *tag; * * thread = notmuch_threads_get (threads); * * for (tags = notmuch_thread_get_tags (thread); * notmuch_tags_valid (tags); * notmuch_tags_move_to_next (tags)) * { * tag = notmuch_tags_get (tags); * .... * } * * notmuch_thread_destroy (thread); * * Note that there's no explicit destructor needed for the * notmuch_tags_t object. (For consistency, we do provide a * notmuch_tags_destroy function, but there's no good reason to call * it if the message is about to be destroyed). */ func (self *Thread) GetTags() *Tags { if self.thread == nil { return nil } tags := C.notmuch_thread_get_tags(self.thread) if tags == nil { return nil } return &Tags{tags} } /** * Destroy a notmuch_thread_t object. */ func (self *Thread) Destroy() { if self.thread != nil { C.notmuch_thread_destroy(self.thread) } } /* Is the given 'messages' iterator pointing at a valid message. * * When this function returns TRUE, notmuch_messages_get will return a * valid object. Whereas when this function returns FALSE, * notmuch_messages_get will return NULL. * * See the documentation of notmuch_query_search_messages for example * code showing how to iterate over a notmuch_messages_t object. */ func (self *Messages) Valid() bool { if self.messages == nil { return false } valid := C.notmuch_messages_valid(self.messages) if valid == 0 { return false } return true } /* Get the current message from 'messages' as a notmuch_message_t. * * Note: The returned message belongs to 'messages' and has a lifetime * identical to it (and the query to which it belongs). * * See the documentation of notmuch_query_search_messages for example * code showing how to iterate over a notmuch_messages_t object. * * If an out-of-memory situation occurs, this function will return * NULL. */ func (self *Messages) Get() *Message { if self.messages == nil { return nil } msg := C.notmuch_messages_get(self.messages) if msg == nil { return nil } return &Message{message: msg} } /* Move the 'messages' iterator to the next message. * * If 'messages' is already pointing at the last message then the * iterator will be moved to a point just beyond that last message, * (where notmuch_messages_valid will return FALSE and * notmuch_messages_get will return NULL). * * See the documentation of notmuch_query_search_messages for example * code showing how to iterate over a notmuch_messages_t object. */ func (self *Messages) MoveToNext() { if self.messages == nil { return } C.notmuch_messages_move_to_next(self.messages) } /* Destroy a notmuch_messages_t object. * * It's not strictly necessary to call this function. All memory from * the notmuch_messages_t object will be reclaimed when the containing * query object is destroyed. */ func (self *Messages) Destroy() { if self.messages != nil { C.notmuch_messages_destroy(self.messages) } } /* Return a list of tags from all messages. * * The resulting list is guaranteed not to contain duplicated tags. * * WARNING: You can no longer iterate over messages after calling this * function, because the iterator will point at the end of the list. * We do not have a function to reset the iterator yet and the only * way how you can iterate over the list again is to recreate the * message list. * * The function returns NULL on error. */ func (self *Messages) CollectTags() *Tags { if self.messages == nil { return nil } tags := C.notmuch_messages_collect_tags(self.messages) if tags == nil { return nil } return &Tags{tags: tags} } /* Get the message ID of 'message'. * * The returned string belongs to 'message' and as such, should not be * modified by the caller and will only be valid for as long as the * message is valid, (which is until the query from which it derived * is destroyed). * * This function will not return NULL since Notmuch ensures that every * message has a unique message ID, (Notmuch will generate an ID for a * message if the original file does not contain one). */ func (self *Message) GetMessageId() string { if self.message == nil { return "" } id := C.notmuch_message_get_message_id(self.message) // we dont own id // defer C.free(unsafe.Pointer(id)) if id == nil { return "" } return C.GoString(id) } /* Get the thread ID of 'message'. * * The returned string belongs to 'message' and as such, should not be * modified by the caller and will only be valid for as long as the * message is valid, (for example, until the user calls * notmuch_message_destroy on 'message' or until a query from which it * derived is destroyed). * * This function will not return NULL since Notmuch ensures that every * message belongs to a single thread. */ func (self *Message) GetThreadId() string { if self.message == nil { return "" } id := C.notmuch_message_get_thread_id(self.message) // we dont own id // defer C.free(unsafe.Pointer(id)) if id == nil { return "" } return C.GoString(id) } /* Get a notmuch_messages_t iterator for all of the replies to * 'message'. * * Note: This call only makes sense if 'message' was ultimately * obtained from a notmuch_thread_t object, (such as by coming * directly from the result of calling notmuch_thread_get_ * toplevel_messages or by any number of subsequent * calls to notmuch_message_get_replies). * * If 'message' was obtained through some non-thread means, (such as * by a call to notmuch_query_search_messages), then this function * will return NULL. * * If there are no replies to 'message', this function will return * NULL. (Note that notmuch_messages_valid will accept that NULL * value as legitimate, and simply return FALSE for it.) */ func (self *Message) GetReplies() *Messages { if self.message == nil { return nil } msgs := C.notmuch_message_get_replies(self.message) if msgs == nil { return nil } return &Messages{messages: msgs} } /* Get a filename for the email corresponding to 'message'. * * The returned filename is an absolute filename, (the initial * component will match notmuch_database_get_path() ). * * The returned string belongs to the message so should not be * modified or freed by the caller (nor should it be referenced after * the message is destroyed). * * Note: If this message corresponds to multiple files in the mail * store, (that is, multiple files contain identical message IDs), * this function will arbitrarily return a single one of those * filenames. */ func (self *Message) GetFileName() string { if self.message == nil { return "" } fname := C.notmuch_message_get_filename(self.message) // we dont own fname // defer C.free(unsafe.Pointer(fname)) if fname == nil { return "" } return C.GoString(fname) } type Flag C.notmuch_message_flag_t const ( MESSAGE_FLAG_MATCH Flag = 0 ) /* Get a value of a flag for the email corresponding to 'message'. */ func (self *Message) GetFlag(flag Flag) bool { if self.message == nil { return false } v := C.notmuch_message_get_flag(self.message, C.notmuch_message_flag_t(flag)) if v == 0 { return false } return true } /* Set a value of a flag for the email corresponding to 'message'. */ func (self *Message) SetFlag(flag Flag, value bool) { if self.message == nil { return } var v C.notmuch_bool_t = 0 if value { v = 1 } C.notmuch_message_set_flag(self.message, C.notmuch_message_flag_t(flag), v) } /* Get the timestamp (seconds since the epoch) of 'message'. * * Return status: * * NOTMUCH_STATUS_SUCCESS: Timestamp successfully retrieved * * NOTMUCH_STATUS_NULL_POINTER: The 'message' argument is NULL * */ func (self *Message) GetDate() (int64, Status) { if self.message == nil { return -1, STATUS_NULL_POINTER } timestamp := C.notmuch_message_get_date(self.message) return int64(timestamp), STATUS_SUCCESS } /* Get the value of the specified header from 'message'. * * The value will be read from the actual message file, not from the * notmuch database. The header name is case insensitive. * * The returned string belongs to the message so should not be * modified or freed by the caller (nor should it be referenced after * the message is destroyed). * * Returns an empty string ("") if the message does not contain a * header line matching 'header'. Returns NULL if any error occurs. */ func (self *Message) GetHeader(header string) string { if self.message == nil { return "" } var c_header *C.char = C.CString(header) defer C.free(unsafe.Pointer(c_header)) /* we dont own value */ value := C.notmuch_message_get_header(self.message, c_header) if value == nil { return "" } return C.GoString(value) } /* Get the tags for 'message', returning a notmuch_tags_t object which * can be used to iterate over all tags. * * The tags object is owned by the message and as such, will only be * valid for as long as the message is valid, (which is until the * query from which it derived is destroyed). * * Typical usage might be: * * notmuch_message_t *message; * notmuch_tags_t *tags; * const char *tag; * * message = notmuch_database_find_message (database, message_id); * * for (tags = notmuch_message_get_tags (message); * notmuch_tags_valid (tags); * notmuch_result_move_to_next (tags)) * { * tag = notmuch_tags_get (tags); * .... * } * * notmuch_message_destroy (message); * * Note that there's no explicit destructor needed for the * notmuch_tags_t object. (For consistency, we do provide a * notmuch_tags_destroy function, but there's no good reason to call * it if the message is about to be destroyed). */ func (self *Message) GetTags() *Tags { if self.message == nil { return nil } tags := C.notmuch_message_get_tags(self.message) if tags == nil { return nil } return &Tags{tags: tags} } /* The longest possible tag value. */ const TAG_MAX = 200 /* Add a tag to the given message. * * Return value: * * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message * * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL * * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long * (exceeds NOTMUCH_TAG_MAX) * * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only * mode so message cannot be modified. */ func (self *Message) AddTag(tag string) Status { if self.message == nil { return STATUS_NULL_POINTER } c_tag := C.CString(tag) defer C.free(unsafe.Pointer(c_tag)) return Status(C.notmuch_message_add_tag(self.message, c_tag)) } /* Remove a tag from the given message. * * Return value: * * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message * * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL * * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long * (exceeds NOTMUCH_TAG_MAX) * * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only * mode so message cannot be modified. */ func (self *Message) RemoveTag(tag string) Status { if self.message == nil { return STATUS_NULL_POINTER } c_tag := C.CString(tag) defer C.free(unsafe.Pointer(c_tag)) return Status(C.notmuch_message_remove_tag(self.message, c_tag)) } /* Remove all tags from the given message. * * See notmuch_message_freeze for an example showing how to safely * replace tag values. * * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only * mode so message cannot be modified. */ func (self *Message) RemoveAllTags() Status { if self.message == nil { return STATUS_NULL_POINTER } return Status(C.notmuch_message_remove_all_tags(self.message)) } /* Freeze the current state of 'message' within the database. * * This means that changes to the message state, (via * notmuch_message_add_tag, notmuch_message_remove_tag, and * notmuch_message_remove_all_tags), will not be committed to the * database until the message is thawed with notmuch_message_thaw. * * Multiple calls to freeze/thaw are valid and these calls will * "stack". That is there must be as many calls to thaw as to freeze * before a message is actually thawed. * * The ability to do freeze/thaw allows for safe transactions to * change tag values. For example, explicitly setting a message to * have a given set of tags might look like this: * * notmuch_message_freeze (message); * * notmuch_message_remove_all_tags (message); * * for (i = 0; i < NUM_TAGS; i++) * notmuch_message_add_tag (message, tags[i]); * * notmuch_message_thaw (message); * * With freeze/thaw used like this, the message in the database is * guaranteed to have either the full set of original tag values, or * the full set of new tag values, but nothing in between. * * Imagine the example above without freeze/thaw and the operation * somehow getting interrupted. This could result in the message being * left with no tags if the interruption happened after * notmuch_message_remove_all_tags but before notmuch_message_add_tag. * * Return value: * * NOTMUCH_STATUS_SUCCESS: Message successfully frozen. * * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only * mode so message cannot be modified. */ func (self *Message) Freeze() Status { if self.message == nil { return STATUS_NULL_POINTER } return Status(C.notmuch_message_freeze(self.message)) } /* Thaw the current 'message', synchronizing any changes that may have * occurred while 'message' was frozen into the notmuch database. * * See notmuch_message_freeze for an example of how to use this * function to safely provide tag changes. * * Multiple calls to freeze/thaw are valid and these calls with * "stack". That is there must be as many calls to thaw as to freeze * before a message is actually thawed. * * Return value: * * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least * its frozen count has successfully been reduced by 1). * * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw * an unfrozen message. That is, there have been an unbalanced * number of calls to notmuch_message_freeze and * notmuch_message_thaw. */ func (self *Message) Thaw() Status { if self.message == nil { return STATUS_NULL_POINTER } return Status(C.notmuch_message_thaw(self.message)) } /* Destroy a notmuch_message_t object. * * It can be useful to call this function in the case of a single * query object with many messages in the result, (such as iterating * over the entire database). Otherwise, it's fine to never call this * function and there will still be no memory leaks. (The memory from * the messages get reclaimed when the containing query is destroyed.) */ func (self *Message) Destroy() { if self.message == nil { return } C.notmuch_message_destroy(self.message) } /* Is the given 'tags' iterator pointing at a valid tag. * * When this function returns TRUE, notmuch_tags_get will return a * valid string. Whereas when this function returns FALSE, * notmuch_tags_get will return NULL. * * See the documentation of notmuch_message_get_tags for example code * showing how to iterate over a notmuch_tags_t object. */ func (self *Tags) Valid() bool { if self.tags == nil { return false } v := C.notmuch_tags_valid(self.tags) if v == 0 { return false } return true } /* Get the current tag from 'tags' as a string. * * Note: The returned string belongs to 'tags' and has a lifetime * identical to it (and the query to which it ultimately belongs). * * See the documentation of notmuch_message_get_tags for example code * showing how to iterate over a notmuch_tags_t object. */ func (self *Tags) Get() string { if self.tags == nil { return "" } s := C.notmuch_tags_get(self.tags) // we dont own 's' return C.GoString(s) } func (self *Tags) String() string { return self.Get() } /* Move the 'tags' iterator to the next tag. * * If 'tags' is already pointing at the last tag then the iterator * will be moved to a point just beyond that last tag, (where * notmuch_tags_valid will return FALSE and notmuch_tags_get will * return NULL). * * See the documentation of notmuch_message_get_tags for example code * showing how to iterate over a notmuch_tags_t object. */ func (self *Tags) MoveToNext() { if self.tags == nil { return } C.notmuch_tags_move_to_next(self.tags) } /* Destroy a notmuch_tags_t object. * * It's not strictly necessary to call this function. All memory from * the notmuch_tags_t object will be reclaimed when the containing * message or query objects are destroyed. */ func (self *Tags) Destroy() { if self.tags == nil { return } C.notmuch_tags_destroy(self.tags) } // TODO: wrap notmuch_directory_ /* Destroy a notmuch_directory_t object. */ func (self *Directory) Destroy() { if self.dir == nil { return } C.notmuch_directory_destroy(self.dir) } // TODO: wrap notmuch_filenames_ /* Destroy a notmuch_filenames_t object. * * It's not strictly necessary to call this function. All memory from * the notmuch_filenames_t object will be reclaimed when the * containing directory object is destroyed. * * It is acceptable to pass NULL for 'filenames', in which case this * function will do nothing. */ func (self *Filenames) Destroy() { if self.fnames == nil { return } C.notmuch_filenames_destroy(self.fnames) } /* EOF */ notmuch-0.23.7/contrib/notmuch-mutt/000077500000000000000000000000001305541522400173655ustar00rootroot00000000000000notmuch-0.23.7/contrib/notmuch-mutt/.gitignore000066400000000000000000000000331305541522400213510ustar00rootroot00000000000000notmuch-mutt.1 README.html notmuch-0.23.7/contrib/notmuch-mutt/Makefile000066400000000000000000000002421305541522400210230ustar00rootroot00000000000000NAME = notmuch-mutt all: $(NAME) $(NAME).1 $(NAME).1: $(NAME) pod2man $< > $@ README.html: README markdown $< > $@ clean: rm -f notmuch-mutt.1 README.html notmuch-0.23.7/contrib/notmuch-mutt/README000066400000000000000000000043561305541522400202550ustar00rootroot00000000000000notmuch-mutt: Notmuch (of a) helper for Mutt ============================================ notmuch-mutt provide integration among the [Mutt] [1] mail user agent and the [Notmuch] [2] mail indexer. notmuch-mutt offer two main integration features. The first one is the ability of stating a **search query interactively** and then jump to a fresh Maildir containing its search results only. The second one is the ability to **reconstruct threads on the fly** starting from the currently highlighted mail, which comes handy when a thread has been split across different maildirs, archived, or the like. notmuch-mutt enables to trigger mail searches via a Mutt macro (usually F8) and reconstruct threads via another (usually F9). Check the manpage for the 2-liner configuration snippet for your Mutt configuration files (~/.muttrc, /etc/Muttrc, or a /etc/Muttrc.d snippet). A [blog style introduction] [3] to notmuch-mutt is available and includes some more rationale for its existence. Arguably, some of the logics of notmuch-mutt could disappear by adding support for a --output=symlinks flag to notmuch. [1]: http://www.mutt.org/ [2]: https://notmuchmail.org/ [3]: https://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/ Requirements ------------ To *run* notmuch-mutt you will need Perl with the following libraries: - Digest::SHA (Debian package: libdigest-sha-perl) - Mail::Box (Debian package: libmail-box-perl) - Mail::Header (Debian package: libmailtools-perl) - String::ShellQuote (Debian package: libstring-shellquote-perl) - Term::ReadLine::Gnu (Debian package: libterm-readline-gnu-perl) To *build* notmuch-mutt documentation you will need: - pod2man (coming with Perl) to generate the manpage - markdown to generate README.html out of this file License ------- notmuch-mutt is copyright (C) 2011-2012 Stefano Zacchiroli . notmuch-mutt is released under the terms of the GNU General Public License (GPL), version 3 or above. A copy of the license is available online at . notmuch-0.23.7/contrib/notmuch-mutt/notmuch-mutt000077500000000000000000000200471305541522400217620ustar00rootroot00000000000000#!/usr/bin/env perl # # notmuch-mutt - notmuch (of a) helper for Mutt # # Copyright: 2011-2015 Stefano Zacchiroli # License: GNU General Public License (GPL), version 3 or above # # See the bottom of this file for more documentation. # A manpage can be obtained by running "pod2man notmuch-mutt > notmuch-mutt.1" use strict; use warnings; use File::Path; use Getopt::Long qw(:config no_getopt_compat); use Mail::Header; use Mail::Box::Maildir; use Pod::Usage; use String::ShellQuote; use Term::ReadLine; use Digest::SHA; my $xdg_cache_dir = "$ENV{HOME}/.cache"; $xdg_cache_dir = $ENV{XDG_CACHE_HOME} if $ENV{XDG_CACHE_HOME}; my $cache_dir = "$xdg_cache_dir/notmuch/mutt"; # create an empty maildir (if missing) or empty an existing maildir" sub empty_maildir($) { my ($maildir) = (@_); rmtree($maildir) if (-d $maildir); my $folder = new Mail::Box::Maildir(folder => $maildir, create => 1); $folder->close(); } # search($maildir, $remove_dups, $query) # search mails according to $query with notmuch; store results in $maildir sub search($$$) { my ($maildir, $remove_dups, $query) = @_; my $dup_option = ""; $query = shell_quote($query); if ($remove_dups) { $dup_option = "--duplicate=1"; } empty_maildir($maildir); system("notmuch search --output=files $dup_option $query" . " | sed -e 's: :\\\\ :g'" . " | xargs -r -I searchoutput ln -s searchoutput $maildir/cur/"); } sub prompt($$) { my ($text, $default) = @_; my $query = ""; my $term = Term::ReadLine->new( "notmuch-mutt" ); my $histfile = "$cache_dir/history"; $term->ornaments( 0 ); $term->unbind_key( ord( "\t" ) ); $term->MinLine( 3 ); $histfile = $ENV{MUTT_NOTMUCH_HISTFILE} if $ENV{MUTT_NOTMUCH_HISTFILE}; $term->ReadHistory($histfile) if (-r $histfile); while (1) { chomp($query = $term->readline($text, $default)); if ($query eq "?") { system("man", "notmuch-search-terms"); } else { $term->WriteHistory($histfile); return $query; } } } sub get_message_id() { my $mid = undef; my @headers = (); while () { # collect header lines in @headers push(@headers, $_); last if $_ =~ /^$/; } my $head = Mail::Header->new(\@headers); $mid = $head->get("message-id") or undef; if ($mid) { # Message-ID header found $mid =~ /^<(.*)>$/; # extract message id $mid = $1; } else { # Message-ID header not found, synthesize a message id # based on SHA1, as notmuch would do. See: # https://git.notmuchmail.org/git/notmuch/blob/HEAD:/lib/sha1.c my $sha = Digest::SHA->new(1); $sha->add($_) foreach(@headers); $sha->addfile(\*STDIN); $mid = 'notmuch-sha1-' . $sha->hexdigest; } return $mid; } sub search_action($$$@) { my ($interactive, $results_dir, $remove_dups, @params) = @_; if (! $interactive) { search($results_dir, $remove_dups, join(' ', @params)); } else { my $query = prompt("search ('?' for man): ", join(' ', @params)); if ($query ne "") { search($results_dir, $remove_dups, $query); } } } sub thread_action($$@) { my ($results_dir, $remove_dups, @params) = @_; my $mid = get_message_id(); if (! defined $mid) { empty_maildir($results_dir); die "notmuch-mutt: cannot find Message-Id, abort.\n"; } my $search_cmd = 'notmuch search --output=threads ' . shell_quote("id:$mid"); my $tid = `$search_cmd`; # get thread id chomp($tid); search($results_dir, $remove_dups, $tid); } sub tag_action(@) { my $mid = get_message_id(); defined $mid or die "notmuch-mutt: cannot find Message-Id, abort.\n"; system("notmuch", "tag", @_, "--", "id:$mid"); } sub die_usage() { my %podflags = ( "verbose" => 1, "exitval" => 2 ); pod2usage(%podflags); } sub main() { mkpath($cache_dir) unless (-d $cache_dir); my $results_dir = "$cache_dir/results"; my $interactive = 0; my $help_needed = 0; my $remove_dups = 0; my $getopt = GetOptions( "h|help" => \$help_needed, "o|output-dir=s" => \$results_dir, "p|prompt" => \$interactive, "r|remove-dups" => \$remove_dups); if (! $getopt || $#ARGV < 0) { die_usage() }; my ($action, @params) = ($ARGV[0], @ARGV[1..$#ARGV]); foreach my $param (@params) { $param =~ s/folder:=/folder:/g; } if ($help_needed) { die_usage(); } elsif ($action eq "search" && $#ARGV == 0 && ! $interactive) { print STDERR "Error: no search term provided\n\n"; die_usage(); } elsif ($action eq "search") { search_action($interactive, $results_dir, $remove_dups, @params); } elsif ($action eq "thread") { thread_action($results_dir, $remove_dups, @params); } elsif ($action eq "tag") { tag_action(@params); } else { die_usage(); } } main(); __END__ =head1 NAME notmuch-mutt - notmuch (of a) helper for Mutt =head1 SYNOPSIS =over =item B [I