The eighth batch
[git/gitster.git] / Documentation / config / sendemail.txt
blob5ffcfc9f2a76f77db287d4913bda2c8b31a2834b
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`.
7 sendemail.smtpEncryption::
8         See linkgit:git-send-email[1] for description.  Note that this
9         setting is not subject to the 'identity' mechanism.
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.
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`.
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.
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.
33 sendemail.mailmap::
34         If true, makes linkgit:git-send-email[1] assume `--mailmap`,
35         otherwise assume `--no-mailmap`. False by default.
37 sendemail.mailmap.file::
38         The location of a linkgit:git-send-email[1] specific augmenting
39         mailmap file. The default mailmap and `mailmap.file` are loaded
40         first. Thus, entries in this file take precedence over entries in
41         the default mailmap locations. See linkgit:gitmailmap[5].
43 sendemail.mailmap.blob::
44         Like `sendemail.mailmap.file`, but consider the value as a reference
45         to a blob in the repository. Entries in `sendemail.mailmap.file`
46         take precedence over entries here. See linkgit:gitmailmap[5].
48 sendemail.aliasesFile::
49         To avoid typing long email addresses, point this to one or more
50         email aliases files.  You must also supply `sendemail.aliasFileType`.
52 sendemail.aliasFileType::
53         Format of the file(s) specified in sendemail.aliasesFile. Must be
54         one of 'mutt', 'mailrc', 'pine', 'elm', 'gnus', or 'sendmail'.
56 What an alias file in each format looks like can be found in
57 the documentation of the email program of the same name. The
58 differences and limitations from the standard formats are
59 described below:
62 sendmail;;
63 *       Quoted aliases and quoted addresses are not supported: lines that
64         contain a `"` symbol are ignored.
65 *       Redirection to a file (`/path/name`) or pipe (`|command`) is not
66         supported.
67 *       File inclusion (`:include: /path/name`) is not supported.
68 *       Warnings are printed on the standard error output for any
69         explicitly unsupported constructs, and any other lines that are not
70         recognized by the parser.
72 sendemail.annotate::
73 sendemail.bcc::
74 sendemail.cc::
75 sendemail.ccCmd::
76 sendemail.chainReplyTo::
77 sendemail.envelopeSender::
78 sendemail.from::
79 sendemail.headerCmd::
80 sendemail.signedOffByCc::
81 sendemail.smtpPass::
82 sendemail.suppressCc::
83 sendemail.suppressFrom::
84 sendemail.to::
85 sendemail.toCmd::
86 sendemail.smtpDomain::
87 sendemail.smtpServer::
88 sendemail.smtpServerPort::
89 sendemail.smtpServerOption::
90 sendemail.smtpUser::
91 sendemail.thread::
92 sendemail.transferEncoding::
93 sendemail.validate::
94 sendemail.xmailer::
95         These configuration variables all provide a default for
96         linkgit:git-send-email[1] command-line options. See its
97         documentation for details.
99 sendemail.signedOffCc (deprecated)::
100         Deprecated alias for `sendemail.signedOffByCc`.
102 sendemail.smtpBatchSize::
103         Number of messages to be sent per connection, after that a relogin
104         will happen.  If the value is 0 or undefined, send all messages in
105         one connection.
106         See also the `--batch-size` option of linkgit:git-send-email[1].
108 sendemail.smtpReloginDelay::
109         Seconds to wait before reconnecting to the smtp server.
110         See also the `--relogin-delay` option of linkgit:git-send-email[1].
112 sendemail.forbidSendmailVariables::
113         To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
114         will abort with a warning if any configuration options for "sendmail"
115         exist. Set this variable to bypass the check.