git-send-email

原文： https://git-scm.com/docs/git-send-email

名称

git-send-email - 以电子邮件形式发送补丁集合

概要

  1. git send-email [<options>] <file|directory|rev-list options>…​
  2. git send-email --dump-aliases

描述

获取命令行上给出的补丁并通过电子邮件发送出去。可以将修补程序指定为文件，目录（将发送目录中的所有文件），或直接指定为修订列表。在最后一种情况下， git-format-patch [1] 接受的任何格式都可以传递给git send-email。

电子邮件的标题可通过命令行选项进行配置。如果未在命令行中指定，将提示用户启用ReadLine接口以提供必要信息。

补丁文件有两种格式：

  1. mbox格式文件

    这就是 git-format-patch [1] 生成的内容。大多数标头和MIME格式都会被忽略。

  2. Greg Kroah-Hartman的 send_lots_of_email.pl 脚本使用的原始格式

    此格式要求文件的第一行包含“Cc：”值和消息的“Subject：”作为第二行。

OPTIONS

构成

  1.  --annotate

查看并编辑您即将发送的每个补丁。默认值是sendemail.annotate的值。有关sendemail.multiEdit的信息，请参阅配置部分。

  1.  --bcc=<address>,…​

为每封电子邮件指定“密件抄送：”值。默认值是sendemail.bcc的值。

可以多次指定此选项。

  1.  --cc=<address>,…​

为每封电子邮件指定起始“抄送：”值。默认值是sendemail.cc的值。

可以多次指定此选项。

  1.  --compose

调用文本编辑器（参见 git-var [1] 中的GIT_EDITOR）来编辑补丁系列的介绍性消息。

使用--compose时，git send-email将使用消息中指定的From，Subject和In-Reply-To标头。如果邮件的正文（您在标题后面键入的内容和空行）仅包含空行（或Git：前缀）行，则不会发送摘要，但是From，Subject和In-Reply-To标题将除非他们被删除使用。

将提示缺少From或In-Reply-To标头。

请参见sendemail.multiEdit的CONFIGURATION部分。

  1.  --from=<address>

指定电子邮件的发件人。如果未在命令行中指定，则使用sendemail.from配置选项的值。如果既未设置命令行选项也未设置sendemail.from，则将提示用户输入值。提示的默认值将是GIT_AUTHOR_IDENT的值，如果未设置，则为GIT_COMMITTER_IDENT，由“git var -l”返回。

  1.  --reply-to=<address>

指定收件人应答的地址。如果对消息的回复应该转到另一个地址而不是—from参数指定的地址，请使用此选项。

  1.  --in-reply-to=<identifier>

使第一封邮件（或所有带有--no-thread的邮件）显示为对给定Message-Id的回复，这可以避免破坏线程以提供新的补丁系列。第二封及后续电子邮件将根据--[no-]chain-reply-to设置作为回复发送。

因此，例如，当指定--thread和--no-chain-reply-to时，第二个和后续补丁将回复第一个补丁，如下图所示[PATCH v2 0/3]回复[PATCH 0/2]：

  1. [PATCH 0/2] Here is what I did...
  2.   [PATCH 1/2] Clean up and tests
  3.   [PATCH 2/2] Implementation
  4.   [PATCH v2 0/3] Here is a reroll
  5.     [PATCH v2 1/3] Clean up
  6.     [PATCH v2 2/3] New tests
  7.     [PATCH v2 3/3] Implementation

仅在设置了—compose时才需要。如果未设置—compose，则会提示。

  1.  --subject=<string>

指定电子邮件线程的初始主题。仅在设置了—compose时才需要。如果未设置—compose，则会提示。

  1.  --to=<address>,…​

指定生成的电子邮件的主要收件人。通常，这将是所涉及项目的上游维护者。默认值是sendemail.to配置值的值;如果未指定，并且未指定—to-cmd，则会提示。

可以多次指定此选项。

  1.  --8bit-encoding=<encoding>

遇到非ASCII消息或未声明其编码的主题时，添加标题/引用以指示它在< encoding>中编码。默认值是 sendemail.assume8bitEncoding 的值;如果未指定，则会在遇到任何非ASCII文件时提示。

请注意，不会尝试验证编码。

  1.  --compose-encoding=<encoding>

指定撰写邮件的编码。默认值是 sendemail.composeencoding 的值;如果未指定，则假定为UTF-8。

  1.  --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)

指定用于通过SMTP发送邮件的传输编码。遇到非ASCII消息时，7位将失败。当存储库包含包含回车符的文件时，quoted-printable可能很有用，但是使原始补丁电子邮件文件（从MUA保存）更难以手动检查。 base64更加傻瓜式，但也更加不透明。 auto会尽可能使用8bit，否则引用可打印。

默认值是sendemail.transferEncoding配置值的值;如果未指定，则默认为auto。

  1.  --xmailer
  1.  --no-xmailer

添加（或阻止添加）“X-Mailer：”标题。默认情况下，会添加标题，但可以通过将sendemail.xmailer配置变量设置为false来关闭标题。

发出

  1.  --envelope-sender=<address>

指定用于发送电子邮件的信封发件人。如果您的默认地址不是订阅列表的地址，这将非常有用。要使用 From 地址，请将值设置为“auto”。如果使用sendmail二进制文件，则必须具有-f参数的适当权限。默认值是sendemail.envelopeSender配置变量的值;如果未指定，则选择信封发件人将留给您的MTA。

  1.  --smtp-encryption=<encryption>

指定要使用的加密， ssl 或 tls 。任何其他值都将恢复为纯SMTP。默认值是sendemail.smtpEncryption的值。

  1.  --smtp-domain=<FQDN>

指定HELO / EHLO命令中用于SMTP服务器的完全限定域名（FQDN）。某些服务器要求FQDN与您的IP地址匹配。如果未设置，git send-email会尝试自动确定您的FQDN。默认值是sendemail.smtpDomain的值。

  1.  --smtp-auth=<mechanisms>

允许的SMTP-AUTH机制的以空格分隔的列表。此设置仅强制使用列出的机制。例：

  1. $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...

如果至少一个指定的机制与SMTP服务器通告的机制匹配，并且所使用的SASL库支持该机制，则该机制用于身份验证。如果既未指定 sendemail.smtpAuth 也未指定--smtp-auth，则可以使用SASL库支持的所有机制。特殊值 none 可能被指定为独立于--smtp-user完全禁用认证

  1.  --smtp-pass[=<password>]

SMTP-AUTH的密码。参数是可选的：如果未指定参数，则使用空字符串作为密码。默认值为sendemail.smtpPass，但--smtp-pass始终覆盖此值。

此外，无需在配置文件或命令行中指定密码。如果已指定用户名（使用--smtp-user或sendemail.smtpUser），但未指定密码（使用--smtp-pass或sendemail.smtpPass），则使用 git-credential 获取密码。

  1.  --no-smtp-auth

禁用SMTP身份验证。 --smtp-auth=none的简写

  1.  --smtp-server=<host>

如果设置，则指定要使用的传出SMTP服务器（例如smtp.example.com或原始IP地址）。或者，它可以指定类似sendmail的程序的完整路径名;该程序必须支持-i选项。可以通过sendemail.smtpServer配置选项指定默认值;内置默认值是在/usr/sbin，/usr/lib和$ PATH中搜索sendmail（如果此类程序可用），否则返回localhost。

  1.  --smtp-server-port=<port>

指定与默认端口不同的端口（SMTP服务器通常侦听smtp端口25，但也可以侦听提交端口587或公共SSL smtp端口465）;也接受符号端口名称（例如“提交”而不是587）。也可以使用sendemail.smtpServerPort配置变量设置端口。

  1.  --smtp-server-option=<option>

如果设置，则指定要使用的传出SMTP服务器选项。可以通过sendemail.smtpServerOption配置选项指定默认值。

必须为要传递给服务器的每个选项重复—smtp-server-option选项。同样，必须为每个选项使用配置文件中的不同行。

  1.  --smtp-ssl

—smtp-encryption ssl 的旧版别名。

  1.  --smtp-ssl-cert-path

用于SMTP SSL / TLS证书验证的可信CA证书存储的路径（已由 c_rehash 处理的目录，或包含一个或多个PEM格式证书的单个文件连接在一起：请参阅verify（1 ）-CAfile和-CApath有关这些的更多信息）。将其设置为空字符串以禁用证书验证。默认为sendemail.smtpsslcertpath配置变量的值（如果已设置），或者支持SSL库的默认编译（在大多数平台上应该是最佳选择）。

  1.  --smtp-user=<user>

SMTP-AUTH的用户名。默认值是sendemail.smtpUser的值;如果未指定用户名（使用--smtp-user或sendemail.smtpUser），则不会尝试进行身份验证。

  1.  --smtp-debug=0|1

启用（1）或禁用（0）调试输出。如果启用，将打印SMTP命令和答复。用于调试TLS连接和身份验证问题。

  1.  --batch-size=<num>

某些电子邮件服务器（例如smtp.163.com）限制每个会话（连接）发送的电子邮件数量，这将导致发送许多邮件时出现故障。使用此选项，send-email将在发送$< num>后断开连接。消息并等待几秒钟（请参阅—relogin-delay）并重新连接，以解决此类限制。您可能希望使用某种形式的凭据帮助程序，以避免每次发生这种情况时都必须重新键入密码。默认为sendemail.smtpBatchSize配置变量。

  1.  --relogin-delay=<int>

等待$< int>重新连接到SMTP服务器之前的秒数。与—batch-size选项一起使用。默认为sendemail.smtpReloginDelay配置变量。

自动化

  1.  --to-cmd=<command>

指定每个补丁文件执行一次的命令，该文件应生成特定于补丁文件的“收件人：”条目。此命令的输出必须是每行一个电子邮件地址。默认值为 sendemail.tocmd 配置值。

  1.  --cc-cmd=<command>

指定每个补丁文件执行一次的命令，该文件应生成特定于补丁文件的“Cc：”条目。此命令的输出必须是每行一个电子邮件地址。默认值是sendemail.ccCmd配置值的值。

  1.  --[no-]chain-reply-to

如果设置了此项，则每封电子邮件都将作为对上一封电子邮件的回复发送。如果使用“—no-chain-reply-to”禁用，则第一封后的所有电子邮件将作为对第一封电子邮件的回复发送。使用它时，建议给出的第一个文件是整个补丁系列的概述。默认情况下禁用，但sendemail.chainReplyTo配置变量可用于启用它。

  1.  --identity=<identity>

配置标识。给定时，会导致 sendemail中的值。< identity> 子部分优先于 sendemail 部分中的值。默认标识是sendemail.identity的值。

  1.  --[no-]signed-off-by-cc

如果设置了此项，请将在Signed-off-by：或Cc：行中找到的电子邮件添加到cc列表中。默认值是sendemail.signedoffbycc配置值的值;如果未指定，则默认为—signed-off-by-cc。

  1.  --[no-]cc-cover

如果设置了此项，则系列的第一个补丁中的Cc：标题中的电子邮件（通常是求职信）将添加到每个电子邮件集的cc列表中。默认值为 sendemail.cccover 配置值;如果未指定，则默认为—no-cc-cover。

  1.  --[no-]to-cover

如果设置了此项，则系列的第一个补丁中的To：标题中找到的电子邮件（通常是求职信）将添加到每个电子邮件集的列表中。默认值为 sendemail.tocover 配置值;如果未指定，则默认为—no-to-cover。

  1.  --suppress-cc=<category>

指定其他类别的收件人以禁止auto-cc：

  • 作者将避免包括补丁作者。

  • 自将避免包含发件人。

  • cc 将避免包括除自我之外的补丁标题中的Cc行中提到的任何人（使用 self ）。

  • bodycc 将避免包括在补丁体（提交消息）中的Cc行中提到的任何人，除了self（使用 self ）。

  • 呜咽将避免包括除了自我之外的签名旁线中提到的任何人（使用自）。

  • misc-by 将避免包括在Acked-by，Review-by，Tested-by和补丁体中的其他“-by”行中提到的任何人，除了Signed-off-by（使用 sob 为此）。

  • cccmd 将避免运行—cc-cmd。

  • 体相当于 sob + bodycc + misc-by 。

  • 所有将抑制所有自动cc值。

默认值是sendemail.suppresscc配置值的值;如果未指定，如果指定了—suppress-from，则默认为 self ，如果指定了—no-signed-off-cc，则默认为 body 。

  1.  --[no-]suppress-from

如果设置了此项，请不要将From：地址添加到cc：列表。默认值是sendemail.suppressFrom配置值的值;如果未指定，则默认为—no-suppress-from。

  1.  --[no-]thread

如果设置了此项，则会将In-Reply-To和References标头添加到发送的每封电子邮件中。每个邮件是否引用前一封电子邮件（每个 git format-pat 措辞的deep线程）或第一封电子邮件（shallow线程）由“ - [no-]链式回复控制-至”。

如果使用“—no-thread”禁用，则不会添加这些标头（除非使用—in-reply-to指定）。默认值是sendemail.thread配置值的值;如果未指定，则默认为—thread。

当 git send-email 被要求添加它时，由用户确保不存在In-Reply-To标头（特别注意 git format-patch 可以是配置为执行线程本身）。如果不这样做，可能无法在收件人的MUA中产生预期的结果。

管理

  1.  --confirm=<mode>

发送前确认：

  • 始终将始终在发送前确认

  • 从来没有在发送之前永远不会确认

  • cc 将在发送之前确认send-email自动将补丁中的地址添加到抄送列表

  • 撰写将在使用—compose发送第一条消息之前确认。

  • auto 相当于 cc + 组成

默认值是sendemail.confirm配置值的值;如果未指定，则默认为 auto ，除非指定了任何抑制选项，在这种情况下默认为组成。

  1.  --dry-run

做任何事情，除了实际发送电子邮件。

  1.  --[no-]format-patch

当参数可以理解为引用或文件名时，选择将其理解为格式补丁参数（--format-patch）或文件名（--no-format-patch）。默认情况下，发生此类冲突时，git send-email将失败。

  1.  --quiet

使git-send-email更简洁。每封电子邮件一行应该是输出的全部内容。

  1.  --[no-]validate

对补丁进行健全性检查。目前，验证意味着以下内容：

  • 如果存在，则调用sendemail-validate钩子（参见 githooks [5] ）。

  • 除非使用合适的传输编码（ auto ， base64 或引用的可打印），否则警告包含超过998个字符的行;这是由于 http://www.ietf.org/rfc/rfc5322.txt 所描述的SMTP限制。

默认值是sendemail.validate的值;如果未设置，则默认为--validate。

  1.  --force

即使安全检查会阻止它，也要发送电子邮件。

信息

  1.  --dump-aliases

而不是正常操作，从已配置的别名文件中转储速记别名，每行按字母顺序排列一个。请注意，这仅包括别名，而不包括其扩展的电子邮件地址。有关别名的更多信息，请参见 sendemail.aliases文件。

组态

  1.  sendemail.aliasesFile

要避免键入长电子邮件地址，请将其指向一个或多个电子邮件别名文件。您还必须提供sendemail.aliasFileType。

  1.  sendemail.aliasFileType

sendemail.aliasesFile中指定的文件格式。必须是 mutt ， mailrc ， pine ， elm 或 gnus 或 sendmail之一。

可以在同名电子邮件程序的文档中找到每种格式的别名文件。标准格式的差异和限制如下所述：

  1.  sendmail

  • 不支持引用的别名和引用地址：忽略包含"符号的行。

  • 不支持重定向到文件（/path/name）或管道（|command）。

  • 不支持文件包含（:include: /path/name）。

  • 对于任何明确不受支持的构造以及解析器无法识别的任何其他行，标准错误输出上会显示警告。

  1.  sendemail.multiEdit

如果为true（默认），将生成单个编辑器实例以编辑您必须编辑的文件（使用--annotate时的补丁，以及使用--compose时的摘要）。如果为false，将逐个编辑文件，每次生成一个新的编辑器。

  1.  sendemail.confirm

设置发送前是否确认的默认值。必须是始终，永远， cc ，组成或 auto 之一。有关这些值的含义，请参见上一节中的--confirm。

例子

使用gmail作为smtp服务器

要使用 git send-email 通过GMail SMTP服务器发送补丁，请编辑〜/ .gitconfig以指定您的帐户设置：

  1. [sendemail]
  2.     smtpEncryption = tls
  3.     smtpServer = smtp.gmail.com
  4.     smtpUser = yourname@gmail.com
  5.     smtpServerPort = 587

如果您的Gmail帐户上有多重身份验证设置，则需要生成一个特定于应用程序的密码，以便与 git send-email 一起使用。访问 https://security.google.com/settings/security/apppasswords 进行创建。

一旦您的提交准备好发送到邮件列表，请运行以下命令：

  1. $ git format-patch --cover-letter -M origin/master -o outgoing/
  2. $ edit outgoing/0000-*
  3. $ git send-email outgoing/*

第一次运行它时，系统将提示您输入凭据。根据需要输入特定于应用程序或常规密码。如果您配置了凭证帮助程序（请参阅 git-credential [1] ），密码将保存在凭证存储中，因此您不必在下次输入密码。

注意：以下perl模块需要Net :: SMTP :: SSL，MIME :: Base64和Authen :: SASL

也可以看看

git-format-patch [1] ， git-imap-send [1] ，mbox（5）

GIT

部分 git [1] 套件