summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--alot/crypto.py13
1 files changed, 8 insertions, 5 deletions
diff --git a/alot/crypto.py b/alot/crypto.py
index 2d67c115..4da32eea 100644
--- a/alot/crypto.py
+++ b/alot/crypto.py
@@ -134,11 +134,14 @@ def get_key(keyid, validate=False, encrypt=False, sign=False,
def list_keys(hint=None, private=False):
"""
- Returns a list of all keys containing keyid.
-
- :param keyid: The part we search for
- :param private: Whether secret keys are listed
- :rtype: list
+ Returns a iterator of all keys containing the fingerprint, or all keys if
+ hint is None.
+
+ :param hint: Part of a fingerprint to usee to search
+ :type hint: str or None
+ :param private: Whether to return public keys or secret keys
+ :type private: bool
+ :rtype: :class:`gpgme.KeyIter`
"""
ctx = gpgme.Context()
return ctx.keylist(hint, private)