Documentation/git-send-email.txt

   1 git-send-email(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-send-email - Send a collection of patches as emails
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git send-email' [options] <file|directory|rev-list options>...
  13
  14
  15 DESCRIPTION
  16 -----------
  17 Takes the patches given on the command line and emails them out.
  18 Patches can be specified as files, directories (which will send all
  19 files in the directory), or directly as a revision list.  In the
  20 last case, any format accepted by linkgit:git-format-patch[1] can
  21 be passed to git send-email.
  22
  23 The header of the email is configurable via command-line options.  If not
  24 specified on the command line, the user will be prompted with a ReadLine
  25 enabled interface to provide the necessary information.
  26
  27 There are two formats accepted for patch files:
  28
  29 1. mbox format files
  30 +
  31 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
  32 formatting are ignored.
  33
  34 2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
  35 script
  36 +
  37 This format expects the first line of the file to contain the "Cc:" value
  38 and the "Subject:" of the message as the second line.
  39
  40
  41 OPTIONS
  42 -------
  43
  44 Composing
  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 +
  56 This option may be specified multiple times.
  57
  58 --cc=<address>,...::
  59         Specify a starting "Cc:" value for each email.
  60         Default is the value of 'sendemail.cc'.
  61 +
  62 This option may be specified multiple times.
  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 +
  68 When '--compose' is used, git send-email will use the From, Subject, and
  69 In-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,
  72 and In-Reply-To headers will be used unless they are removed.
  73 +
  74 Missing From or In-Reply-To headers will be prompted for.
  75 +
  76 See 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 +
  93 So for example when `--thread` and `--no-chain-reply-to` are specified, the
  94 second and subsequent patches will be replies to the first one like in the
  95 illustration 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 +
 105 Only necessary if --compose is also set.  If --compose
 106 is 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 +
 119 This option may be specified multiple times.
 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 +
 128 Note 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 --transfer-encoding=(7bit|8bit|quoted-printable|base64)::
 135         Specify the transfer encoding to be used to send the message over SMTP.
 136         7bit will fail upon encountering a non-ASCII message.  quoted-printable
 137         can be useful when the repository contains files that contain carriage
 138         returns, but makes the raw patch email file (as saved from a MUA) much
 139         harder to inspect manually.  base64 is even more fool proof, but also
 140         even more opaque.  Default is the value of the 'sendemail.transferEncoding'
 141         configuration value; if that is unspecified, git will use 8bit and not
 142         add a Content-Transfer-Encoding header.
 143
 144 --xmailer::
 145 --no-xmailer::
 146         Add (or prevent adding) the "X-Mailer:" header.  By default,
 147         the header is added, but it can be turned off by setting the
 148         `sendemail.xmailer` configuration variable to `false`.
 149
 150 Sending
 151 ~~~~~~~
 152
 153 --envelope-sender=<address>::
 154         Specify the envelope sender used to send the emails.
 155         This is useful if your default address is not the address that is
 156         subscribed to a list. In order to use the 'From' address, set the
 157         value to "auto". If you use the sendmail binary, you must have
 158         suitable privileges for the -f parameter.  Default is the value of the
 159         'sendemail.envelopeSender' configuration variable; if that is
 160         unspecified, choosing the envelope sender is left to your MTA.
 161
 162 --smtp-encryption=<encryption>::
 163         Specify the encryption to use, either 'ssl' or 'tls'.  Any other
 164         value reverts to plain SMTP.  Default is the value of
 165         'sendemail.smtpEncryption'.
 166
 167 --smtp-domain=<FQDN>::
 168         Specifies the Fully Qualified Domain Name (FQDN) used in the
 169         HELO/EHLO command to the SMTP server.  Some servers require the
 170         FQDN to match your IP address.  If not set, git send-email attempts
 171         to determine your FQDN automatically.  Default is the value of
 172         'sendemail.smtpDomain'.
 173
 174 --smtp-auth=<mechanisms>::
 175         Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting
 176         forces using only the listed mechanisms. Example:
 177 +
 178 ------
 179 $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
 180 ------
 181 +
 182 If at least one of the specified mechanisms matches the ones advertised by the
 183 SMTP server and if it is supported by the utilized SASL library, the mechanism
 184 is used for authentication. If neither 'sendemail.smtpAuth' nor '--smtp-auth'
 185 is specified, all mechanisms supported by the SASL library can be used.
 186
 187 --smtp-pass[=<password>]::
 188         Password for SMTP-AUTH. The argument is optional: If no
 189         argument is specified, then the empty string is used as
 190         the password. Default is the value of 'sendemail.smtpPass',
 191         however '--smtp-pass' always overrides this value.
 192 +
 193 Furthermore, passwords need not be specified in configuration files
 194 or on the command line. If a username has been specified (with
 195 '--smtp-user' or a 'sendemail.smtpUser'), but no password has been
 196 specified (with '--smtp-pass' or 'sendemail.smtpPass'), then
 197 a password is obtained using 'git-credential'.
 198
 199 --smtp-server=<host>::
 200         If set, specifies the outgoing SMTP server to use (e.g.
 201         `smtp.example.com` or a raw IP address).  Alternatively it can
 202         specify a full pathname of a sendmail-like program instead;
 203         the program must support the `-i` option.  Default value can
 204         be specified by the 'sendemail.smtpServer' configuration
 205         option; the built-in default is `/usr/sbin/sendmail` or
 206         `/usr/lib/sendmail` if such program is available, or
 207         `localhost` otherwise.
 208
 209 --smtp-server-port=<port>::
 210         Specifies a port different from the default port (SMTP
 211         servers typically listen to smtp port 25, but may also listen to
 212         submission port 587, or the common SSL smtp port 465);
 213         symbolic port names (e.g. "submission" instead of 587)
 214         are also accepted. The port can also be set with the
 215         'sendemail.smtpServerPort' configuration variable.
 216
 217 --smtp-server-option=<option>::
 218         If set, specifies the outgoing SMTP server option to use.
 219         Default value can be specified by the 'sendemail.smtpServerOption'
 220         configuration option.
 221 +
 222 The --smtp-server-option option must be repeated for each option you want
 223 to pass to the server. Likewise, different lines in the configuration files
 224 must be used for each option.
 225
 226 --smtp-ssl::
 227         Legacy alias for '--smtp-encryption ssl'.
 228
 229 --smtp-ssl-cert-path::
 230         Path to a store of trusted CA certificates for SMTP SSL/TLS
 231         certificate validation (either a directory that has been processed
 232         by 'c_rehash', or a single file containing one or more PEM format
 233         certificates concatenated together: see verify(1) -CAfile and
 234         -CApath for more information on these). Set it to an empty string
 235         to disable certificate verification. Defaults to the value of the
 236         'sendemail.smtpsslcertpath' configuration variable, if set, or the
 237         backing SSL library's compiled-in default otherwise (which should
 238         be the best choice on most platforms).
 239
 240 --smtp-user=<user>::
 241         Username for SMTP-AUTH. Default is the value of 'sendemail.smtpUser';
 242         if a username is not specified (with '--smtp-user' or 'sendemail.smtpUser'),
 243         then authentication is not attempted.
 244
 245 --smtp-debug=0|1::
 246         Enable (1) or disable (0) debug output. If enabled, SMTP
 247         commands and replies will be printed. Useful to debug TLS
 248         connection and authentication problems.
 249
 250 Automating
 251 ~~~~~~~~~~
 252
 253 --to-cmd=<command>::
 254         Specify a command to execute once per patch file which
 255         should generate patch file specific "To:" entries.
 256         Output of this command must be single email address per line.
 257         Default is the value of 'sendemail.tocmd' configuration value.
 258
 259 --cc-cmd=<command>::
 260         Specify a command to execute once per patch file which
 261         should generate patch file specific "Cc:" entries.
 262         Output of this command must be single email address per line.
 263         Default is the value of 'sendemail.ccCmd' configuration value.
 264
 265 --[no-]chain-reply-to::
 266         If this is set, each email will be sent as a reply to the previous
 267         email sent.  If disabled with "--no-chain-reply-to", all emails after
 268         the first will be sent as replies to the first email sent.  When using
 269         this, it is recommended that the first file given be an overview of the
 270         entire patch series. Disabled by default, but the 'sendemail.chainReplyTo'
 271         configuration variable can be used to enable it.
 272
 273 --identity=<identity>::
 274         A configuration identity. When given, causes values in the
 275         'sendemail.<identity>' subsection to take precedence over
 276         values in the 'sendemail' section. The default identity is
 277         the value of 'sendemail.identity'.
 278
 279 --[no-]signed-off-by-cc::
 280         If this is set, add emails found in Signed-off-by: or Cc: lines to the
 281         cc list. Default is the value of 'sendemail.signedoffbycc' configuration
 282         value; if that is unspecified, default to --signed-off-by-cc.
 283
 284 --[no-]cc-cover::
 285         If this is set, emails found in Cc: headers in the first patch of
 286         the series (typically the cover letter) are added to the cc list
 287         for each email set. Default is the value of 'sendemail.cccover'
 288         configuration value; if that is unspecified, default to --no-cc-cover.
 289
 290 --[no-]to-cover::
 291         If this is set, emails found in To: headers in the first patch of
 292         the series (typically the cover letter) are added to the to list
 293         for each email set. Default is the value of 'sendemail.tocover'
 294         configuration value; if that is unspecified, default to --no-to-cover.
 295
 296 --suppress-cc=<category>::
 297         Specify an additional category of recipients to suppress the
 298         auto-cc of:
 299 +
 300 --
 301 - 'author' will avoid including the patch author
 302 - 'self' will avoid including the sender
 303 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
 304   except for self (use 'self' for that).
 305 - 'bodycc' will avoid including anyone mentioned in Cc lines in the
 306   patch body (commit message) except for self (use 'self' for that).
 307 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
 308    for self (use 'self' for that).
 309 - 'cccmd' will avoid running the --cc-cmd.
 310 - 'body' is equivalent to 'sob' + 'bodycc'
 311 - 'all' will suppress all auto cc values.
 312 --
 313 +
 314 Default is the value of 'sendemail.suppresscc' configuration value; if
 315 that is unspecified, default to 'self' if --suppress-from is
 316 specified, as well as 'body' if --no-signed-off-cc is specified.
 317
 318 --[no-]suppress-from::
 319         If this is set, do not add the From: address to the cc: list.
 320         Default is the value of 'sendemail.suppressFrom' configuration
 321         value; if that is unspecified, default to --no-suppress-from.
 322
 323 --[no-]thread::
 324         If this is set, the In-Reply-To and References headers will be
 325         added to each email sent.  Whether each mail refers to the
 326         previous email (`deep` threading per 'git format-patch'
 327         wording) or to the first email (`shallow` threading) is
 328         governed by "--[no-]chain-reply-to".
 329 +
 330 If disabled with "--no-thread", those headers will not be added
 331 (unless specified with --in-reply-to).  Default is the value of the
 332 'sendemail.thread' configuration value; if that is unspecified,
 333 default to --thread.
 334 +
 335 It is up to the user to ensure that no In-Reply-To header already
 336 exists when 'git send-email' is asked to add it (especially note that
 337 'git format-patch' can be configured to do the threading itself).
 338 Failure to do so may not produce the expected result in the
 339 recipient's MUA.
 340
 341
 342 Administering
 343 ~~~~~~~~~~~~~
 344
 345 --confirm=<mode>::
 346         Confirm just before sending:
 347 +
 348 --
 349 - 'always' will always confirm before sending
 350 - 'never' will never confirm before sending
 351 - 'cc' will confirm before sending when send-email has automatically
 352   added addresses from the patch to the Cc list
 353 - 'compose' will confirm before sending the first message when using --compose.
 354 - 'auto' is equivalent to 'cc' + 'compose'
 355 --
 356 +
 357 Default is the value of 'sendemail.confirm' configuration value; if that
 358 is unspecified, default to 'auto' unless any of the suppress options
 359 have been specified, in which case default to 'compose'.
 360
 361 --dry-run::
 362         Do everything except actually send the emails.
 363
 364 --[no-]format-patch::
 365         When an argument may be understood either as a reference or as a file name,
 366         choose to understand it as a format-patch argument ('--format-patch')
 367         or as a file name ('--no-format-patch'). By default, when such a conflict
 368         occurs, git send-email will fail.
 369
 370 --quiet::
 371         Make git-send-email less verbose.  One line per email should be
 372         all that is output.
 373
 374 --[no-]validate::
 375         Perform sanity checks on patches.
 376         Currently, validation means the following:
 377 +
 378 --
 379                 *       Warn of patches that contain lines longer than 998 characters; this
 380                         is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
 381 --
 382 +
 383 Default is the value of 'sendemail.validate'; if this is not set,
 384 default to '--validate'.
 385
 386 --force::
 387         Send emails even if safety checks would prevent it.
 388
 389
 390 CONFIGURATION
 391 -------------
 392
 393 sendemail.aliasesFile::
 394         To avoid typing long email addresses, point this to one or more
 395         email aliases files.  You must also supply 'sendemail.aliasFileType'.
 396
 397 sendemail.aliasFileType::
 398         Format of the file(s) specified in sendemail.aliasesFile. Must be
 399         one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
 400 +
 401 What an alias file in each format looks like can be found in
 402 the documentation of the email program of the same name. The
 403 differences and limitations from the standard formats are
 404 described below:
 405 +
 406 --
 407 sendmail;;
 408 *       Quoted aliases and quoted addresses are not supported: lines that
 409         contain a `"` symbol are ignored.
 410 *       Redirection to a file (`/path/name`) or pipe (`|command`) is not
 411         supported.
 412 *       File inclusion (`:include: /path/name`) is not supported.
 413 *       Warnings are printed on the standard error output for any
 414         explicitly unsupported constructs, and any other lines that are not
 415         recognized by the parser.
 416 --
 417
 418 sendemail.multiEdit::
 419         If true (default), a single editor instance will be spawned to edit
 420         files you have to edit (patches when '--annotate' is used, and the
 421         summary when '--compose' is used). If false, files will be edited one
 422         after the other, spawning a new editor each time.
 423
 424 sendemail.confirm::
 425         Sets the default for whether to confirm before sending. Must be
 426         one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
 427         in the previous section for the meaning of these values.
 428
 429 EXAMPLE
 430 -------
 431 Use gmail as the smtp server
 432 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 433 To use 'git send-email' to send your patches through the GMail SMTP server,
 434 edit ~/.gitconfig to specify your account settings:
 435
 436         [sendemail]
 437                 smtpEncryption = tls
 438                 smtpServer = smtp.gmail.com
 439                 smtpUser = yourname@gmail.com
 440                 smtpServerPort = 587
 441
 442 Once your commits are ready to be sent to the mailing list, run the
 443 following commands:
 444
 445         $ git format-patch --cover-letter -M origin/master -o outgoing/
 446         $ edit outgoing/0000-*
 447         $ git send-email outgoing/*
 448
 449 Note: the following perl modules are required
 450       Net::SMTP::SSL, MIME::Base64 and Authen::SASL
 451
 452 SEE ALSO
 453 --------
 454 linkgit:git-format-patch[1], linkgit:git-imap-send[1], mbox(5)
 455
 456 GIT
 457 ---
 458 Part of the linkgit:git[1] suite