summaryrefslogtreecommitdiff
path: root/docs/source/api/settings.rst
blob: 05166f3fd4f9e718ca6e59fd1b9ad3a940af32c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
User Settings
=============

.. module:: alot.settings.manager

Alot sets up a :class:`SettingsManager` to access user settings
defined in different places uniformly.
There are four types of user settings:

+------------------------------------+----------------------------------+---------------------------------------------+
| what?                              | location                         | accessible via                              |
+====================================+==================================+=============================================+
| alot config                        | :file:`~/.config/alot/config`    | :meth:`SettingsManager.get`                 |
|                                    | or given by command option `-c`. |                                             |
+------------------------------------+----------------------------------+---------------------------------------------+
| hooks -- user provided python code | :file:`~/.config/alot/hooks.py`  | :meth:`SettingsManager.get_hook`            |
|                                    | or as given by the `hooksfile`   |                                             |
|                                    | config value                     |                                             |
+------------------------------------+----------------------------------+---------------------------------------------+
| notmuch config                     | :file:`~/.notmuch-config` or     | :meth:`SettingsManager.get_notmuch_setting` |
|                                    | given by `$NOTMUCH_CONFIG` or    |                                             |
|                                    | given by command option `-n`     |                                             |
+------------------------------------+----------------------------------+---------------------------------------------+
| mailcap -- defines shellcommands   | :file:`~/.mailcap`               | :meth:`SettingsManager.mailcap_find_match`  |
| to handle mime types               | (:file:`/etc/mailcap`)           |                                             |
+------------------------------------+----------------------------------+---------------------------------------------+


Settings Manager
----------------
.. autoclass:: SettingsManager
    :members:


Errors
------

.. automodule:: alot.settings.errors
    :members:

Utils
-----

.. automodule:: alot.settings.utils
    :members:

Themes
------
.. autoclass:: alot.settings.theme.Theme
    :members:

Accounts
--------

.. module:: alot.account

.. autoclass:: Address
    :members:
.. autoclass:: Account
    :members:
.. autoclass:: SendmailAccount
    :members:

Addressbooks
------------

.. module:: alot.addressbook

.. autoclass:: AddressBook
    :members:

.. module:: alot.addressbook.abook

.. autoclass:: AbookAddressBook
    :members:

.. module:: alot.addressbook.external

.. autoclass:: ExternalAddressbook