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.
17 Patches can be specified as files, directories (which will send all
18 files in the directory), or directly as a revision list. In the
19 last case, any format accepted by linkgit:git-format-patch[1] can
20 be passed to git send-email.
22 The header of the email is configurable by command line options. If not
23 specified on the command line, the user will be prompted with a ReadLine
24 enabled interface to provide the necessary information.
26 There are two formats accepted for patch files:
30 This is what linkgit:git-format-patch[1] generates. Most headers and MIME
31 formatting are ignored.
33 2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
36 This format expects the first line of the file to contain the "Cc:" value
37 and the "Subject:" of the message as the second line.
47 Review and edit each patch you're about to send. See the
48 CONFIGURATION section for 'sendemail.multiedit'.
51 Specify a "Bcc:" value for each email. Default is the value of
54 The --bcc option must be repeated for each user you want on the bcc list.
57 Specify a starting "Cc:" value for each email.
58 Default is the value of 'sendemail.cc'.
60 The --cc option must be repeated for each user you want on the cc list.
63 Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
64 to edit an introductory message for the patch series.
66 When '--compose' is used, git send-email will use the From, Subject, and
67 In-Reply-To headers specified in the message. If the body of the message
68 (what you type after the headers and a blank line) only contains blank
69 (or GIT: prefixed) lines the summary won't be sent, but From, Subject,
70 and In-Reply-To headers will be used unless they are removed.
72 Missing From or In-Reply-To headers will be prompted for.
74 See the CONFIGURATION section for 'sendemail.multiedit'.
77 Specify the sender of the emails. If not specified on the command line,
78 the value of the 'sendemail.from' configuration option is used. If
79 neither the command line option nor 'sendemail.from' are set, then the
80 user will be prompted for the value. The default for the prompt will be
81 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
82 set, as returned by "git var -l".
84 --in-reply-to=<identifier>::
85 Specify the contents of the first In-Reply-To header.
86 Subsequent emails will refer to the previous email
87 instead of this if --chain-reply-to is set.
88 Only necessary if --compose is also set. If --compose
89 is not set, this will be prompted for.
92 Specify the initial subject of the email thread.
93 Only necessary if --compose is also set. If --compose
94 is not set, this will be prompted for.
97 Specify the primary recipient of the emails generated. Generally, this
98 will be the upstream maintainer of the project involved. Default is the
99 value of the 'sendemail.to' configuration value; if that is unspecified,
100 this will be prompted for.
102 The --to option must be repeated for each user you want on the to list.
104 --8bit-encoding=<encoding>::
105 When encountering a non-ASCII message or subject that does not
106 declare its encoding, add headers/quoting to indicate it is
107 encoded in <encoding>. Default is the value of the
108 'sendemail.assume8bitEncoding'; if that is unspecified, this
109 will be prompted for if any non-ASCII files are encountered.
111 Note that no attempts whatsoever are made to validate the encoding.
117 --envelope-sender=<address>::
118 Specify the envelope sender used to send the emails.
119 This is useful if your default address is not the address that is
120 subscribed to a list. In order to use the 'From' address, set the
121 value to "auto". If you use the sendmail binary, you must have
122 suitable privileges for the -f parameter. Default is the value of the
123 'sendemail.envelopesender' configuration variable; if that is
124 unspecified, choosing the envelope sender is left to your MTA.
126 --smtp-encryption=<encryption>::
127 Specify the encryption to use, either 'ssl' or 'tls'. Any other
128 value reverts to plain SMTP. Default is the value of
129 'sendemail.smtpencryption'.
131 --smtp-pass[=<password>]::
132 Password for SMTP-AUTH. The argument is optional: If no
133 argument is specified, then the empty string is used as
134 the password. Default is the value of 'sendemail.smtppass',
135 however '--smtp-pass' always overrides this value.
137 Furthermore, passwords need not be specified in configuration files
138 or on the command line. If a username has been specified (with
139 '--smtp-user' or a 'sendemail.smtpuser'), but no password has been
140 specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
141 user is prompted for a password while the input is masked for privacy.
143 --smtp-server=<host>::
144 If set, specifies the outgoing SMTP server to use (e.g.
145 `smtp.example.com` or a raw IP address). Alternatively it can
146 specify a full pathname of a sendmail-like program instead;
147 the program must support the `-i` option. Default value can
148 be specified by the 'sendemail.smtpserver' configuration
149 option; the built-in default is `/usr/sbin/sendmail` or
150 `/usr/lib/sendmail` if such program is available, or
151 `localhost` otherwise.
153 --smtp-server-port=<port>::
154 Specifies a port different from the default port (SMTP
155 servers typically listen to smtp port 25, but may also listen to
156 submission port 587, or the common SSL smtp port 465);
157 symbolic port names (e.g. "submission" instead of 587)
158 are also accepted. The port can also be set with the
159 'sendemail.smtpserverport' configuration variable.
162 Legacy alias for '--smtp-encryption ssl'.
165 Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
166 if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
167 then authentication is not attempted.
174 Specify a command to execute once per patch file which
175 should generate patch file specific "Cc:" entries.
176 Output of this command must be single email address per line.
177 Default is the value of 'sendemail.cccmd' configuration value.
179 --[no-]chain-reply-to::
180 If this is set, each email will be sent as a reply to the previous
181 email sent. If disabled with "--no-chain-reply-to", all emails after
182 the first will be sent as replies to the first email sent. When using
183 this, it is recommended that the first file given be an overview of the
184 entire patch series. Disabled by default, but the 'sendemail.chainreplyto'
185 configuration variable can be used to enable it.
187 --identity=<identity>::
188 A configuration identity. When given, causes values in the
189 'sendemail.<identity>' subsection to take precedence over
190 values in the 'sendemail' section. The default identity is
191 the value of 'sendemail.identity'.
193 --[no-]signed-off-by-cc::
194 If this is set, add emails found in Signed-off-by: or Cc: lines to the
195 cc list. Default is the value of 'sendemail.signedoffbycc' configuration
196 value; if that is unspecified, default to --signed-off-by-cc.
198 --suppress-cc=<category>::
199 Specify an additional category of recipients to suppress the
203 - 'author' will avoid including the patch author
204 - 'self' will avoid including the sender
205 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
206 except for self (use 'self' for that).
207 - 'bodycc' will avoid including anyone mentioned in Cc lines in the
208 patch body (commit message) except for self (use 'self' for that).
209 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
210 for self (use 'self' for that).
211 - 'cccmd' will avoid running the --cc-cmd.
212 - 'body' is equivalent to 'sob' + 'bodycc'
213 - 'all' will suppress all auto cc values.
216 Default is the value of 'sendemail.suppresscc' configuration value; if
217 that is unspecified, default to 'self' if --suppress-from is
218 specified, as well as 'body' if --no-signed-off-cc is specified.
220 --[no-]suppress-from::
221 If this is set, do not add the From: address to the cc: list.
222 Default is the value of 'sendemail.suppressfrom' configuration
223 value; if that is unspecified, default to --no-suppress-from.
226 If this is set, the In-Reply-To and References headers will be
227 added to each email sent. Whether each mail refers to the
228 previous email (`deep` threading per 'git format-patch'
229 wording) or to the first email (`shallow` threading) is
230 governed by "--[no-]chain-reply-to".
232 If disabled with "--no-thread", those headers will not be added
233 (unless specified with --in-reply-to). Default is the value of the
234 'sendemail.thread' configuration value; if that is unspecified,
237 It is up to the user to ensure that no In-Reply-To header already
238 exists when 'git send-email' is asked to add it (especially note that
239 'git format-patch' can be configured to do the threading itself).
240 Failure to do so may not produce the expected result in the
248 Confirm just before sending:
251 - 'always' will always confirm before sending
252 - 'never' will never confirm before sending
253 - 'cc' will confirm before sending when send-email has automatically
254 added addresses from the patch to the Cc list
255 - 'compose' will confirm before sending the first message when using --compose.
256 - 'auto' is equivalent to 'cc' + 'compose'
259 Default is the value of 'sendemail.confirm' configuration value; if that
260 is unspecified, default to 'auto' unless any of the suppress options
261 have been specified, in which case default to 'compose'.
264 Do everything except actually send the emails.
266 --[no-]format-patch::
267 When an argument may be understood either as a reference or as a file name,
268 choose to understand it as a format-patch argument ('--format-patch')
269 or as a file name ('--no-format-patch'). By default, when such a conflict
270 occurs, git send-email will fail.
273 Make git-send-email less verbose. One line per email should be
277 Perform sanity checks on patches.
278 Currently, validation means the following:
281 * Warn of patches that contain lines longer than 998 characters; this
282 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
285 Default is the value of 'sendemail.validate'; if this is not set,
286 default to '--validate'.
292 sendemail.aliasesfile::
293 To avoid typing long email addresses, point this to one or more
294 email aliases files. You must also supply 'sendemail.aliasfiletype'.
296 sendemail.aliasfiletype::
297 Format of the file(s) specified in sendemail.aliasesfile. Must be
298 one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'.
300 sendemail.multiedit::
301 If true (default), a single editor instance will be spawned to edit
302 files you have to edit (patches when '--annotate' is used, and the
303 summary when '--compose' is used). If false, files will be edited one
304 after the other, spawning a new editor each time.
307 Sets the default for whether to confirm before sending. Must be
308 one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
309 in the previous section for the meaning of these values.
312 Use gmail as the smtp server
313 ----------------------------
315 Add the following section to the config file:
319 smtpserver = smtp.gmail.com
320 smtpuser = yourname@gmail.com
323 Note: the following perl modules are required
324 Net::SMTP::SSL, MIME::Base64 and Authen::SASL
329 Written by Ryan Anderson <ryan@michonline.com>
331 git-send-email is originally based upon
332 send_lots_of_email.pl by Greg Kroah-Hartman.
337 Documentation by Ryan Anderson
342 Part of the linkgit:git[1] suite