Merge branch 'hx/push-atomic-with-cert'
[git] / Documentation / config / imap.txt
1 imap.folder::
2         The folder to drop the mails into, which is typically the Drafts
3         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
4         "[Gmail]/Drafts". Required.
5
6 imap.tunnel::
7         Command used to setup a tunnel to the IMAP server through which
8         commands will be piped instead of using a direct network connection
9         to the server. Required when imap.host is not set.
10
11 imap.host::
12         A URL identifying the server. Use an `imap://` prefix for non-secure
13         connections and an `imaps://` prefix for secure connections.
14         Ignored when imap.tunnel is set, but required otherwise.
15
16 imap.user::
17         The username to use when logging in to the server.
18
19 imap.pass::
20         The password to use when logging in to the server.
21
22 imap.port::
23         An integer port number to connect to on the server.
24         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
25         Ignored when imap.tunnel is set.
26
27 imap.sslverify::
28         A boolean to enable/disable verification of the server certificate
29         used by the SSL/TLS connection. Default is `true`. Ignored when
30         imap.tunnel is set.
31
32 imap.preformattedHTML::
33         A boolean to enable/disable the use of html encoding when sending
34         a patch.  An html encoded patch will be bracketed with <pre>
35         and have a content type of text/html.  Ironically, enabling this
36         option causes Thunderbird to send the patch as a plain/text,
37         format=fixed email.  Default is `false`.
38
39 imap.authMethod::
40         Specify authenticate method for authentication with IMAP server.
41         If Git was built with the NO_CURL option, or if your curl version is older
42         than 7.34.0, or if you're running git-imap-send with the `--no-curl`
43         option, the only supported method is 'CRAM-MD5'. If this is not set
44         then 'git imap-send' uses the basic IMAP plaintext LOGIN command.