gmail1 命令行界面（CLI）允许您在终端中舒适地使用Google Gmail服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其定向到文件，而不依赖于您的shell功能。错误将打印到标准错误，并将导致程序退出代码不为零。

如果请求数据结构，则这些结构将作为格式化的JSON返回，以便作为其他工具的输入。

有关Gmail API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-gmail1-cli

在github上查找源代码。

用法

此文档是从版本为20240226的Gmail API生成的。CLI版本为5.0.4。

gmail1 [options]
        users
                drafts-create <user-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                drafts-delete <user-id> <id> [-p <v>]...
                drafts-get <user-id> <id> [-p <v>]... [-o <out>]
                drafts-list <user-id> [-p <v>]... [-o <out>]
                drafts-send <user-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                drafts-update <user-id> <id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                get-profile <user-id> [-p <v>]... [-o <out>]
                history-list <user-id> [-p <v>]... [-o <out>]
                labels-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                labels-delete <user-id> <id> [-p <v>]...
                labels-get <user-id> <id> [-p <v>]... [-o <out>]
                labels-list <user-id> [-p <v>]... [-o <out>]
                labels-patch <user-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                labels-update <user-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                messages-attachments-get <user-id> <message-id> <id> [-p <v>]... [-o <out>]
                messages-batch-delete <user-id> (-r <kv>)... [-p <v>]...
                messages-batch-modify <user-id> (-r <kv>)... [-p <v>]...
                messages-delete <user-id> <id> [-p <v>]...
                messages-get <user-id> <id> [-p <v>]... [-o <out>]
                messages-import <user-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                messages-insert <user-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                messages-list <user-id> [-p <v>]... [-o <out>]
                messages-modify <user-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                messages-send <user-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                messages-trash <user-id> <id> [-p <v>]... [-o <out>]
                messages-untrash <user-id> <id> [-p <v>]... [-o <out>]
                settings-cse-identities-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-cse-identities-delete <user-id> <cse-email-address> [-p <v>]...
                settings-cse-identities-get <user-id> <cse-email-address> [-p <v>]... [-o <out>]
                settings-cse-identities-list <user-id> [-p <v>]... [-o <out>]
                settings-cse-identities-patch <user-id> <email-address> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-cse-keypairs-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-cse-keypairs-disable <user-id> <key-pair-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-cse-keypairs-enable <user-id> <key-pair-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-cse-keypairs-get <user-id> <key-pair-id> [-p <v>]... [-o <out>]
                settings-cse-keypairs-list <user-id> [-p <v>]... [-o <out>]
                settings-cse-keypairs-obliterate <user-id> <key-pair-id> (-r <kv>)... [-p <v>]...
                settings-delegates-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-delegates-delete <user-id> <delegate-email> [-p <v>]...
                settings-delegates-get <user-id> <delegate-email> [-p <v>]... [-o <out>]
                settings-delegates-list <user-id> [-p <v>]... [-o <out>]
                settings-filters-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-filters-delete <user-id> <id> [-p <v>]...
                settings-filters-get <user-id> <id> [-p <v>]... [-o <out>]
                settings-filters-list <user-id> [-p <v>]... [-o <out>]
                settings-forwarding-addresses-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-forwarding-addresses-delete <user-id> <forwarding-email> [-p <v>]...
                settings-forwarding-addresses-get <user-id> <forwarding-email> [-p <v>]... [-o <out>]
                settings-forwarding-addresses-list <user-id> [-p <v>]... [-o <out>]
                settings-get-auto-forwarding <user-id> [-p <v>]... [-o <out>]
                settings-get-imap <user-id> [-p <v>]... [-o <out>]
                settings-get-language <user-id> [-p <v>]... [-o <out>]
                settings-get-pop <user-id> [-p <v>]... [-o <out>]
                settings-get-vacation <user-id> [-p <v>]... [-o <out>]
                settings-send-as-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-send-as-delete <user-id> <send-as-email> [-p <v>]...
                settings-send-as-get <user-id> <send-as-email> [-p <v>]... [-o <out>]
                settings-send-as-list <user-id> [-p <v>]... [-o <out>]
                settings-send-as-patch <user-id> <send-as-email> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-send-as-smime-info-delete <user-id> <send-as-email> <id> [-p <v>]...
                settings-send-as-smime-info-get <user-id> <send-as-email> <id> [-p <v>]... [-o <out>]
                settings-send-as-smime-info-insert <user-id> <send-as-email> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-send-as-smime-info-list <user-id> <send-as-email> [-p <v>]... [-o <out>]
                settings-send-as-smime-info-set-default <user-id> <send-as-email> <id> [-p <v>]...
                settings-send-as-update <user-id> <send-as-email> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-send-as-verify <user-id> <send-as-email> [-p <v>]...
                settings-update-auto-forwarding <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-update-imap <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-update-language <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-update-pop <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                settings-update-vacation <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                stop <user-id> [-p <v>]...
                threads-delete <user-id> <id> [-p <v>]...
                threads-get <user-id> <id> [-p <v>]... [-o <out>]
                threads-list <user-id> [-p <v>]... [-o <out>]
                threads-modify <user-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                threads-trash <user-id> <id> [-p <v>]... [-o <out>]
                threads-untrash <user-id> <id> [-p <v>]... [-o <out>]
                watch <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
  gmail1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，文件名以gmail1-开头。您可以使用--config-dir标志在每个调用上更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数API要求用户对任何请求进行身份验证。如果是这样，作用域 确定了授予的权限集。这些权限的粒度通常不超过只读或完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如在调用只读方法时，它只会请求只读范围。您可以使用--scope标志直接指定范围。所有适用的范围都在各自方法的CLI文档中有说明。

首次使用范围时，会要求用户授权。根据CLI的说明授权或拒绝。

如果用户验证了范围，相应的信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/gmail1-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销授权，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要使用Google开发者控制台进行注册。然后逐个启用该应用程序可能使用的API。大多数API都可以免费使用，并且有每日配额。

为了在不强制用户注册自己的应用程序的情况下，更方便地使用CLI，CLI自带了一个相应的默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/gmail1-secret.json，假设已为它启用了所需的gmail API。此类密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON处下载，并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽力提供可用的错误消息，但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以“原样”输出到标准错误。

带有--debug标志将使用Debug表示法将错误打印到标准错误。

您可以将标准错误重定向到文件，以便于使用，例如gmail1 --debug <resource> <method> [options] 2>debug.txt。