Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

deploy: 5cd5a1b585

Browse source
This commit is contained in:
rycee 2023-04-22 15:12:40 +00:00
parent 2907b78f2b
commit 55a2abcefc
1 changed files with 35 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
options.html
View file

@ -41,15 +41,47 @@ See aerc-config(5).</p><p><span class="emphasis"><em>Type:</em></span> attribute
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.extraBinds"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.extraBinds"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.extraBinds</code></a></span></dt><dd><p>Extra bindings specific to this account, added to
<code class="filename">$HOME/.config/aerc/accounts.conf</code>.
See aerc-config(5).</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">{ messages = { d = ":move ${folder.trash}&lt;Enter&gt;"; }; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
See <span class="citerefentry"><span class="refentrytitle">aerc-config</span>(5)</span>.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">{ messages = { d = ":move ${folder.trash}&lt;Enter&gt;"; }; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.extraConfig"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.extraConfig</code></a></span></dt><dd><p>Extra config specific to this account, added to
<code class="filename">$HOME/.config/aerc/aerc.conf</code>.
See aerc-config(5).</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">{ ui = { sidebar-width = 42; }; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
See <span class="citerefentry"><span class="refentrytitle">aerc-config</span>(5)</span>.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">{ ui = { sidebar-width = 42; }; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.imapAuth"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.imapAuth"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.imapAuth</code></a></span></dt><dd><p>Sets the authentication mechanism if imap is used as the incoming
method.
See <span class="citerefentry"><span class="refentrytitle">aerc-imap</span>(5)</span>.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "oauthbearer", "xoauth2"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"auth"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.imapOauth2Params"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.imapOauth2Params"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.imapOauth2Params</code></a></span></dt><dd><p>Sets the oauth2 params if authentication mechanism oauthbearer or
xoauth2 is used.
See <span class="citerefentry"><span class="refentrytitle">aerc-imap</span>(5)</span>.</p><p><span class="emphasis"><em>Type:</em></span> null or (submodule)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
token_endpoint = "&lt;token_endpoint&gt;";
}</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.imapOauth2Params.client_id"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.imapOauth2Params.client_id"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.imapOauth2Params.client_id</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.imapOauth2Params.client_secret"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.imapOauth2Params.client_secret"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.imapOauth2Params.client_secret</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.imapOauth2Params.scope"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.imapOauth2Params.scope"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.imapOauth2Params.scope</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.imapOauth2Params.token_endpoint"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.imapOauth2Params.token_endpoint"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.imapOauth2Params.token_endpoint</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.smtpAuth"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.smtpAuth"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.smtpAuth</code></a></span></dt><dd><p>Sets the authentication mechanism if smtp is used as the outgoing
method.
See aerc-smtp(5).</p><p><span class="emphasis"><em>Type:</em></span> null or one of "none", "plain", "login", "oauthbearer", "xoauth2"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"plain"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"auth"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
See <span class="citerefentry"><span class="refentrytitle">aerc-smtp</span>(5)</span>.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "none", "plain", "login", "oauthbearer", "xoauth2"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"plain"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"auth"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.smtpOauth2Params"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.smtpOauth2Params"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.smtpOauth2Params</code></a></span></dt><dd><p>Sets the oauth2 params if authentication mechanism oauthbearer or
xoauth2 is used.
See <span class="citerefentry"><span class="refentrytitle">aerc-imap</span>(5)</span>.</p><p><span class="emphasis"><em>Type:</em></span> null or (submodule)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
token_endpoint = "&lt;token_endpoint&gt;";
}</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.client_id"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.client_id"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.smtpOauth2Params.client_id</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.client_secret"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.client_secret"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.smtpOauth2Params.client_secret</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.scope"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.scope"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.smtpOauth2Params.scope</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.token_endpoint"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aerc.smtpOauth2Params.token_endpoint"><code class="option">accounts.email.accounts.&lt;name&gt;.aerc.smtpOauth2Params.token_endpoint</code></a></span></dt><dd><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aerc.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/aerc.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aliases"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aliases"><code class="option">accounts.email.accounts.&lt;name&gt;.aliases</code></a></span></dt><dd><p>Alternative email addresses of this account.</p><p><span class="emphasis"><em>Type:</em></span> list of string matching the pattern .*@.*</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
"webmaster@example.org"