简体中文 ▾ 主题 ▾ 最新版本 ▾ git-imap-send 最后更新于 2.55.0

名称

git-imap-send - 将一系列补丁从标准输入发送到 IMAP 文件夹

概要

git imap-send [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
git imap-send --list

描述

此命令将由 git format-patch 生成的邮箱上传到 IMAP 草稿箱中。这使得在使用无法直接读取邮箱文件的邮件客户端时,补丁也能像其他电子邮件一样发送。该命令也适用于任何常规邮箱,只要邮件依次包含 FromDateSubject 字段即可。

典型用法如下

$ git format-patch --signoff --stdout --attach origin | git imap-send

选项

-v
--verbose

显示详细信息。

-q
--quiet

静默模式。

-f <folder>
--folder=<folder>

指定保存邮件的文件夹。例如:--folder=[Gmail]/Drafts-f INBOX/Drafts

--curl

使用 libcurl 与 IMAP 服务器通信(除非通过隧道连接)。如果 Git 构建时未设置 USE_CURL_FOR_IMAP_SEND 选项,则忽略此参数。

--no-curl

使用 Git 自带的 IMAP 例程与 IMAP 服务器通信,而不是使用 libcurl。如果 Git 构建时设置了 NO_OPENSSL 选项,则忽略此参数。

--list

运行 IMAP LIST 命令以输出当前所有文件夹的列表。

配置

要使用此工具,必须设置 imap.folder 以及 imap.tunnelimap.host 为适当的值。

本节中此行以上的所有内容均未包含在 git-config[1] 文档中。以下内容与该文档中的内容相同

imap.folder

放置邮件的文件夹,通常是草稿箱。例如:INBOX.DraftsINBOX/Drafts[Gmail]/Drafts。必须指定要操作的 IMAP 文件夹;当未给出 --folder 选项时,该配置变量的值将作为后备默认值使用。

imap.tunnel

用于建立通往 IMAP 服务器隧道的命令,命令将通过该隧道进行管道传输,而不是使用直接网络连接。当未设置 imap.host 时必须设置此项。

imap.host

标识服务器的 URL。对于非安全连接,请使用 imap:// 前缀;对于安全连接,请使用 imaps:// 前缀。设置了 imap.tunnel 时将忽略此项,否则为必填项。

imap.user

登录服务器时使用的用户名。

imap.pass

登录服务器时使用的密码。

imap.port

连接服务器的整型端口号。默认值:imap:// 主机为 143,imaps:// 主机为 993。设置了 imap.tunnel 时忽略此项。

imap.sslverify

用于启用/禁用 SSL/TLS 连接验证服务器证书的布尔值。默认值为 true。设置了 imap.tunnel 时忽略此项。

imap.preformattedHTML

用于在发送补丁时启用/禁用 HTML 编码的布尔值。HTML 编码的补丁将包含在 <pre> 标签中,且内容类型为 text/html。讽刺的是,启用此选项会导致 Thunderbird 将补丁作为 plain/text, format=fixed 邮件发送。默认值为 false

imap.authMethod

指定与 IMAP 服务器进行身份验证的验证方法。如果 Git 是在构建时禁用了 NO_CURL 选项,或者你的 curl 版本低于 7.34.0,或者你运行 git-imap-send 时使用了 --no-curl 选项,则仅支持 PLAINCRAM-MD5OAUTHBEARERXOAUTH2 方法。如果未设置此项,则 git imap-send 使用基本的 IMAP 明文 LOGIN 命令。

获取可用文件夹列表

为了将电子邮件发送到特定文件夹,你需要知道邮箱中目标文件夹的确切名称。各种邮件客户端显示的如“垃圾邮件”、“已删除”等名称,未必是邮件服务提供商服务器上存储的文件夹实际名称。

要获取可与 git imap-send 配合使用的正确文件夹名称,可以运行 git imap-send --list。这将显示有效文件夹名称的列表。在 Gmail 账户上运行此命令的输出示例如下:

* LIST (\HasNoChildren) "/" "INBOX"
* LIST (\HasChildren \Noselect) "/" "[Gmail]"
* LIST (\All \HasNoChildren) "/" "[Gmail]/All Mail"
* LIST (\Drafts \HasNoChildren) "/" "[Gmail]/Drafts"
* LIST (\HasNoChildren \Important) "/" "[Gmail]/Important"
* LIST (\HasNoChildren \Sent) "/" "[Gmail]/Sent Mail"
* LIST (\HasNoChildren \Junk) "/" "[Gmail]/Spam"
* LIST (\Flagged \HasNoChildren) "/" "[Gmail]/Starred"
* LIST (\HasNoChildren \Trash) "/" "[Gmail]/Trash"

在此处可以看到,“垃圾邮件”文件夹的正确名称是 [Gmail]/Spam,“已删除”文件夹的正确名称是 [Gmail]/Trash。类似的逻辑也可用于确定其他文件夹。

示例

使用隧道模式

[imap]
    folder = "INBOX.Drafts"
    tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"

使用直接模式

[imap]
    folder = "INBOX.Drafts"
    host = imap://imap.example.com
    user = bob
    pass = p4ssw0rd

使用带 SSL 的直接模式

[imap]
    folder = "INBOX.Drafts"
    host = imaps://imap.example.com
    user = bob
    pass = p4ssw0rd
    port = 123
    ; sslVerify = false
注意
在排查问题时,如果你怀疑连接问题是因为私有服务器 example.com(你正尝试或已经设置的)上的证书未被正确验证,你可以使用 sslVerify=false

使用 Gmail 的 IMAP 接口

[imap]
    folder = "[Gmail]/Drafts"
    host = imaps://imap.gmail.com
    user = user@gmail.com
    port = 993

Gmail 不允许在 git imap-send 中使用你的常规密码。如果你的 Gmail 账户设置了多因素身份验证,你可以生成一个应用专用密码供 git imap-send 使用。访问 https://security.google.com/settings/security/apppasswords 创建它。或者,使用下述的 OAuth2.0 身份验证。

注意
如果你收到“文件夹不存在”的错误,你可能需要改用:folder = "[Google Mail]/Drafts"。你也可以运行 git imap-send --list 获取可用文件夹列表。
注意
如果你的 Gmail 账户设置为英语以外的语言,“草稿”文件夹的名称将被本地化。

如果你想使用基于 OAuth2.0 的身份验证,可以在配置中指定 OAUTHBEARERXOAUTH2 机制。它比使用应用专用密码更安全,也不强制要求使用多因素身份验证。使用此身份验证时,你必须使用 OAuth2.0 访问令牌代替你的密码。

[imap]
    folder = "[Gmail]/Drafts"
    host = imaps://imap.gmail.com
    user = user@gmail.com
    port = 993
    authmethod = OAUTHBEARER

使用 Outlook 的 IMAP 接口

与 Gmail 不同,Outlook 仅支持基于 OAuth2.0 的身份验证。此外,它仅支持 XOAUTH2 作为机制。

[imap]
    folder = "Drafts"
    host = imaps://outlook.office365.com
    user = user@outlook.com
    port = 993
    authmethod = XOAUTH2

提交准备好后,运行以下命令:

$ git format-patch --cover-letter -M --stdout origin/master | git imap-send

只需确保在邮件客户端中禁用了自动换行(Gmail 的网页界面无论如何都会换行,所以你需要使用真正的 IMAP 客户端)。

如果你使用 OAuth2.0 身份验证,使用凭证助手(credential helpers)生成令牌会更方便。git-send-email[1] 中建议的凭证助手同样可用于 git imap-send

警告

确保你的邮件程序发送的电子邮件符合项目标准,依然是你的责任。许多项目不喜欢以附件形式发送补丁。一些邮件代理会以导致补丁失效的方式转换补丁(例如:自动换行、以 format=flowed 发送)。如果你不检查这一点,你可能会招致嘲讽和愤怒的指责。

特别是 Thunderbird 被认为存在此类问题。Thunderbird 用户可能希望访问此网页了解更多信息:https://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email

另请参阅

GIT

Git[1] 套件的一部分