git-send-email · Git 中文參考

# git-send-email > 原文： [https://git-scm.com/docs/git-send-email](https://git-scm.com/docs/git-send-email) ## 名稱 git-send-email - 以電子郵件形式發送補丁集合 ## 概要 ``` git send-email [<options>] <file|directory|rev-list options>…? git send-email --dump-aliases ``` ## 描述獲取命令行上給出的補丁并通過電子郵件發送出去。可以將修補程序指定為文件，目錄（將發送目錄中的所有文件），或直接指定為修訂列表。在最后一種情況下， [git-format-patch [1]](https://git-scm.com/docs/git-format-patch) 接受的任何格式都可以傳遞給git send-email。電子郵件的標題可通過命令行選項進行配置。如果未在命令行中指定，將提示用戶啟用ReadLine接口以提供必要信息。補丁文件有兩種格式： 1. mbox格式文件這就是 [git-format-patch [1]](https://git-scm.com/docs/git-format-patch) 生成的內容。大多數標頭和MIME格式都會被忽略。 2. Greg Kroah-Hartman的 _send_lots_of_email.pl_ 腳本使用的原始格式此格式要求文件的第一行包含“Cc：”值和消息的“Subject：”作為第二行。 ## OPTIONS ### 構成 ``` --annotate ``` 查看并編輯您即將發送的每個補丁。默認值是`sendemail.annotate`的值。有關`sendemail.multiEdit`的信息，請參閱配置部分。 ``` --bcc=<address>,…? ``` 為每封電子郵件指定“密件抄送：”值。默認值是`sendemail.bcc`的值。可以多次指定此選項。 ``` --cc=<address>,…? ``` 為每封電子郵件指定起始“抄送：”值。默認值是`sendemail.cc`的值。可以多次指定此選項。 ``` --compose ``` 調用文本編輯器（參見 [git-var [1]](https://git-scm.com/docs/git-var) 中的GIT_EDITOR）來編輯補丁系列的介紹性消息。使用`--compose`時，git send-email將使用消息中指定的From，Subject和In-Reply-To標頭。如果郵件的正文（您在標題后面鍵入的內容和空行）僅包含空行（或Git：前綴）行，則不會發送摘要，但是From，Subject和In-Reply-To標題將除非他們被刪除使用。將提示缺少From或In-Reply-To標頭。請參見`sendemail.multiEdit`的CONFIGURATION部分。 ``` --from=<address> ``` 指定電子郵件的發件人。如果未在命令行中指定，則使用`sendemail.from`配置選項的值。如果既未設置命令行選項也未設置`sendemail.from`，則將提示用戶輸入值。提示的默認值將是GIT_AUTHOR_IDENT的值，如果未設置，則為GIT_COMMITTER_IDENT，由“git var -l”返回。 ``` --reply-to=<address> ``` 指定收件人應答的地址。如果對消息的回復應該轉到另一個地址而不是--from參數指定的地址，請使用此選項。 ``` --in-reply-to=<identifier> ``` 使第一封郵件（或所有帶有`--no-thread`的郵件）顯示為對給定Message-Id的回復，這可以避免破壞線程以提供新的補丁系列。第二封及后續電子郵件將根據`--[no-]chain-reply-to`設置作為回復發送。因此，例如，當指定`--thread`和`--no-chain-reply-to`時，第二個和后續補丁將回復第一個補丁，如下圖所示`[PATCH v2 0/3]`回復`[PATCH 0/2]`： ``` [PATCH 0/2] Here is what I did... [PATCH 1/2] Clean up and tests [PATCH 2/2] Implementation [PATCH v2 0/3] Here is a reroll [PATCH v2 1/3] Clean up [PATCH v2 2/3] New tests [PATCH v2 3/3] Implementation ``` 僅在設置了--compose時才需要。如果未設置--compose，則會提示。 ``` --subject=<string> ``` 指定電子郵件線程的初始主題。僅在設置了--compose時才需要。如果未設置--compose，則會提示。 ``` --to=<address>,…? ``` 指定生成的電子郵件的主要收件人。通常，這將是所涉及項目的上游維護者。默認值是`sendemail.to`配置值的值;如果未指定，并且未指定--to-cmd，則會提示。可以多次指定此選項。 ``` --8bit-encoding=<encoding> ``` 遇到非ASCII消息或未聲明其編碼的主題時，添加標題/引用以指示它在< encoding>中編碼。默認值是 _sendemail.assume8bitEncoding_ 的值;如果未指定，則會在遇到任何非ASCII文件時提示。請注意，不會嘗試驗證編碼。 ``` --compose-encoding=<encoding> ``` 指定撰寫郵件的編碼。默認值是 _sendemail.composeencoding_ 的值;如果未指定，則假定為UTF-8。 ``` --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto) ``` 指定用于通過SMTP發送郵件的傳輸編碼。遇到非ASCII消息時，7位將失敗。當存儲庫包含包含回車符的文件時，quoted-printable可能很有用，但是使原始補丁電子郵件文件（從MUA保存）更難以手動檢查。 base64更加傻瓜式，但也更加不透明。 auto會盡可能使用8bit，否則引用可打印。默認值是`sendemail.transferEncoding`配置值的值;如果未指定，則默認為`auto`。 ``` --xmailer ``` ``` --no-xmailer ``` 添加（或阻止添加）“X-Mailer：”標題。默認情況下，會添加標題，但可以通過將`sendemail.xmailer`配置變量設置為`false`來關閉標題。 ### 發出 ``` --envelope-sender=<address> ``` 指定用于發送電子郵件的信封發件人。如果您的默認地址不是訂閱列表的地址，這將非常有用。要使用 _From_ 地址，請將值設置為“auto”。如果使用sendmail二進制文件，則必須具有-f參數的適當權限。默認值是`sendemail.envelopeSender`配置變量的值;如果未指定，則選擇信封發件人將留給您的MTA。 ``` --smtp-encryption=<encryption> ``` 指定要使用的加密， _ssl_ 或 _tls_ 。任何其他值都將恢復為純SMTP。默認值是`sendemail.smtpEncryption`的值。 ``` --smtp-domain=<FQDN> ``` 指定HELO / EHLO命令中用于SMTP服務器的完全限定域名（FQDN）。某些服務器要求FQDN與您的IP地址匹配。如果未設置，git send-email會嘗試自動確定您的FQDN。默認值是`sendemail.smtpDomain`的值。 ``` --smtp-auth=<mechanisms> ``` 允許的SMTP-AUTH機制的以空格分隔的列表。此設置僅強制使用列出的機制。例： ``` $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ... ``` 如果至少一個指定的機制與SMTP服務器通告的機制匹配，并且所使用的SASL庫支持該機制，則該機制用于身份驗證。如果既未指定 _sendemail.smtpAuth_ 也未指定`--smtp-auth`，則可以使用SASL庫支持的所有機制。特殊值 _none_ 可能被指定為獨立于`--smtp-user`完全禁用認證 ``` --smtp-pass[=<password>] ``` SMTP-AUTH的密碼。參數是可選的：如果未指定參數，則使用空字符串作為密碼。默認值為`sendemail.smtpPass`，但`--smtp-pass`始終覆蓋此值。此外，無需在配置文件或命令行中指定密碼。如果已指定用戶名（使用`--smtp-user`或`sendemail.smtpUser`），但未指定密碼（使用`--smtp-pass`或`sendemail.smtpPass`），則使用 _git-credential_ 獲取密碼。 ``` --no-smtp-auth ``` 禁用SMTP身份驗證。 `--smtp-auth=none`的簡寫 ``` --smtp-server=<host> ``` 如果設置，則指定要使用的傳出SMTP服務器（例如`smtp.example.com`或原始IP地址）。或者，它可以指定類似sendmail的程序的完整路徑名;該程序必須支持`-i`選項。可以通過`sendemail.smtpServer`配置選項指定默認值;內置默認值是在`/usr/sbin`，`/usr/lib`和$ PATH中搜索`sendmail`（如果此類程序可用），否則返回`localhost`。 ``` --smtp-server-port=<port> ``` 指定與默認端口不同的端口（SMTP服務器通常偵聽smtp端口25，但也可以偵聽提交端口587或公共SSL smtp端口465）;也接受符號端口名稱（例如“提交”而不是587）。也可以使用`sendemail.smtpServerPort`配置變量設置端口。 ``` --smtp-server-option=<option> ``` 如果設置，則指定要使用的傳出SMTP服務器選項。可以通過`sendemail.smtpServerOption`配置選項指定默認值。必須為要傳遞給服務器的每個選項重復--smtp-server-option選項。同樣，必須為每個選項使用配置文件中的不同行。 ``` --smtp-ssl ``` _--smtp-encryption ssl_ 的舊版別名。 ``` --smtp-ssl-cert-path ``` 用于SMTP SSL / TLS證書驗證的可信CA證書存儲的路徑（已由 _c_rehash_ 處理的目錄，或包含一個或多個PEM格式證書的單個文件連接在一起：請參閱verify（1 ）-CAfile和-CApath有關這些的更多信息）。將其設置為空字符串以禁用證書驗證。默認為`sendemail.smtpsslcertpath`配置變量的值（如果已設置），或者支持SSL庫的默認編譯（在大多數平臺上應該是最佳選擇）。 ``` --smtp-user=<user> ``` SMTP-AUTH的用戶名。默認值是`sendemail.smtpUser`的值;如果未指定用戶名（使用`--smtp-user`或`sendemail.smtpUser`），則不會嘗試進行身份驗證。 ``` --smtp-debug=0|1 ``` 啟用（1）或禁用（0）調試輸出。如果啟用，將打印SMTP命令和答復。用于調試TLS連接和身份驗證問題。 ``` --batch-size=<num> ``` 某些電子郵件服務器（例如smtp.163.com）限制每個會話（連接）發送的電子郵件數量，這將導致發送許多郵件時出現故障。使用此選項，send-email將在發送$< num>后斷開連接。消息并等待幾秒鐘（請參閱--relogin-delay）并重新連接，以解決此類限制。您可能希望使用某種形式的憑據幫助程序，以避免每次發生這種情況時都必須重新鍵入密碼。默認為`sendemail.smtpBatchSize`配置變量。 ``` --relogin-delay=<int> ``` 等待$< int>重新連接到SMTP服務器之前的秒數。與--batch-size選項一起使用。默認為`sendemail.smtpReloginDelay`配置變量。 ### 自動化 ``` --to-cmd=<command> ``` 指定每個補丁文件執行一次的命令，該文件應生成特定于補丁文件的“收件人：”條目。此命令的輸出必須是每行一個電子郵件地址。默認值為 _sendemail.tocmd_ 配置值。 ``` --cc-cmd=<command> ``` 指定每個補丁文件執行一次的命令，該文件應生成特定于補丁文件的“Cc：”條目。此命令的輸出必須是每行一個電子郵件地址。默認值是`sendemail.ccCmd`配置值的值。 ``` --[no-]chain-reply-to ``` 如果設置了此項，則每封電子郵件都將作為對上一封電子郵件的回復發送。如果使用“--no-chain-reply-to”禁用，則第一封后的所有電子郵件將作為對第一封電子郵件的回復發送。使用它時，建議給出的第一個文件是整個補丁系列的概述。默認情況下禁用，但`sendemail.chainReplyTo`配置變量可用于啟用它。 ``` --identity=<identity> ``` 配置標識。給定時，會導致 _sendemail中的值。< identity>_ 子部分優先于 _sendemail_ 部分中的值。默認標識是`sendemail.identity`的值。 ``` --[no-]signed-off-by-cc ``` 如果設置了此項，請將在Signed-off-by：或Cc：行中找到的電子郵件添加到cc列表中。默認值是`sendemail.signedoffbycc`配置值的值;如果未指定，則默認為--signed-off-by-cc。 ``` --[no-]cc-cover ``` 如果設置了此項，則系列的第一個補丁中的Cc：標題中的電子郵件（通常是求職信）將添加到每個電子郵件集的cc列表中。默認值為 _sendemail.cccover_ 配置值;如果未指定，則默認為--no-cc-cover。 ``` --[no-]to-cover ``` 如果設置了此項，則系列的第一個補丁中的To：標題中找到的電子郵件（通常是求職信）將添加到每個電子郵件集的列表中。默認值為 _sendemail.tocover_ 配置值;如果未指定，則默認為--no-to-cover。 ``` --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_ 。 ``` --[no-]suppress-from ``` 如果設置了此項，請不要將From：地址添加到cc：列表。默認值是`sendemail.suppressFrom`配置值的值;如果未指定，則默認為--no-suppress-from。 ``` --[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中產生預期的結果。 ### 管理 ``` --confirm=<mode> ``` 發送前確認： * _始終_將始終在發送前確認 * _從來沒有_在發送之前永遠不會確認 * _cc_ 將在發送之前確認send-email自動將補丁中的地址添加到抄送列表 * _撰寫_將在使用--compose發送第一條消息之前確認。 * _auto_ 相當于 _cc_ + _組成_ 默認值是`sendemail.confirm`配置值的值;如果未指定，則默認為 _auto_ ，除非指定了任何抑制選項，在這種情況下默認為_組成_。 ``` --dry-run ``` 做任何事情，除了實際發送電子郵件。 ``` --[no-]format-patch ``` 當參數可以理解為引用或文件名時，選擇將其理解為格式補丁參數（`--format-patch`）或文件名（`--no-format-patch`）。默認情況下，發生此類沖突時，git send-email將失敗。 ``` --quiet ``` 使git-send-email更簡潔。每封電子郵件一行應該是輸出的全部內容。 ``` --[no-]validate ``` 對補丁進行健全性檢查。目前，驗證意味著以下內容： * 如果存在，則調用sendemail-validate鉤子（參見 [githooks [5]](https://git-scm.com/docs/githooks) ）。 * 除非使用合適的傳輸編碼（ _auto_ ， _base64_ 或_引用的可打印_），否則警告包含超過998個字符的行;這是由于 [http://www.ietf.org/rfc/rfc5322.txt](http://www.ietf.org/rfc/rfc5322.txt) 所描述的SMTP限制。默認值是`sendemail.validate`的值;如果未設置，則默認為`--validate`。 ``` --force ``` 即使安全檢查會阻止它，也要發送電子郵件。 ### 信息 ``` --dump-aliases ``` 而不是正常操作，從已配置的別名文件中轉儲速記別名，每行按字母順序排列一個。請注意，這僅包括別名，而不包括其擴展的電子郵件地址。有關別名的更多信息，請參見 _sendemail.aliases文件_。 ## 組態 ``` sendemail.aliasesFile ``` 要避免鍵入長電子郵件地址，請將其指向一個或多個電子郵件別名文件。您還必須提供`sendemail.aliasFileType`。 ``` sendemail.aliasFileType ``` sendemail.aliasesFile中指定的文件格式。必須是 _mutt_ ， _mailrc_ ， _pine_ ， _elm_ 或 _gnus_ 或 _sendmail之一_。可以在同名電子郵件程序的文檔中找到每種格式的別名文件。標準格式的差異和限制如下所述： ``` sendmail ``` * 不支持引用的別名和引用地址：忽略包含`"`符號的行。 * 不支持重定向到文件（`/path/name`）或管道（`|command`）。 * 不支持文件包含（`:include: /path/name`）。 * 對于任何明確不受支持的構造以及解析器無法識別的任何其他行，標準錯誤輸出上會顯示警告。 ``` sendemail.multiEdit ``` 如果為true（默認），將生成單個編輯器實例以編輯您必須編輯的文件（使用`--annotate`時的補丁，以及使用`--compose`時的摘要）。如果為false，將逐個編輯文件，每次生成一個新的編輯器。 ``` sendemail.confirm ``` 設置發送前是否確認的默認值。必須是_始終_，_永遠_， _cc_ ，_組成_或 _auto_ 之一。有關這些值的含義，請參見上一節中的`--confirm`。 ## 例子 ### 使用gmail作為smtp服務器要使用 _git send-email_ 通過GMail SMTP服務器發送補丁，請編輯?/ .gitconfig以指定您的帳戶設置： ``` [sendemail] smtpEncryption = tls smtpServer = smtp.gmail.com smtpUser = yourname@gmail.com smtpServerPort = 587 ``` 如果您的Gmail帳戶上有多重身份驗證設置，則需要生成一個特定于應用程序的密碼，以便與 _git send-email_ 一起使用。訪問 [https://security.google.com/settings/security/apppasswords](https://security.google.com/settings/security/apppasswords) 進行創建。一旦您的提交準備好發送到郵件列表，請運行以下命令： ``` $ git format-patch --cover-letter -M origin/master -o outgoing/ $ edit outgoing/0000-* $ git send-email outgoing/* ``` 第一次運行它時，系統將提示您輸入憑據。根據需要輸入特定于應用程序或常規密碼。如果您配置了憑證幫助程序（請參閱 [git-credential [1]](https://git-scm.com/docs/git-credential) ），密碼將保存在憑證存儲中，因此您不必在下次輸入密碼。注意：以下perl模塊需要Net :: SMTP :: SSL，MIME :: Base64和Authen :: SASL ## 也可以看看 [git-format-patch [1]](https://git-scm.com/docs/git-format-patch) ， [git-imap-send [1]](https://git-scm.com/docs/git-imap-send) ，mbox（5） ## GIT 部分 [git [1]](https://git-scm.com/docs/git) 套件