]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/config/sendemail.txt
Merge branch 'mk/doc-gitfile-more' into maint-2.43
[thirdparty/git.git] / Documentation / config / sendemail.txt
1 sendemail.identity::
2 A configuration identity. When given, causes values in the
3 'sendemail.<identity>' subsection to take precedence over
4 values in the 'sendemail' section. The default identity is
5 the value of `sendemail.identity`.
6
7 sendemail.smtpEncryption::
8 See linkgit:git-send-email[1] for description. Note that this
9 setting is not subject to the 'identity' mechanism.
10
11 sendemail.smtpsslcertpath::
12 Path to ca-certificates (either a directory or a single file).
13 Set it to an empty string to disable certificate verification.
14
15 sendemail.<identity>.*::
16 Identity-specific versions of the 'sendemail.*' parameters
17 found below, taking precedence over those when this
18 identity is selected, through either the command-line or
19 `sendemail.identity`.
20
21 sendemail.multiEdit::
22 If true (default), a single editor instance will be spawned to edit
23 files you have to edit (patches when `--annotate` is used, and the
24 summary when `--compose` is used). If false, files will be edited one
25 after the other, spawning a new editor each time.
26
27 sendemail.confirm::
28 Sets the default for whether to confirm before sending. Must be
29 one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
30 in the linkgit:git-send-email[1] documentation for the meaning of these
31 values.
32
33 sendemail.aliasesFile::
34 To avoid typing long email addresses, point this to one or more
35 email aliases files. You must also supply `sendemail.aliasFileType`.
36
37 sendemail.aliasFileType::
38 Format of the file(s) specified in sendemail.aliasesFile. Must be
39 one of 'mutt', 'mailrc', 'pine', 'elm', 'gnus', or 'sendmail'.
40 +
41 What an alias file in each format looks like can be found in
42 the documentation of the email program of the same name. The
43 differences and limitations from the standard formats are
44 described below:
45 +
46 --
47 sendmail;;
48 * Quoted aliases and quoted addresses are not supported: lines that
49 contain a `"` symbol are ignored.
50 * Redirection to a file (`/path/name`) or pipe (`|command`) is not
51 supported.
52 * File inclusion (`:include: /path/name`) is not supported.
53 * Warnings are printed on the standard error output for any
54 explicitly unsupported constructs, and any other lines that are not
55 recognized by the parser.
56 --
57 sendemail.annotate::
58 sendemail.bcc::
59 sendemail.cc::
60 sendemail.ccCmd::
61 sendemail.chainReplyTo::
62 sendemail.envelopeSender::
63 sendemail.from::
64 sendemail.headerCmd::
65 sendemail.signedoffbycc::
66 sendemail.smtpPass::
67 sendemail.suppresscc::
68 sendemail.suppressFrom::
69 sendemail.to::
70 sendemail.tocmd::
71 sendemail.smtpDomain::
72 sendemail.smtpServer::
73 sendemail.smtpServerPort::
74 sendemail.smtpServerOption::
75 sendemail.smtpUser::
76 sendemail.thread::
77 sendemail.transferEncoding::
78 sendemail.validate::
79 sendemail.xmailer::
80 These configuration variables all provide a default for
81 linkgit:git-send-email[1] command-line options. See its
82 documentation for details.
83
84 sendemail.signedoffcc (deprecated)::
85 Deprecated alias for `sendemail.signedoffbycc`.
86
87 sendemail.smtpBatchSize::
88 Number of messages to be sent per connection, after that a relogin
89 will happen. If the value is 0 or undefined, send all messages in
90 one connection.
91 See also the `--batch-size` option of linkgit:git-send-email[1].
92
93 sendemail.smtpReloginDelay::
94 Seconds to wait before reconnecting to the smtp server.
95 See also the `--relogin-delay` option of linkgit:git-send-email[1].
96
97 sendemail.forbidSendmailVariables::
98 To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
99 will abort with a warning if any configuration options for "sendmail"
100 exist. Set this variable to bypass the check.