1git-send-email(1) 2================= 3 4NAME 5---- 6git-send-email - Send a collection of patches as emails 7 8 9SYNOPSIS 10-------- 11[verse] 12'git send-email' [options] <file|directory|rev-list options>... 13 14 15DESCRIPTION 16----------- 17Takes the patches given on the command line and emails them out. 18Patches can be specified as files, directories (which will send all 19files in the directory), or directly as a revision list. In the 20last case, any format accepted by linkgit:git-format-patch[1] can 21be passed to git send-email. 22 23The header of the email is configurable by command line options. If not 24specified on the command line, the user will be prompted with a ReadLine 25enabled interface to provide the necessary information. 26 27There are two formats accepted for patch files: 28 291. mbox format files 30+ 31This is what linkgit:git-format-patch[1] generates. Most headers and MIME 32formatting are ignored. 33 342. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl' 35script 36+ 37This format expects the first line of the file to contain the "Cc:" value 38and the "Subject:" of the message as the second line. 39 40 41OPTIONS 42------- 43 44Composing 45~~~~~~~~~ 46 47--annotate:: 48 Review and edit each patch you're about to send. Default is the value 49 of 'sendemail.annotate'. See the CONFIGURATION section for 50 'sendemail.multiedit'. 51 52--bcc=<address>:: 53 Specify a "Bcc:" value for each email. Default is the value of 54 'sendemail.bcc'. 55+ 56The --bcc option must be repeated for each user you want on the bcc list. 57 58--cc=<address>:: 59 Specify a starting "Cc:" value for each email. 60 Default is the value of 'sendemail.cc'. 61+ 62The --cc option must be repeated for each user you want on the cc list. 63 64--compose:: 65 Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1]) 66 to edit an introductory message for the patch series. 67+ 68When '--compose' is used, git send-email will use the From, Subject, and 69In-Reply-To headers specified in the message. If the body of the message 70(what you type after the headers and a blank line) only contains blank 71(or Git: prefixed) lines the summary won't be sent, but From, Subject, 72and In-Reply-To headers will be used unless they are removed. 73+ 74Missing From or In-Reply-To headers will be prompted for. 75+ 76See the CONFIGURATION section for 'sendemail.multiedit'. 77 78--from=<address>:: 79 Specify the sender of the emails. If not specified on the command line, 80 the value of the 'sendemail.from' configuration option is used. If 81 neither the command line option nor 'sendemail.from' are set, then the 82 user will be prompted for the value. The default for the prompt will be 83 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not 84 set, as returned by "git var -l". 85 86--in-reply-to=<identifier>:: 87 Make the first mail (or all the mails with `--no-thread`) appear as a 88 reply to the given Message-Id, which avoids breaking threads to 89 provide a new patch series. 90 The second and subsequent emails will be sent as replies according to 91 the `--[no]-chain-reply-to` setting. 92+ 93So for example when `--thread` and `--no-chain-reply-to` are specified, the 94second and subsequent patches will be replies to the first one like in the 95illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`: 96+ 97 [PATCH 0/2] Here is what I did... 98 [PATCH 1/2] Clean up and tests 99 [PATCH 2/2] Implementation 100 [PATCH v2 0/3] Here is a reroll 101 [PATCH v2 1/3] Clean up 102 [PATCH v2 2/3] New tests 103 [PATCH v2 3/3] Implementation 104+ 105Only necessary if --compose is also set. If --compose 106is not set, this will be prompted for. 107 108--subject=<string>:: 109 Specify the initial subject of the email thread. 110 Only necessary if --compose is also set. If --compose 111 is not set, this will be prompted for. 112 113--to=<address>:: 114 Specify the primary recipient of the emails generated. Generally, this 115 will be the upstream maintainer of the project involved. Default is the 116 value of the 'sendemail.to' configuration value; if that is unspecified, 117 and --to-cmd is not specified, this will be prompted for. 118+ 119The --to option must be repeated for each user you want on the to list. 120 121--8bit-encoding=<encoding>:: 122 When encountering a non-ASCII message or subject that does not 123 declare its encoding, add headers/quoting to indicate it is 124 encoded in <encoding>. Default is the value of the 125 'sendemail.assume8bitEncoding'; if that is unspecified, this 126 will be prompted for if any non-ASCII files are encountered. 127+ 128Note that no attempts whatsoever are made to validate the encoding. 129 130--compose-encoding=<encoding>:: 131 Specify encoding of compose message. Default is the value of the 132 'sendemail.composeencoding'; if that is unspecified, UTF-8 is assumed. 133 134 135Sending 136~~~~~~~ 137 138--envelope-sender=<address>:: 139 Specify the envelope sender used to send the emails. 140 This is useful if your default address is not the address that is 141 subscribed to a list. In order to use the 'From' address, set the 142 value to "auto". If you use the sendmail binary, you must have 143 suitable privileges for the -f parameter. Default is the value of the 144 'sendemail.envelopesender' configuration variable; if that is 145 unspecified, choosing the envelope sender is left to your MTA. 146 147--smtp-encryption=<encryption>:: 148 Specify the encryption to use, either 'ssl' or 'tls'. Any other 149 value reverts to plain SMTP. Default is the value of 150 'sendemail.smtpencryption'. 151 152--smtp-domain=<FQDN>:: 153 Specifies the Fully Qualified Domain Name (FQDN) used in the 154 HELO/EHLO command to the SMTP server. Some servers require the 155 FQDN to match your IP address. If not set, git send-email attempts 156 to determine your FQDN automatically. Default is the value of 157 'sendemail.smtpdomain'. 158 159--smtp-pass[=<password>]:: 160 Password for SMTP-AUTH. The argument is optional: If no 161 argument is specified, then the empty string is used as 162 the password. Default is the value of 'sendemail.smtppass', 163 however '--smtp-pass' always overrides this value. 164+ 165Furthermore, passwords need not be specified in configuration files 166or on the command line. If a username has been specified (with 167'--smtp-user' or a 'sendemail.smtpuser'), but no password has been 168specified (with '--smtp-pass' or 'sendemail.smtppass'), then 169a password is obtained using 'git-credential'. 170 171--smtp-server=<host>:: 172 If set, specifies the outgoing SMTP server to use (e.g. 173 `smtp.example.com` or a raw IP address). Alternatively it can 174 specify a full pathname of a sendmail-like program instead; 175 the program must support the `-i` option. Default value can 176 be specified by the 'sendemail.smtpserver' configuration 177 option; the built-in default is `/usr/sbin/sendmail` or 178 `/usr/lib/sendmail` if such program is available, or 179 `localhost` otherwise. 180 181--smtp-server-port=<port>:: 182 Specifies a port different from the default port (SMTP 183 servers typically listen to smtp port 25, but may also listen to 184 submission port 587, or the common SSL smtp port 465); 185 symbolic port names (e.g. "submission" instead of 587) 186 are also accepted. The port can also be set with the 187 'sendemail.smtpserverport' configuration variable. 188 189--smtp-server-option=<option>:: 190 If set, specifies the outgoing SMTP server option to use. 191 Default value can be specified by the 'sendemail.smtpserveroption' 192 configuration option. 193+ 194The --smtp-server-option option must be repeated for each option you want 195to pass to the server. Likewise, different lines in the configuration files 196must be used for each option. 197 198--smtp-ssl:: 199 Legacy alias for '--smtp-encryption ssl'. 200 201--smtp-ssl-cert-path:: 202 Path to a store of trusted CA certificates for SMTP SSL/TLS 203 certificate validation (either a directory that has been processed 204 by 'c_rehash', or a single file containing one or more PEM format 205 certificates concatenated together: see verify(1) -CAfile and 206 -CApath for more information on these). Set it to an empty string 207 to disable certificate verification. Defaults to the value of the 208 'sendemail.smtpsslcertpath' configuration variable, if set, or the 209 backing SSL library's compiled-in default otherwise (which should 210 be the best choice on most platforms). 211 212--smtp-user=<user>:: 213 Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser'; 214 if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'), 215 then authentication is not attempted. 216 217--smtp-debug=0|1:: 218 Enable (1) or disable (0) debug output. If enabled, SMTP 219 commands and replies will be printed. Useful to debug TLS 220 connection and authentication problems. 221 222Automating 223~~~~~~~~~~ 224 225--to-cmd=<command>:: 226 Specify a command to execute once per patch file which 227 should generate patch file specific "To:" entries. 228 Output of this command must be single email address per line. 229 Default is the value of 'sendemail.tocmd' configuration value. 230 231--cc-cmd=<command>:: 232 Specify a command to execute once per patch file which 233 should generate patch file specific "Cc:" entries. 234 Output of this command must be single email address per line. 235 Default is the value of 'sendemail.cccmd' configuration value. 236 237--[no-]chain-reply-to:: 238 If this is set, each email will be sent as a reply to the previous 239 email sent. If disabled with "--no-chain-reply-to", all emails after 240 the first will be sent as replies to the first email sent. When using 241 this, it is recommended that the first file given be an overview of the 242 entire patch series. Disabled by default, but the 'sendemail.chainreplyto' 243 configuration variable can be used to enable it. 244 245--identity=<identity>:: 246 A configuration identity. When given, causes values in the 247 'sendemail.<identity>' subsection to take precedence over 248 values in the 'sendemail' section. The default identity is 249 the value of 'sendemail.identity'. 250 251--[no-]signed-off-by-cc:: 252 If this is set, add emails found in Signed-off-by: or Cc: lines to the 253 cc list. Default is the value of 'sendemail.signedoffbycc' configuration 254 value; if that is unspecified, default to --signed-off-by-cc. 255 256--suppress-cc=<category>:: 257 Specify an additional category of recipients to suppress the 258 auto-cc of: 259+ 260-- 261- 'author' will avoid including the patch author 262- 'self' will avoid including the sender 263- 'cc' will avoid including anyone mentioned in Cc lines in the patch header 264 except for self (use 'self' for that). 265- 'bodycc' will avoid including anyone mentioned in Cc lines in the 266 patch body (commit message) except for self (use 'self' for that). 267- 'sob' will avoid including anyone mentioned in Signed-off-by lines except 268 for self (use 'self' for that). 269- 'cccmd' will avoid running the --cc-cmd. 270- 'body' is equivalent to 'sob' + 'bodycc' 271- 'all' will suppress all auto cc values. 272-- 273+ 274Default is the value of 'sendemail.suppresscc' configuration value; if 275that is unspecified, default to 'self' if --suppress-from is 276specified, as well as 'body' if --no-signed-off-cc is specified. 277 278--[no-]suppress-from:: 279 If this is set, do not add the From: address to the cc: list. 280 Default is the value of 'sendemail.suppressfrom' configuration 281 value; if that is unspecified, default to --no-suppress-from. 282 283--[no-]thread:: 284 If this is set, the In-Reply-To and References headers will be 285 added to each email sent. Whether each mail refers to the 286 previous email (`deep` threading per 'git format-patch' 287 wording) or to the first email (`shallow` threading) is 288 governed by "--[no-]chain-reply-to". 289+ 290If disabled with "--no-thread", those headers will not be added 291(unless specified with --in-reply-to). Default is the value of the 292'sendemail.thread' configuration value; if that is unspecified, 293default to --thread. 294+ 295It is up to the user to ensure that no In-Reply-To header already 296exists when 'git send-email' is asked to add it (especially note that 297'git format-patch' can be configured to do the threading itself). 298Failure to do so may not produce the expected result in the 299recipient's MUA. 300 301 302Administering 303~~~~~~~~~~~~~ 304 305--confirm=<mode>:: 306 Confirm just before sending: 307+ 308-- 309- 'always' will always confirm before sending 310- 'never' will never confirm before sending 311- 'cc' will confirm before sending when send-email has automatically 312 added addresses from the patch to the Cc list 313- 'compose' will confirm before sending the first message when using --compose. 314- 'auto' is equivalent to 'cc' + 'compose' 315-- 316+ 317Default is the value of 'sendemail.confirm' configuration value; if that 318is unspecified, default to 'auto' unless any of the suppress options 319have been specified, in which case default to 'compose'. 320 321--dry-run:: 322 Do everything except actually send the emails. 323 324--[no-]format-patch:: 325 When an argument may be understood either as a reference or as a file name, 326 choose to understand it as a format-patch argument ('--format-patch') 327 or as a file name ('--no-format-patch'). By default, when such a conflict 328 occurs, git send-email will fail. 329 330--quiet:: 331 Make git-send-email less verbose. One line per email should be 332 all that is output. 333 334--[no-]validate:: 335 Perform sanity checks on patches. 336 Currently, validation means the following: 337+ 338-- 339 * Warn of patches that contain lines longer than 998 characters; this 340 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt. 341-- 342+ 343Default is the value of 'sendemail.validate'; if this is not set, 344default to '--validate'. 345 346--force:: 347 Send emails even if safety checks would prevent it. 348 349 350CONFIGURATION 351------------- 352 353sendemail.aliasesfile:: 354 To avoid typing long email addresses, point this to one or more 355 email aliases files. You must also supply 'sendemail.aliasfiletype'. 356 357sendemail.aliasfiletype:: 358 Format of the file(s) specified in sendemail.aliasesfile. Must be 359 one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'. 360 361sendemail.multiedit:: 362 If true (default), a single editor instance will be spawned to edit 363 files you have to edit (patches when '--annotate' is used, and the 364 summary when '--compose' is used). If false, files will be edited one 365 after the other, spawning a new editor each time. 366 367sendemail.confirm:: 368 Sets the default for whether to confirm before sending. Must be 369 one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' 370 in the previous section for the meaning of these values. 371 372EXAMPLE 373------- 374Use gmail as the smtp server 375~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 376To use 'git send-email' to send your patches through the GMail SMTP server, 377edit ~/.gitconfig to specify your account settings: 378 379 [sendemail] 380 smtpencryption = tls 381 smtpserver = smtp.gmail.com 382 smtpuser = yourname@gmail.com 383 smtpserverport = 587 384 385Once your commits are ready to be sent to the mailing list, run the 386following commands: 387 388 $ git format-patch --cover-letter -M origin/master -o outgoing/ 389 $ edit outgoing/0000-* 390 $ git send-email outgoing/* 391 392Note: the following perl modules are required 393 Net::SMTP::SSL, MIME::Base64 and Authen::SASL 394 395SEE ALSO 396-------- 397linkgit:git-format-patch[1], linkgit:git-imap-send[1], mbox(5) 398 399GIT 400--- 401Part of the linkgit:git[1] suite