1git-send-email(1) 2================= 3 4NAME 5---- 6git-send-email - Send a collection of patches as emails 7 8 9SYNOPSIS 10-------- 11'git send-email' [options] <file|directory|rev-list options>... 12 13 14DESCRIPTION 15----------- 16Takes the patches given on the command line and emails them out. 17Patches can be specified as files, directories (which will send all 18files in the directory), or directly as a revision list. In the 19last case, any format accepted by linkgit:git-format-patch[1] can 20be passed to git send-email. 21 22The header of the email is configurable by command line options. If not 23specified on the command line, the user will be prompted with a ReadLine 24enabled interface to provide the necessary information. 25 26There are two formats accepted for patch files: 27 281. mbox format files 29+ 30This is what linkgit:git-format-patch[1] generates. Most headers and MIME 31formatting are ignored. 32 332. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl' 34script 35+ 36This format expects the first line of the file to contain the "Cc:" value 37and the "Subject:" of the message as the second line. 38 39 40OPTIONS 41------- 42 43Composing 44~~~~~~~~~ 45 46--annotate:: 47 Review and edit each patch you're about to send. See the 48 CONFIGURATION section for 'sendemail.multiedit'. 49 50--bcc=<address>:: 51 Specify a "Bcc:" value for each email. Default is the value of 52 'sendemail.bcc'. 53+ 54The --bcc option must be repeated for each user you want on the bcc list. 55 56--cc=<address>:: 57 Specify a starting "Cc:" value for each email. 58 Default is the value of 'sendemail.cc'. 59+ 60The --cc option must be repeated for each user you want on the cc list. 61 62--compose:: 63 Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1]) 64 to edit an introductory message for the patch series. 65+ 66When '--compose' is used, git send-email will use the From, Subject, and 67In-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, 70and In-Reply-To headers will be used unless they are removed. 71+ 72Missing From or In-Reply-To headers will be prompted for. 73+ 74See the CONFIGURATION section for 'sendemail.multiedit'. 75 76--from=<address>:: 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". 83 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. 90 91--subject=<string>:: 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. 95 96--to=<address>:: 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. 101+ 102The --to option must be repeated for each user you want on the to list. 103 104 105Sending 106~~~~~~~ 107 108--envelope-sender=<address>:: 109 Specify the envelope sender used to send the emails. 110 This is useful if your default address is not the address that is 111 subscribed to a list. In order to use the 'From' address, set the 112 value to "auto". If you use the sendmail binary, you must have 113 suitable privileges for the -f parameter. Default is the value of the 114 'sendemail.envelopesender' configuration variable; if that is 115 unspecified, choosing the envelope sender is left to your MTA. 116 117--smtp-encryption=<encryption>:: 118 Specify the encryption to use, either 'ssl' or 'tls'. Any other 119 value reverts to plain SMTP. Default is the value of 120 'sendemail.smtpencryption'. 121 122--smtp-domain=<FQDN>:: 123 Specifies the Fully Qualified Domain Name (FQDN) used in the 124 HELO/EHLO command to the SMTP server. Some servers require the 125 FQDN to match your IP address. If not set, git send-email attempts 126 to determine your FQDN automatically. Default is the value of 127 'sendemail.smtpdomain'. 128 129--smtp-pass[=<password>]:: 130 Password for SMTP-AUTH. The argument is optional: If no 131 argument is specified, then the empty string is used as 132 the password. Default is the value of 'sendemail.smtppass', 133 however '--smtp-pass' always overrides this value. 134+ 135Furthermore, passwords need not be specified in configuration files 136or on the command line. If a username has been specified (with 137'--smtp-user' or a 'sendemail.smtpuser'), but no password has been 138specified (with '--smtp-pass' or 'sendemail.smtppass'), then the 139user is prompted for a password while the input is masked for privacy. 140 141--smtp-server=<host>:: 142 If set, specifies the outgoing SMTP server to use (e.g. 143 `smtp.example.com` or a raw IP address). Alternatively it can 144 specify a full pathname of a sendmail-like program instead; 145 the program must support the `-i` option. Default value can 146 be specified by the 'sendemail.smtpserver' configuration 147 option; the built-in default is `/usr/sbin/sendmail` or 148 `/usr/lib/sendmail` if such program is available, or 149 `localhost` otherwise. 150 151--smtp-server-port=<port>:: 152 Specifies a port different from the default port (SMTP 153 servers typically listen to smtp port 25, but may also listen to 154 submission port 587, or the common SSL smtp port 465); 155 symbolic port names (e.g. "submission" instead of 587) 156 are also accepted. The port can also be set with the 157 'sendemail.smtpserverport' configuration variable. 158 159--smtp-ssl:: 160 Legacy alias for '--smtp-encryption ssl'. 161 162--smtp-user=<user>:: 163 Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser'; 164 if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'), 165 then authentication is not attempted. 166 167 168Automating 169~~~~~~~~~~ 170 171--cc-cmd=<command>:: 172 Specify a command to execute once per patch file which 173 should generate patch file specific "Cc:" entries. 174 Output of this command must be single email address per line. 175 Default is the value of 'sendemail.cccmd' configuration value. 176 177--[no-]chain-reply-to:: 178 If this is set, each email will be sent as a reply to the previous 179 email sent. If disabled with "--no-chain-reply-to", all emails after 180 the first will be sent as replies to the first email sent. When using 181 this, it is recommended that the first file given be an overview of the 182 entire patch series. Disabled by default, but the 'sendemail.chainreplyto' 183 configuration variable can be used to enable it. 184 185--identity=<identity>:: 186 A configuration identity. When given, causes values in the 187 'sendemail.<identity>' subsection to take precedence over 188 values in the 'sendemail' section. The default identity is 189 the value of 'sendemail.identity'. 190 191--[no-]signed-off-by-cc:: 192 If this is set, add emails found in Signed-off-by: or Cc: lines to the 193 cc list. Default is the value of 'sendemail.signedoffbycc' configuration 194 value; if that is unspecified, default to --signed-off-by-cc. 195 196--suppress-cc=<category>:: 197 Specify an additional category of recipients to suppress the 198 auto-cc of: 199+ 200-- 201- 'author' will avoid including the patch author 202- 'self' will avoid including the sender 203- 'cc' will avoid including anyone mentioned in Cc lines in the patch header 204 except for self (use 'self' for that). 205- 'bodycc' will avoid including anyone mentioned in Cc lines in the 206 patch body (commit message) except for self (use 'self' for that). 207- 'sob' will avoid including anyone mentioned in Signed-off-by lines except 208 for self (use 'self' for that). 209- 'cccmd' will avoid running the --cc-cmd. 210- 'body' is equivalent to 'sob' + 'bodycc' 211- 'all' will suppress all auto cc values. 212-- 213+ 214Default is the value of 'sendemail.suppresscc' configuration value; if 215that is unspecified, default to 'self' if --suppress-from is 216specified, as well as 'body' if --no-signed-off-cc is specified. 217 218--[no-]suppress-from:: 219 If this is set, do not add the From: address to the cc: list. 220 Default is the value of 'sendemail.suppressfrom' configuration 221 value; if that is unspecified, default to --no-suppress-from. 222 223--[no-]thread:: 224 If this is set, the In-Reply-To and References headers will be 225 added to each email sent. Whether each mail refers to the 226 previous email (`deep` threading per 'git format-patch' 227 wording) or to the first email (`shallow` threading) is 228 governed by "--[no-]chain-reply-to". 229+ 230If disabled with "--no-thread", those headers will not be added 231(unless specified with --in-reply-to). Default is the value of the 232'sendemail.thread' configuration value; if that is unspecified, 233default to --thread. 234+ 235It is up to the user to ensure that no In-Reply-To header already 236exists when 'git send-email' is asked to add it (especially note that 237'git format-patch' can be configured to do the threading itself). 238Failure to do so may not produce the expected result in the 239recipient's MUA. 240 241 242Administering 243~~~~~~~~~~~~~ 244 245--confirm=<mode>:: 246 Confirm just before sending: 247+ 248-- 249- 'always' will always confirm before sending 250- 'never' will never confirm before sending 251- 'cc' will confirm before sending when send-email has automatically 252 added addresses from the patch to the Cc list 253- 'compose' will confirm before sending the first message when using --compose. 254- 'auto' is equivalent to 'cc' + 'compose' 255-- 256+ 257Default is the value of 'sendemail.confirm' configuration value; if that 258is unspecified, default to 'auto' unless any of the suppress options 259have been specified, in which case default to 'compose'. 260 261--dry-run:: 262 Do everything except actually send the emails. 263 264--[no-]format-patch:: 265 When an argument may be understood either as a reference or as a file name, 266 choose to understand it as a format-patch argument ('--format-patch') 267 or as a file name ('--no-format-patch'). By default, when such a conflict 268 occurs, git send-email will fail. 269 270--quiet:: 271 Make git-send-email less verbose. One line per email should be 272 all that is output. 273 274--[no-]validate:: 275 Perform sanity checks on patches. 276 Currently, validation means the following: 277+ 278-- 279 * Warn of patches that contain lines longer than 998 characters; this 280 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt. 281-- 282+ 283Default is the value of 'sendemail.validate'; if this is not set, 284default to '--validate'. 285 286 287CONFIGURATION 288------------- 289 290sendemail.aliasesfile:: 291 To avoid typing long email addresses, point this to one or more 292 email aliases files. You must also supply 'sendemail.aliasfiletype'. 293 294sendemail.aliasfiletype:: 295 Format of the file(s) specified in sendemail.aliasesfile. Must be 296 one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'. 297 298sendemail.multiedit:: 299 If true (default), a single editor instance will be spawned to edit 300 files you have to edit (patches when '--annotate' is used, and the 301 summary when '--compose' is used). If false, files will be edited one 302 after the other, spawning a new editor each time. 303 304sendemail.confirm:: 305 Sets the default for whether to confirm before sending. Must be 306 one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' 307 in the previous section for the meaning of these values. 308 309 310Use gmail as the smtp server 311---------------------------- 312 313Add the following section to the config file: 314 315 [sendemail] 316 smtpencryption = tls 317 smtpserver = smtp.gmail.com 318 smtpuser = yourname@gmail.com 319 smtpserverport = 587 320 321Note: the following perl modules are required 322 Net::SMTP::SSL, MIME::Base64 and Authen::SASL 323 324 325Author 326------ 327Written by Ryan Anderson <ryan@michonline.com> 328 329git-send-email is originally based upon 330send_lots_of_email.pl by Greg Kroah-Hartman. 331 332 333Documentation 334-------------- 335Documentation by Ryan Anderson 336 337 338GIT 339--- 340Part of the linkgit:git[1] suite