aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/message.rst
diff options
context:
space:
mode:
authorJustus Winter <4winter@informatik.uni-hamburg.de>2012-02-24 01:34:15 +0100
committerJustus Winter <4winter@informatik.uni-hamburg.de>2012-02-24 01:55:33 +0100
commitd50171d1cc575a41bf620c55853ade65d0edfad8 (patch)
tree495247d3b0f2ec1af08211330e6a9e8f8b428c7f /bindings/python/docs/source/message.rst
parent594dbb62432bd7f92d1e121145b80628eb8aad2a (diff)
python: split the documentation
Move each classes documentation into its own file and thus into its own page in the generated documentation. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings/python/docs/source/message.rst')
-rw-r--r--bindings/python/docs/source/message.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/bindings/python/docs/source/message.rst b/bindings/python/docs/source/message.rst
new file mode 100644
index 0000000..2ae280e
--- /dev/null
+++ b/bindings/python/docs/source/message.rst
@@ -0,0 +1,54 @@
+:class:`Message` -- A single message
+====================================
+
+.. currentmodule:: notmuch
+
+.. autoclass:: Message
+
+ .. automethod:: get_message_id
+
+ .. automethod:: get_thread_id
+
+ .. automethod:: get_replies
+
+ .. automethod:: get_filename
+
+ .. automethod:: get_filenames
+
+ .. attribute:: FLAG
+
+ FLAG.MATCH
+ This flag is automatically set by a
+ Query.search_threads on those messages that match the
+ query. This allows us to distinguish matches from the rest
+ of the messages in that thread.
+
+ .. automethod:: get_flag
+
+ .. automethod:: set_flag
+
+ .. automethod:: get_date
+
+ .. automethod:: get_header
+
+ .. automethod:: get_tags
+
+ .. automethod:: maildir_flags_to_tags
+
+ .. automethod:: tags_to_maildir_flags
+
+ .. automethod:: remove_tag
+
+ .. automethod:: add_tag
+
+ .. automethod:: remove_all_tags
+
+ .. automethod:: freeze
+
+ .. automethod:: thaw
+
+ .. automethod:: format_message_as_json
+
+ .. automethod:: format_message_as_text
+
+ .. automethod:: __str__