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-user=<user>:: 202 Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser'; 203 if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'), 204 then authentication is not attempted. 205 206--smtp-debug=0|1:: 207 Enable (1) or disable (0) debug output. If enabled, SMTP 208 commands and replies will be printed. Useful to debug TLS 209 connection and authentication problems. 210 211Automating 212~~~~~~~~~~ 213 214--to-cmd=<command>:: 215 Specify a command to execute once per patch file which 216 should generate patch file specific "To:" entries. 217 Output of this command must be single email address per line. 218 Default is the value of 'sendemail.tocmd' configuration value. 219 220--cc-cmd=<command>:: 221 Specify a command to execute once per patch file which 222 should generate patch file specific "Cc:" entries. 223 Output of this command must be single email address per line. 224 Default is the value of 'sendemail.cccmd' configuration value. 225 226--[no-]chain-reply-to:: 227 If this is set, each email will be sent as a reply to the previous 228 email sent. If disabled with "--no-chain-reply-to", all emails after 229 the first will be sent as replies to the first email sent. When using 230 this, it is recommended that the first file given be an overview of the 231 entire patch series. Disabled by default, but the 'sendemail.chainreplyto' 232 configuration variable can be used to enable it. 233 234--identity=<identity>:: 235 A configuration identity. When given, causes values in the 236 'sendemail.<identity>' subsection to take precedence over 237 values in the 'sendemail' section. The default identity is 238 the value of 'sendemail.identity'. 239 240--[no-]signed-off-by-cc:: 241 If this is set, add emails found in Signed-off-by: or Cc: lines to the 242 cc list. Default is the value of 'sendemail.signedoffbycc' configuration 243 value; if that is unspecified, default to --signed-off-by-cc. 244 245--suppress-cc=<category>:: 246 Specify an additional category of recipients to suppress the 247 auto-cc of: 248+ 249-- 250- 'author' will avoid including the patch author 251- 'self' will avoid including the sender 252- 'cc' will avoid including anyone mentioned in Cc lines in the patch header 253 except for self (use 'self' for that). 254- 'bodycc' will avoid including anyone mentioned in Cc lines in the 255 patch body (commit message) except for self (use 'self' for that). 256- 'sob' will avoid including anyone mentioned in Signed-off-by lines except 257 for self (use 'self' for that). 258- 'cccmd' will avoid running the --cc-cmd. 259- 'body' is equivalent to 'sob' + 'bodycc' 260- 'all' will suppress all auto cc values. 261-- 262+ 263Default is the value of 'sendemail.suppresscc' configuration value; if 264that is unspecified, default to 'self' if --suppress-from is 265specified, as well as 'body' if --no-signed-off-cc is specified. 266 267--[no-]suppress-from:: 268 If this is set, do not add the From: address to the cc: list. 269 Default is the value of 'sendemail.suppressfrom' configuration 270 value; if that is unspecified, default to --no-suppress-from. 271 272--[no-]thread:: 273 If this is set, the In-Reply-To and References headers will be 274 added to each email sent. Whether each mail refers to the 275 previous email (`deep` threading per 'git format-patch' 276 wording) or to the first email (`shallow` threading) is 277 governed by "--[no-]chain-reply-to". 278+ 279If disabled with "--no-thread", those headers will not be added 280(unless specified with --in-reply-to). Default is the value of the 281'sendemail.thread' configuration value; if that is unspecified, 282default to --thread. 283+ 284It is up to the user to ensure that no In-Reply-To header already 285exists when 'git send-email' is asked to add it (especially note that 286'git format-patch' can be configured to do the threading itself). 287Failure to do so may not produce the expected result in the 288recipient's MUA. 289 290 291Administering 292~~~~~~~~~~~~~ 293 294--confirm=<mode>:: 295 Confirm just before sending: 296+ 297-- 298- 'always' will always confirm before sending 299- 'never' will never confirm before sending 300- 'cc' will confirm before sending when send-email has automatically 301 added addresses from the patch to the Cc list 302- 'compose' will confirm before sending the first message when using --compose. 303- 'auto' is equivalent to 'cc' + 'compose' 304-- 305+ 306Default is the value of 'sendemail.confirm' configuration value; if that 307is unspecified, default to 'auto' unless any of the suppress options 308have been specified, in which case default to 'compose'. 309 310--dry-run:: 311 Do everything except actually send the emails. 312 313--[no-]format-patch:: 314 When an argument may be understood either as a reference or as a file name, 315 choose to understand it as a format-patch argument ('--format-patch') 316 or as a file name ('--no-format-patch'). By default, when such a conflict 317 occurs, git send-email will fail. 318 319--quiet:: 320 Make git-send-email less verbose. One line per email should be 321 all that is output. 322 323--[no-]validate:: 324 Perform sanity checks on patches. 325 Currently, validation means the following: 326+ 327-- 328 * Warn of patches that contain lines longer than 998 characters; this 329 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt. 330-- 331+ 332Default is the value of 'sendemail.validate'; if this is not set, 333default to '--validate'. 334 335--force:: 336 Send emails even if safety checks would prevent it. 337 338 339CONFIGURATION 340------------- 341 342sendemail.aliasesfile:: 343 To avoid typing long email addresses, point this to one or more 344 email aliases files. You must also supply 'sendemail.aliasfiletype'. 345 346sendemail.aliasfiletype:: 347 Format of the file(s) specified in sendemail.aliasesfile. Must be 348 one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'. 349 350sendemail.multiedit:: 351 If true (default), a single editor instance will be spawned to edit 352 files you have to edit (patches when '--annotate' is used, and the 353 summary when '--compose' is used). If false, files will be edited one 354 after the other, spawning a new editor each time. 355 356sendemail.confirm:: 357 Sets the default for whether to confirm before sending. Must be 358 one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' 359 in the previous section for the meaning of these values. 360 361EXAMPLE 362------- 363Use gmail as the smtp server 364~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 365To use 'git send-email' to send your patches through the GMail SMTP server, 366edit ~/.gitconfig to specify your account settings: 367 368 [sendemail] 369 smtpencryption = tls 370 smtpserver = smtp.gmail.com 371 smtpuser = yourname@gmail.com 372 smtpserverport = 587 373 374Once your commits are ready to be sent to the mailing list, run the 375following commands: 376 377 $ git format-patch --cover-letter -M origin/master -o outgoing/ 378 $ edit outgoing/0000-* 379 $ git send-email outgoing/* 380 381Note: the following perl modules are required 382 Net::SMTP::SSL, MIME::Base64 and Authen::SASL 383 384SEE ALSO 385-------- 386linkgit:git-format-patch[1], linkgit:git-imap-send[1], mbox(5) 387 388GIT 389--- 390Part of the linkgit:git[1] suite