pybitmessage.helper_search module¶
Additional SQL helper for searching messages.
Used by bitmessageqt
.
-
search_sql
(xAddress='toaddress', account=None, folder='inbox', where=None, what=None, unreadOnly=False)[source]¶ Search for messages from given account and folder having search term in one of it’s fields.
Parameters: - xAddress (str) – address field checked (‘fromaddress’, ‘toaddress’ or ‘both’)
- account (
bitmessageqt.account.BMAccount
instance) – the account which is checked - folder (str) – the folder which is checked
- where (str) – message field which is checked (‘toaddress’, ‘fromaddress’, ‘subject’ or ‘message’), by default check any field
- what (str) – the search term
- unreadOnly (bool) – if True, search only for unread messages
Returns: all messages where <where> field contains <what>
Return type: list[list]