6 git-send-email - Send a collection of patches as emails
11 'git send-email' [options] <file|directory|rev-list options>...
16 Takes the patches given on the command line and emails them out.
18 The header of the email is configurable by command line options. If not
19 specified on the command line, the user will be prompted with a ReadLine
20 enabled interface to provide the necessary information.
22 There are two formats accepted for patch files:
26 This is what linkgit:git-format-patch[1] generates. Most headers and MIME
27 formatting are ignored.
29 2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
32 This format expects the first line of the file to contain the "Cc:" value
33 and the "Subject:" of the message as the second line.
43 Specify a "Bcc:" value for each email. Default is the value of
46 The --bcc option must be repeated for each user you want on the bcc list.
49 Specify a starting "Cc:" value for each email.
50 Default is the value of 'sendemail.cc'.
52 The --cc option must be repeated for each user you want on the cc list.
55 Review each patch you're about to send in an editor. The setting
56 'sendemail.multiedit' defines if this will spawn one editor per patch
57 or one for all of them at once.
60 Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
61 introductory message for the patch series.
63 When '--compose' is used, git send-email will use the From, Subject, and
64 In-Reply-To headers specified in the message. If the body of the message
65 (what you type after the headers and a blank line) only contains blank
66 (or GIT: prefixed) lines the summary won't be sent, but From, Subject,
67 and In-Reply-To headers will be used unless they are removed.
69 Missing From or In-Reply-To headers will be prompted for.
72 Specify the sender of the emails. If not specified on the command line,
73 the value of the 'sendemail.from' configuration option is used. If
74 neither the command line option nor 'sendemail.from' are set, then the
75 user will be prompted for the value. The default for the prompt will be
76 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
77 set, as returned by "git var -l".
79 --in-reply-to=<identifier>::
80 Specify the contents of the first In-Reply-To header.
81 Subsequent emails will refer to the previous email
82 instead of this if --chain-reply-to is set (the default)
83 Only necessary if --compose is also set. If --compose
84 is not set, this will be prompted for.
87 Specify the initial subject of the email thread.
88 Only necessary if --compose is also set. If --compose
89 is not set, this will be prompted for.
92 Specify the primary recipient of the emails generated. Generally, this
93 will be the upstream maintainer of the project involved. Default is the
94 value of the 'sendemail.to' configuration value; if that is unspecified,
95 this will be prompted for.
97 The --to option must be repeated for each user you want on the to list.
103 --envelope-sender=<address>::
104 Specify the envelope sender used to send the emails.
105 This is useful if your default address is not the address that is
106 subscribed to a list. If you use the sendmail binary, you must have
107 suitable privileges for the -f parameter. Default is the value of
108 the 'sendemail.envelopesender' configuration variable; if that is
109 unspecified, choosing the envelope sender is left to your MTA.
111 --smtp-encryption=<encryption>::
112 Specify the encryption to use, either 'ssl' or 'tls'. Any other
113 value reverts to plain SMTP. Default is the value of
114 'sendemail.smtpencryption'.
116 --smtp-pass[=<password>]::
117 Password for SMTP-AUTH. The argument is optional: If no
118 argument is specified, then the empty string is used as
119 the password. Default is the value of 'sendemail.smtppass',
120 however '--smtp-pass' always overrides this value.
122 Furthermore, passwords need not be specified in configuration files
123 or on the command line. If a username has been specified (with
124 '--smtp-user' or a 'sendemail.smtpuser'), but no password has been
125 specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
126 user is prompted for a password while the input is masked for privacy.
128 --smtp-server=<host>::
129 If set, specifies the outgoing SMTP server to use (e.g.
130 `smtp.example.com` or a raw IP address). Alternatively it can
131 specify a full pathname of a sendmail-like program instead;
132 the program must support the `-i` option. Default value can
133 be specified by the 'sendemail.smtpserver' configuration
134 option; the built-in default is `/usr/sbin/sendmail` or
135 `/usr/lib/sendmail` if such program is available, or
136 `localhost` otherwise.
138 --smtp-server-port=<port>::
139 Specifies a port different from the default port (SMTP
140 servers typically listen to smtp port 25 and ssmtp port
141 465). This can be set with 'sendemail.smtpserverport'.
144 Legacy alias for '--smtp-encryption ssl'.
147 Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
148 if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
149 then authentication is not attempted.
156 Specify a command to execute once per patch file which
157 should generate patch file specific "Cc:" entries.
158 Output of this command must be single email address per line.
159 Default is the value of 'sendemail.cccmd' configuration value.
161 --[no-]chain-reply-to=<identifier>::
162 If this is set, each email will be sent as a reply to the previous
163 email sent. If disabled with "--no-chain-reply-to", all emails after
164 the first will be sent as replies to the first email sent. When using
165 this, it is recommended that the first file given be an overview of the
166 entire patch series. Default is the value of the 'sendemail.chainreplyto'
167 configuration value; if that is unspecified, default to --chain-reply-to.
169 --identity=<identity>::
170 A configuration identity. When given, causes values in the
171 'sendemail.<identity>' subsection to take precedence over
172 values in the 'sendemail' section. The default identity is
173 the value of 'sendemail.identity'.
175 --[no-]signed-off-by-cc::
176 If this is set, add emails found in Signed-off-by: or Cc: lines to the
177 cc list. Default is the value of 'sendemail.signedoffbycc' configuration
178 value; if that is unspecified, default to --signed-off-by-cc.
180 --suppress-cc=<category>::
181 Specify an additional category of recipients to suppress the
185 - 'author' will avoid including the patch author
186 - 'self' will avoid including the sender
187 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
188 except for self (use 'self' for that).
189 - 'ccbody' will avoid including anyone mentioned in Cc lines in the
190 patch body (commit message) except for self (use 'self' for that).
191 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
192 for self (use 'self' for that).
193 - 'cccmd' will avoid running the --cc-cmd.
194 - 'body' is equivalent to 'sob' + 'ccbody'
195 - 'all' will suppress all auto cc values.
198 Default is the value of 'sendemail.suppresscc' configuration value; if
199 that is unspecified, default to 'self' if --suppress-from is
200 specified, as well as 'body' if --no-signed-off-cc is specified.
202 --[no-]suppress-from::
203 If this is set, do not add the From: address to the cc: list.
204 Default is the value of 'sendemail.suppressfrom' configuration
205 value; if that is unspecified, default to --no-suppress-from.
208 If this is set, the In-Reply-To header will be set on each email sent.
209 If disabled with "--no-thread", no emails will have the In-Reply-To
210 header set. Default is the value of the 'sendemail.thread' configuration
211 value; if that is unspecified, default to --thread.
218 Confirm just before sending:
221 - 'always' will always confirm before sending
222 - 'never' will never confirm before sending
223 - 'cc' will confirm before sending when send-email has automatically
224 added addresses from the patch to the Cc list
225 - 'compose' will confirm before sending the first message when using --compose.
226 - 'auto' is equivalent to 'cc' + 'compose'
229 Default is the value of 'sendemail.confirm' configuration value; if that
230 is unspecified, default to 'auto' unless any of the suppress options
231 have been specified, in which case default to 'compose'.
234 Do everything except actually send the emails.
237 Make git-send-email less verbose. One line per email should be
241 Perform sanity checks on patches.
242 Currently, validation means the following:
245 * Warn of patches that contain lines longer than 998 characters; this
246 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
249 Default is the value of 'sendemail.validate'; if this is not set,
250 default to '--validate'.
252 --[no-]format-patch::
253 When an argument may be understood either as a reference or as a file name,
254 choose to understand it as a format-patch argument ('--format-patch')
255 or as a file name ('--no-format-patch'). By default, when such a conflict
256 occurs, git send-email will fail.
262 sendemail.aliasesfile::
263 To avoid typing long email addresses, point this to one or more
264 email aliases files. You must also supply 'sendemail.aliasfiletype'.
266 sendemail.aliasfiletype::
267 Format of the file(s) specified in sendemail.aliasesfile. Must be
268 one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'.
270 sendemail.multiedit::
271 If true (default), a single editor instance will be spawned to edit
272 files you have to edit (patches when '--annotate' is used, and the
273 summary when '--compose' is used). If false, files will be edited one
274 after the other, spawning a new editor each time.
277 Sets the default for whether to confirm before sending. Must be
278 one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
279 in the previous section for the meaning of these values.
284 Written by Ryan Anderson <ryan@michonline.com>
286 git-send-email is originally based upon
287 send_lots_of_email.pl by Greg Kroah-Hartman.
292 Documentation by Ryan Anderson
297 Part of the linkgit:git[1] suite