+++ /dev/null
-*.py[co]
-/docs/build
-/docs/html
-/build/
+++ /dev/null
-include notmuch
-#recursive-include docs/html *
\ No newline at end of file
+++ /dev/null
-notmuch -- The python interface to notmuch
-==========================================
-
-This module makes the functionality of the notmuch library
-(`https://notmuchmail.org`_) available to python. Successful import of
-this module 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
+++ /dev/null
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- 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.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- 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/>.
-
-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:
-
- <program> Copyright (C) <year> <name of author>
- 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
-<https://www.gnu.org/licenses/>.
-
- 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
-<https://www.gnu.org/philosophy/why-not-lgpl.html>.
+++ /dev/null
-# 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 <target>' where <target> 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."
+++ /dev/null
-# -*- 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
-
-from unittest.mock import Mock
-
-# 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('../..'))
-
-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
-# "<project> v<release> 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 <link> 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 = {'python': ('https://docs.python.org/3', None)}
+++ /dev/null
-: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:: index_file
-
- .. automethod:: remove_message
-
- .. automethod:: find_message
-
- .. automethod:: find_message_by_filename
-
- .. automethod:: get_all_tags
-
- .. automethod:: create_query
-
- .. automethod:: get_config
-
- .. automethod:: get_configs
-
- .. automethod:: set_config
-
- .. 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
+++ /dev/null
-Files 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:`Directory` -- 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
+++ /dev/null
-Welcome to :mod:`notmuch`'s documentation
-=========================================
-
-.. currentmodule:: notmuch
-
-The :mod:`notmuch` module provides an interface to the `notmuch
-<https://notmuchmail.org>`_ 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 <Sebastian@SSpaeth.de>
-
-: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`
+++ /dev/null
-: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:: get_property
-
- .. automethod:: get_properties
-
- .. 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__
+++ /dev/null
-: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))`.
+++ /dev/null
-Interfacing with notmuch
-========================
-
-.. todo:: move the note about talloc out of the code
-
-.. automodule:: notmuch
+++ /dev/null
-: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 explicitly 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
+++ /dev/null
-Quickstart 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)
+++ /dev/null
-.. 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:
+++ /dev/null
-: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__
+++ /dev/null
-: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__
+++ /dev/null
-: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__
+++ /dev/null
-"""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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010-2011 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-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 <Sebastian@SSpaeth.de>'
+++ /dev/null
-'''
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-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 ConfigParser as SafeConfigParser
-
- if not hasattr(SafeConfigParser, 'readfp'): # py >= 3.12
- SafeConfigParser.readfp = SafeConfigParser.read_file
-
- 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
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-import os
-import codecs
-import warnings
-from ctypes import c_char_p, c_void_p, c_uint, byref, POINTER
-from .compat import SafeConfigParser
-from .globals import (
- nmlib,
- Enum,
- _str,
- NotmuchConfigListP,
- NotmuchDatabaseP,
- NotmuchDirectoryP,
- NotmuchIndexoptsP,
- 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 initialized
- 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"""
-
- DECRYPTION_POLICY = Enum(['FALSE', 'TRUE', 'AUTO', 'NOSTASH'])
- """Constants: policies for decrypting messages during indexing"""
-
- """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_get_revision"""
- _get_revision = nmlib.notmuch_database_get_revision
- _get_revision.argtypes = [NotmuchDatabaseP, POINTER(c_char_p)]
- _get_revision.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)
-
- def get_revision (self):
- """Returns the committed database revision and UUID
-
- :returns: (revision, uuid) The database revision as a positive integer
- and the UUID of the database.
- """
- self._assert_db_is_initialized()
- uuid = c_char_p ()
- revision = Database._get_revision(self._db, byref (uuid))
- return (revision, uuid.value.decode ('utf-8'))
-
- _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:`index_file`,
- :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)
-
- _get_default_indexopts = nmlib.notmuch_database_get_default_indexopts
- _get_default_indexopts.argtypes = [NotmuchDatabaseP]
- _get_default_indexopts.restype = NotmuchIndexoptsP
-
- _indexopts_set_decrypt_policy = nmlib.notmuch_indexopts_set_decrypt_policy
- _indexopts_set_decrypt_policy.argtypes = [NotmuchIndexoptsP, c_uint]
- _indexopts_set_decrypt_policy.restype = None
-
- _indexopts_destroy = nmlib.notmuch_indexopts_destroy
- _indexopts_destroy.argtypes = [NotmuchIndexoptsP]
- _indexopts_destroy.restype = None
-
- _index_file = nmlib.notmuch_database_index_file
- _index_file.argtypes = [NotmuchDatabaseP, c_char_p,
- c_void_p,
- POINTER(NotmuchMessageP)]
- _index_file.restype = c_uint
-
- def index_file(self, filename, sync_maildir_flags=False, decrypt_policy=None):
- """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`.
-
- :param decrypt_policy: If the message contains any encrypted
- parts, and decrypt_policy is set to
- :attr:`DECRYPTION_POLICY`.TRUE, notmuch will try to
- decrypt the message and index the cleartext, stashing any
- discovered session keys. If it is set to
- :attr:`DECRYPTION_POLICY`.FALSE, it will never try to
- decrypt during indexing. If it is set to
- :attr:`DECRYPTION_POLICY`.AUTO, then it will try to use
- any stashed session keys it knows about, but will not try
- to access the user's secret keys.
- :attr:`DECRYPTION_POLICY`.NOSTASH behaves the same as
- :attr:`DECRYPTION_POLICY`.TRUE except that no session keys
- are stashed in the database. If decrypt_policy is set to
- None (the default), then the database itself will decide
- whether to decrypt, based on the `index.decrypt`
- configuration setting (see notmuch-config(1)).
-
- :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()
- indexopts = c_void_p(None)
- if decrypt_policy is not None:
- indexopts = self._get_default_indexopts(self._db)
- self._indexopts_set_decrypt_policy(indexopts, decrypt_policy)
-
- status = self._index_file(self._db, _str(filename), indexopts, byref(msg_p))
-
- if indexopts:
- self._indexopts_destroy(indexopts)
-
- 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)
-
- def add_message(self, filename, sync_maildir_flags=False):
- """Deprecated alias for :meth:`index_file`
- """
- warnings.warn(
- "This function is deprecated and will be removed in the future, use index_file.", DeprecationWarning)
-
- return self.index_file(filename, sync_maildir_flags=sync_maildir_flags)
-
- _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 occurred 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 initialized.
- """
- 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 occurred 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
- initialized.
-
- *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`
- :exception: :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")
- db_path = config.get('database', 'path')
- if not os.path.isabs(db_path):
- db_path = os.path.expanduser(os.path.join("~", db_path))
- return db_path
-
- """notmuch_database_get_config"""
- _get_config = nmlib.notmuch_database_get_config
- _get_config.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(c_char_p)]
- _get_config.restype = c_uint
-
- def get_config(self, key):
- """Return the value of the given config key.
-
- Note that only config values that are stored in the database are
- searched and returned. The config file is not read.
-
- :param key: the config key under which a value should be looked up, it
- should probably be in the form "section.key"
- :type key: str
- :returns: the config value or the empty string if no value is present
- for that key
- :rtype: str
- :raises: :exc:`NotmuchError` in case of failure.
-
- """
- self._assert_db_is_initialized()
- return_string = c_char_p()
- status = self._get_config(self._db, _str(key), byref(return_string))
- if status != STATUS.SUCCESS:
- raise NotmuchError(status)
- return return_string.value.decode('utf-8')
-
- """notmuch_database_get_config_list"""
- _get_config_list = nmlib.notmuch_database_get_config_list
- _get_config_list.argtypes = [NotmuchDatabaseP, c_char_p,
- POINTER(NotmuchConfigListP)]
- _get_config_list.restype = c_uint
-
- _config_list_valid = nmlib.notmuch_config_list_valid
- _config_list_valid.argtypes = [NotmuchConfigListP]
- _config_list_valid.restype = bool
-
- _config_list_key = nmlib.notmuch_config_list_key
- _config_list_key.argtypes = [NotmuchConfigListP]
- _config_list_key.restype = c_char_p
-
- _config_list_value = nmlib.notmuch_config_list_value
- _config_list_value.argtypes = [NotmuchConfigListP]
- _config_list_value.restype = c_char_p
-
- _config_list_move_to_next = nmlib.notmuch_config_list_move_to_next
- _config_list_move_to_next.argtypes = [NotmuchConfigListP]
- _config_list_move_to_next.restype = None
-
- _config_list_destroy = nmlib.notmuch_config_list_destroy
- _config_list_destroy.argtypes = [NotmuchConfigListP]
- _config_list_destroy.restype = None
-
- def get_configs(self, prefix=''):
- """Return a generator of key, value pairs where the start of key
- matches the given prefix
-
- Note that only config values that are stored in the database are
- searched and returned. The config file is not read. If no `prefix` is
- given all config values are returned.
-
- This could be used to get all named queries into a dict for example::
-
- queries = {k[6:]: v for k, v in db.get_configs('query.')}
-
- :param prefix: a string by which the keys should be selected
- :type prefix: str
- :yields: all key-value pairs where `prefix` matches the beginning
- of the key
- :ytype: pairs of str
- :raises: :exc:`NotmuchError` in case of failure.
-
- """
- self._assert_db_is_initialized()
- config_list_p = NotmuchConfigListP()
- status = self._get_config_list(self._db, _str(prefix),
- byref(config_list_p))
- if status != STATUS.SUCCESS:
- raise NotmuchError(status)
- while self._config_list_valid(config_list_p):
- key = self._config_list_key(config_list_p).decode('utf-8')
- value = self._config_list_value(config_list_p).decode('utf-8')
- yield key, value
- self._config_list_move_to_next(config_list_p)
-
- """notmuch_database_set_config"""
- _set_config = nmlib.notmuch_database_set_config
- _set_config.argtypes = [NotmuchDatabaseP, c_char_p, c_char_p]
- _set_config.restype = c_uint
-
- def set_config(self, key, value):
- """Set a config value in the notmuch database.
-
- If an empty string is provided as `value` the `key` is unset!
-
- :param key: the key to set
- :type key: str
- :param value: the value to store under `key`
- :type value: str
- :returns: None
- :raises: :exc:`NotmuchError` in case of failure.
-
- """
- self._assert_db_is_initialized()
- status = self._set_config(self._db, _str(key), _str(value))
- if status != STATUS.SUCCESS:
- raise NotmuchError(status)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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.index_file` 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 "<notmuch Directory object '%s'>" % 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)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-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 publicly 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)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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 NotmuchMessagePropertiesS(Structure):
- pass
-NotmuchMessagePropertiesP = POINTER(NotmuchMessagePropertiesS)
-
-
-class NotmuchTagsS(Structure):
- pass
-NotmuchTagsP = POINTER(NotmuchTagsS)
-
-
-class NotmuchDirectoryS(Structure):
- pass
-NotmuchDirectoryP = POINTER(NotmuchDirectoryS)
-
-
-class NotmuchFilenamesS(Structure):
- pass
-NotmuchFilenamesP = POINTER(NotmuchFilenamesS)
-
-
-class NotmuchConfigListS(Structure):
- pass
-NotmuchConfigListP = POINTER(NotmuchConfigListS)
-
-
-class NotmuchIndexoptsS(Structure):
- pass
-NotmuchIndexoptsP = POINTER(NotmuchIndexoptsS)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
- Jesse Rosenthal <jrosenthal@jhu.edu>
-"""
-
-
-from ctypes import c_char_p, c_long, c_uint, c_int, POINTER, byref
-from datetime import date
-from .globals import (
- nmlib,
- Enum,
- _str,
- Python3StringMixIn,
- NotmuchTagsP,
- NotmuchMessageP,
- NotmuchMessagesP,
- NotmuchMessagePropertiesP,
- NotmuchFilenamesP,
-)
-from .errors import (
- STATUS,
- NotmuchError,
- NullPointerError,
- NotInitializedError,
-)
-from .tag import Tags
-from .filenames import Filenames
-
-import email
-import sys
-
-
-class Message(Python3StringMixIn):
- r"""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
-
- """notmuch_message_get_property"""
- _get_property = nmlib.notmuch_message_get_property
- _get_property.argtypes = [NotmuchMessageP, c_char_p, POINTER(c_char_p)]
- _get_property.restype = c_int
-
- """notmuch_message_get_properties"""
- _get_properties = nmlib.notmuch_message_get_properties
- _get_properties.argtypes = [NotmuchMessageP, c_char_p, c_int]
- _get_properties.restype = NotmuchMessagePropertiesP
-
- """notmuch_message_properties_valid"""
- _properties_valid = nmlib.notmuch_message_properties_valid
- _properties_valid.argtypes = [NotmuchMessagePropertiesP]
- _properties_valid.restype = bool
-
- """notmuch_message_properties_value"""
- _properties_value = nmlib.notmuch_message_properties_value
- _properties_value.argtypes = [NotmuchMessagePropertiesP]
- _properties_value.restype = c_char_p
-
- """notmuch_message_properties_key"""
- _properties_key = nmlib.notmuch_message_properties_key
- _properties_key.argtypes = [NotmuchMessagePropertiesP]
- _properties_key.restype = c_char_p
-
- """notmuch_message_properties_move_to_next"""
- _properties_move_to_next = nmlib.notmuch_message_properties_move_to_next
- _properties_move_to_next.argtypes = [NotmuchMessagePropertiesP]
- _properties_move_to_next.restype = None
-
- #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 occurred
- """
- 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 occurred
- """
- 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 get_property(self, prop):
- """ Retrieve the value for a single property key
-
- :param prop: The name of the property to get.
- :returns: String with the property value or None if there is no such
- key. In the case of multiple values for the given key, the
- first one is retrieved.
- :raises: :exc:`NotInitializedError` if message has not been
- initialized
- """
- if not self._msg:
- raise NotInitializedError()
-
- value = c_char_p()
- status = Message._get_property(self._msg, _str(prop), byref(value))
- if status != 0:
- raise NotmuchError(status)
-
- if value is None or value.value is None:
- return None
- return value.value.decode('utf-8')
-
- def get_properties(self, prop="", exact=False):
- """ Get the properties of the message, returning a generator of
- name, value pairs.
-
- The generator will yield once per value. There might be more than one
- value on each name, so the generator might yield the same name several
- times.
-
- :param prop: The name of the property to get. Otherwise it will return
- the full list of properties of the message.
- :param exact: if True, require exact match with key. Otherwise
- treat as prefix.
- :yields: Each property values as a pair of `name, value`
- :ytype: pairs of str
- :raises: :exc:`NotInitializedError` if message has not been
- initialized
- """
- if not self._msg:
- raise NotInitializedError()
-
- properties = Message._get_properties(self._msg, _str(prop), exact)
- while Message._properties_valid(properties):
- key = Message._properties_key(properties)
- value = Message._properties_value(properties)
- yield key.decode("utf-8"), value.decode("utf-8")
- Message._properties_move_to_next(properties)
-
- 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.index_file` 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(), 'rb')
- if sys.version_info[0] < 3:
- email_msg = email.message_from_file(fp)
- else:
- email_msg = email.message_from_binary_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)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
- Jesse Rosenthal <jrosenthal@jhu.edu>
-"""
-
-from .globals import (
- nmlib,
- NotmuchTagsP,
- NotmuchMessageP,
- NotmuchMessagesP,
-)
-from .errors import (
- NullPointerError,
- NotInitializedError,
-)
-from .tag import Tags
-from .message import Message
-
-class Messages(object):
- r"""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 publicly 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__
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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
- initialized.
- """
- 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.restype = 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.restype = 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"""
- _search_threads = nmlib.notmuch_query_search_threads
- _search_threads.argtypes = [NotmuchQueryP, POINTER(NotmuchThreadsP)]
- _search_threads.restype = c_uint
-
- def search_threads(self):
- r"""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(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 = nmlib.notmuch_query_search_messages
- _search_messages.argtypes = [NotmuchQueryP, POINTER(NotmuchMessagesP)]
- _search_messages.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(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
- _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
- _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)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-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 publicly 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)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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 publicly 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 explicitly 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)
+++ /dev/null
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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 publicly 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)
+++ /dev/null
-# this file should be kept in sync with ../../../version
-__VERSION__ = '0.38.3'
-SOVERSION = '5'
+++ /dev/null
-#!/usr/bin/env python3
-
-"""
-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 <https://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
-"""
-
-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
-<https://notmuchmail.org>`_ 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 <https://notmuch.readthedocs.io/>`_.
-
-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',
- )
--- /dev/null
+*.py[co]
+/docs/build
+/docs/html
+/build/
--- /dev/null
+include notmuch
+#recursive-include docs/html *
\ No newline at end of file
--- /dev/null
+notmuch -- The python interface to notmuch
+==========================================
+
+This module makes the functionality of the notmuch library
+(`https://notmuchmail.org`_) available to python. Successful import of
+this module 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
--- /dev/null
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<https://www.gnu.org/licenses/>.
+
+ 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
+<https://www.gnu.org/philosophy/why-not-lgpl.html>.
--- /dev/null
+# 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 <target>' where <target> 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."
--- /dev/null
+# -*- 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
+
+from unittest.mock import Mock
+
+# 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('../..'))
+
+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
+# "<project> v<release> 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 <link> 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 = {'python': ('https://docs.python.org/3', None)}
--- /dev/null
+: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:: index_file
+
+ .. automethod:: remove_message
+
+ .. automethod:: find_message
+
+ .. automethod:: find_message_by_filename
+
+ .. automethod:: get_all_tags
+
+ .. automethod:: create_query
+
+ .. automethod:: get_config
+
+ .. automethod:: get_configs
+
+ .. automethod:: set_config
+
+ .. 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
--- /dev/null
+Files 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:`Directory` -- 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
--- /dev/null
+Welcome to :mod:`notmuch`'s documentation
+=========================================
+
+.. currentmodule:: notmuch
+
+The :mod:`notmuch` module provides an interface to the `notmuch
+<https://notmuchmail.org>`_ 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 <Sebastian@SSpaeth.de>
+
+: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`
--- /dev/null
+: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:: get_property
+
+ .. automethod:: get_properties
+
+ .. 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__
--- /dev/null
+: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))`.
--- /dev/null
+Interfacing with notmuch
+========================
+
+.. todo:: move the note about talloc out of the code
+
+.. automodule:: notmuch
--- /dev/null
+: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 explicitly 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
--- /dev/null
+Quickstart 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)
--- /dev/null
+.. 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:
--- /dev/null
+: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__
--- /dev/null
+: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__
--- /dev/null
+: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__
--- /dev/null
+"""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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010-2011 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+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 <Sebastian@SSpaeth.de>'
--- /dev/null
+'''
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+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 ConfigParser as SafeConfigParser
+
+ if not hasattr(SafeConfigParser, 'readfp'): # py >= 3.12
+ SafeConfigParser.readfp = SafeConfigParser.read_file
+
+ 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
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+import os
+import codecs
+import warnings
+from ctypes import c_char_p, c_void_p, c_uint, byref, POINTER
+from .compat import SafeConfigParser
+from .globals import (
+ nmlib,
+ Enum,
+ _str,
+ NotmuchConfigListP,
+ NotmuchDatabaseP,
+ NotmuchDirectoryP,
+ NotmuchIndexoptsP,
+ 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 initialized
+ 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"""
+
+ DECRYPTION_POLICY = Enum(['FALSE', 'TRUE', 'AUTO', 'NOSTASH'])
+ """Constants: policies for decrypting messages during indexing"""
+
+ """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_get_revision"""
+ _get_revision = nmlib.notmuch_database_get_revision
+ _get_revision.argtypes = [NotmuchDatabaseP, POINTER(c_char_p)]
+ _get_revision.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)
+
+ def get_revision (self):
+ """Returns the committed database revision and UUID
+
+ :returns: (revision, uuid) The database revision as a positive integer
+ and the UUID of the database.
+ """
+ self._assert_db_is_initialized()
+ uuid = c_char_p ()
+ revision = Database._get_revision(self._db, byref (uuid))
+ return (revision, uuid.value.decode ('utf-8'))
+
+ _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:`index_file`,
+ :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)
+
+ _get_default_indexopts = nmlib.notmuch_database_get_default_indexopts
+ _get_default_indexopts.argtypes = [NotmuchDatabaseP]
+ _get_default_indexopts.restype = NotmuchIndexoptsP
+
+ _indexopts_set_decrypt_policy = nmlib.notmuch_indexopts_set_decrypt_policy
+ _indexopts_set_decrypt_policy.argtypes = [NotmuchIndexoptsP, c_uint]
+ _indexopts_set_decrypt_policy.restype = None
+
+ _indexopts_destroy = nmlib.notmuch_indexopts_destroy
+ _indexopts_destroy.argtypes = [NotmuchIndexoptsP]
+ _indexopts_destroy.restype = None
+
+ _index_file = nmlib.notmuch_database_index_file
+ _index_file.argtypes = [NotmuchDatabaseP, c_char_p,
+ c_void_p,
+ POINTER(NotmuchMessageP)]
+ _index_file.restype = c_uint
+
+ def index_file(self, filename, sync_maildir_flags=False, decrypt_policy=None):
+ """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`.
+
+ :param decrypt_policy: If the message contains any encrypted
+ parts, and decrypt_policy is set to
+ :attr:`DECRYPTION_POLICY`.TRUE, notmuch will try to
+ decrypt the message and index the cleartext, stashing any
+ discovered session keys. If it is set to
+ :attr:`DECRYPTION_POLICY`.FALSE, it will never try to
+ decrypt during indexing. If it is set to
+ :attr:`DECRYPTION_POLICY`.AUTO, then it will try to use
+ any stashed session keys it knows about, but will not try
+ to access the user's secret keys.
+ :attr:`DECRYPTION_POLICY`.NOSTASH behaves the same as
+ :attr:`DECRYPTION_POLICY`.TRUE except that no session keys
+ are stashed in the database. If decrypt_policy is set to
+ None (the default), then the database itself will decide
+ whether to decrypt, based on the `index.decrypt`
+ configuration setting (see notmuch-config(1)).
+
+ :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()
+ indexopts = c_void_p(None)
+ if decrypt_policy is not None:
+ indexopts = self._get_default_indexopts(self._db)
+ self._indexopts_set_decrypt_policy(indexopts, decrypt_policy)
+
+ status = self._index_file(self._db, _str(filename), indexopts, byref(msg_p))
+
+ if indexopts:
+ self._indexopts_destroy(indexopts)
+
+ 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)
+
+ def add_message(self, filename, sync_maildir_flags=False):
+ """Deprecated alias for :meth:`index_file`
+ """
+ warnings.warn(
+ "This function is deprecated and will be removed in the future, use index_file.", DeprecationWarning)
+
+ return self.index_file(filename, sync_maildir_flags=sync_maildir_flags)
+
+ _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 occurred 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 initialized.
+ """
+ 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 occurred 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
+ initialized.
+
+ *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`
+ :exception: :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")
+ db_path = config.get('database', 'path')
+ if not os.path.isabs(db_path):
+ db_path = os.path.expanduser(os.path.join("~", db_path))
+ return db_path
+
+ """notmuch_database_get_config"""
+ _get_config = nmlib.notmuch_database_get_config
+ _get_config.argtypes = [NotmuchDatabaseP, c_char_p, POINTER(c_char_p)]
+ _get_config.restype = c_uint
+
+ def get_config(self, key):
+ """Return the value of the given config key.
+
+ Note that only config values that are stored in the database are
+ searched and returned. The config file is not read.
+
+ :param key: the config key under which a value should be looked up, it
+ should probably be in the form "section.key"
+ :type key: str
+ :returns: the config value or the empty string if no value is present
+ for that key
+ :rtype: str
+ :raises: :exc:`NotmuchError` in case of failure.
+
+ """
+ self._assert_db_is_initialized()
+ return_string = c_char_p()
+ status = self._get_config(self._db, _str(key), byref(return_string))
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
+ return return_string.value.decode('utf-8')
+
+ """notmuch_database_get_config_list"""
+ _get_config_list = nmlib.notmuch_database_get_config_list
+ _get_config_list.argtypes = [NotmuchDatabaseP, c_char_p,
+ POINTER(NotmuchConfigListP)]
+ _get_config_list.restype = c_uint
+
+ _config_list_valid = nmlib.notmuch_config_list_valid
+ _config_list_valid.argtypes = [NotmuchConfigListP]
+ _config_list_valid.restype = bool
+
+ _config_list_key = nmlib.notmuch_config_list_key
+ _config_list_key.argtypes = [NotmuchConfigListP]
+ _config_list_key.restype = c_char_p
+
+ _config_list_value = nmlib.notmuch_config_list_value
+ _config_list_value.argtypes = [NotmuchConfigListP]
+ _config_list_value.restype = c_char_p
+
+ _config_list_move_to_next = nmlib.notmuch_config_list_move_to_next
+ _config_list_move_to_next.argtypes = [NotmuchConfigListP]
+ _config_list_move_to_next.restype = None
+
+ _config_list_destroy = nmlib.notmuch_config_list_destroy
+ _config_list_destroy.argtypes = [NotmuchConfigListP]
+ _config_list_destroy.restype = None
+
+ def get_configs(self, prefix=''):
+ """Return a generator of key, value pairs where the start of key
+ matches the given prefix
+
+ Note that only config values that are stored in the database are
+ searched and returned. The config file is not read. If no `prefix` is
+ given all config values are returned.
+
+ This could be used to get all named queries into a dict for example::
+
+ queries = {k[6:]: v for k, v in db.get_configs('query.')}
+
+ :param prefix: a string by which the keys should be selected
+ :type prefix: str
+ :yields: all key-value pairs where `prefix` matches the beginning
+ of the key
+ :ytype: pairs of str
+ :raises: :exc:`NotmuchError` in case of failure.
+
+ """
+ self._assert_db_is_initialized()
+ config_list_p = NotmuchConfigListP()
+ status = self._get_config_list(self._db, _str(prefix),
+ byref(config_list_p))
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
+ while self._config_list_valid(config_list_p):
+ key = self._config_list_key(config_list_p).decode('utf-8')
+ value = self._config_list_value(config_list_p).decode('utf-8')
+ yield key, value
+ self._config_list_move_to_next(config_list_p)
+
+ """notmuch_database_set_config"""
+ _set_config = nmlib.notmuch_database_set_config
+ _set_config.argtypes = [NotmuchDatabaseP, c_char_p, c_char_p]
+ _set_config.restype = c_uint
+
+ def set_config(self, key, value):
+ """Set a config value in the notmuch database.
+
+ If an empty string is provided as `value` the `key` is unset!
+
+ :param key: the key to set
+ :type key: str
+ :param value: the value to store under `key`
+ :type value: str
+ :returns: None
+ :raises: :exc:`NotmuchError` in case of failure.
+
+ """
+ self._assert_db_is_initialized()
+ status = self._set_config(self._db, _str(key), _str(value))
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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.index_file` 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 "<notmuch Directory object '%s'>" % 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)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+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 publicly 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)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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 NotmuchMessagePropertiesS(Structure):
+ pass
+NotmuchMessagePropertiesP = POINTER(NotmuchMessagePropertiesS)
+
+
+class NotmuchTagsS(Structure):
+ pass
+NotmuchTagsP = POINTER(NotmuchTagsS)
+
+
+class NotmuchDirectoryS(Structure):
+ pass
+NotmuchDirectoryP = POINTER(NotmuchDirectoryS)
+
+
+class NotmuchFilenamesS(Structure):
+ pass
+NotmuchFilenamesP = POINTER(NotmuchFilenamesS)
+
+
+class NotmuchConfigListS(Structure):
+ pass
+NotmuchConfigListP = POINTER(NotmuchConfigListS)
+
+
+class NotmuchIndexoptsS(Structure):
+ pass
+NotmuchIndexoptsP = POINTER(NotmuchIndexoptsS)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+ Jesse Rosenthal <jrosenthal@jhu.edu>
+"""
+
+
+from ctypes import c_char_p, c_long, c_uint, c_int, POINTER, byref
+from datetime import date
+from .globals import (
+ nmlib,
+ Enum,
+ _str,
+ Python3StringMixIn,
+ NotmuchTagsP,
+ NotmuchMessageP,
+ NotmuchMessagesP,
+ NotmuchMessagePropertiesP,
+ NotmuchFilenamesP,
+)
+from .errors import (
+ STATUS,
+ NotmuchError,
+ NullPointerError,
+ NotInitializedError,
+)
+from .tag import Tags
+from .filenames import Filenames
+
+import email
+import sys
+
+
+class Message(Python3StringMixIn):
+ r"""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
+
+ """notmuch_message_get_property"""
+ _get_property = nmlib.notmuch_message_get_property
+ _get_property.argtypes = [NotmuchMessageP, c_char_p, POINTER(c_char_p)]
+ _get_property.restype = c_int
+
+ """notmuch_message_get_properties"""
+ _get_properties = nmlib.notmuch_message_get_properties
+ _get_properties.argtypes = [NotmuchMessageP, c_char_p, c_int]
+ _get_properties.restype = NotmuchMessagePropertiesP
+
+ """notmuch_message_properties_valid"""
+ _properties_valid = nmlib.notmuch_message_properties_valid
+ _properties_valid.argtypes = [NotmuchMessagePropertiesP]
+ _properties_valid.restype = bool
+
+ """notmuch_message_properties_value"""
+ _properties_value = nmlib.notmuch_message_properties_value
+ _properties_value.argtypes = [NotmuchMessagePropertiesP]
+ _properties_value.restype = c_char_p
+
+ """notmuch_message_properties_key"""
+ _properties_key = nmlib.notmuch_message_properties_key
+ _properties_key.argtypes = [NotmuchMessagePropertiesP]
+ _properties_key.restype = c_char_p
+
+ """notmuch_message_properties_move_to_next"""
+ _properties_move_to_next = nmlib.notmuch_message_properties_move_to_next
+ _properties_move_to_next.argtypes = [NotmuchMessagePropertiesP]
+ _properties_move_to_next.restype = None
+
+ #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 occurred
+ """
+ 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 occurred
+ """
+ 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 get_property(self, prop):
+ """ Retrieve the value for a single property key
+
+ :param prop: The name of the property to get.
+ :returns: String with the property value or None if there is no such
+ key. In the case of multiple values for the given key, the
+ first one is retrieved.
+ :raises: :exc:`NotInitializedError` if message has not been
+ initialized
+ """
+ if not self._msg:
+ raise NotInitializedError()
+
+ value = c_char_p()
+ status = Message._get_property(self._msg, _str(prop), byref(value))
+ if status != 0:
+ raise NotmuchError(status)
+
+ if value is None or value.value is None:
+ return None
+ return value.value.decode('utf-8')
+
+ def get_properties(self, prop="", exact=False):
+ """ Get the properties of the message, returning a generator of
+ name, value pairs.
+
+ The generator will yield once per value. There might be more than one
+ value on each name, so the generator might yield the same name several
+ times.
+
+ :param prop: The name of the property to get. Otherwise it will return
+ the full list of properties of the message.
+ :param exact: if True, require exact match with key. Otherwise
+ treat as prefix.
+ :yields: Each property values as a pair of `name, value`
+ :ytype: pairs of str
+ :raises: :exc:`NotInitializedError` if message has not been
+ initialized
+ """
+ if not self._msg:
+ raise NotInitializedError()
+
+ properties = Message._get_properties(self._msg, _str(prop), exact)
+ while Message._properties_valid(properties):
+ key = Message._properties_key(properties)
+ value = Message._properties_value(properties)
+ yield key.decode("utf-8"), value.decode("utf-8")
+ Message._properties_move_to_next(properties)
+
+ 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.index_file` 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(), 'rb')
+ if sys.version_info[0] < 3:
+ email_msg = email.message_from_file(fp)
+ else:
+ email_msg = email.message_from_binary_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)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+ Jesse Rosenthal <jrosenthal@jhu.edu>
+"""
+
+from .globals import (
+ nmlib,
+ NotmuchTagsP,
+ NotmuchMessageP,
+ NotmuchMessagesP,
+)
+from .errors import (
+ NullPointerError,
+ NotInitializedError,
+)
+from .tag import Tags
+from .message import Message
+
+class Messages(object):
+ r"""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 publicly 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__
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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
+ initialized.
+ """
+ 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.restype = 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.restype = 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"""
+ _search_threads = nmlib.notmuch_query_search_threads
+ _search_threads.argtypes = [NotmuchQueryP, POINTER(NotmuchThreadsP)]
+ _search_threads.restype = c_uint
+
+ def search_threads(self):
+ r"""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(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 = nmlib.notmuch_query_search_messages
+ _search_messages.argtypes = [NotmuchQueryP, POINTER(NotmuchMessagesP)]
+ _search_messages.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(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
+ _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
+ _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)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+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 publicly 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)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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 publicly 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 explicitly 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)
--- /dev/null
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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 publicly 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)
--- /dev/null
+# this file should be kept in sync with ../../../version
+__VERSION__ = '0.38.3'
+SOVERSION = '5'
--- /dev/null
+#!/usr/bin/env python3
+
+"""
+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 <https://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+"""
+
+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
+<https://notmuchmail.org>`_ 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 <https://notmuch.readthedocs.io/>`_.
+
+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',
+ )
projects / notmuch / commitdiff