42 个版本 (24 个稳定版)

5.0.5+20240624	2024 年 6 月 27 日
5.0.4+20240226	2024 年 3 月 5 日
5.0.3+20230116	2023 年 8 月 23 日
5.0.2+20230116	2023 年 3 月 16 日
0.1.2+20150313	2015 年 3 月 25 日

在网页编程中排名 2371

每月下载量 423 次
用于 3 个库（其中 2 个直接使用）

MIT 许可证

1.5MB
16K SLoC

google-gmail1 库允许访问 Google Gmail 服务的所有功能。

此文档由 Gmail 库版本 5.0.5+20240624 生成，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 gmail:v1 模式的确切修订版本。

有关 Gmail v1 API 的其他所有信息可以在官方文档网站找到。

功能

从中央中心简单地处理以下资源 ...

支持上传 ...

本库的结构

API 被组织成以下主要项目

中心
- 一个中心对象，用于维护状态并允许访问所有活动
- 创建 方法构建器，这些构建器反过来允许访问单个 调用构建器
资源
- 可以将活动应用于其上的主要类型
- 一组属性和部分
- 部分
  - 一组属性
  - 永远不会在活动中直接使用
活动
- 应用于资源的操作

所有结构都标记了适用的特性，以进一步分类它们并简化浏览。

一般来说，您可以像这样调用活动

let r = hub.resource().activity(...).doit().await

或具体地 ...

let r = hub.users().drafts_send(...).doit().await
let r = hub.users().messages_get(...).doit().await
let r = hub.users().messages_import(...).doit().await
let r = hub.users().messages_insert(...).doit().await
let r = hub.users().messages_modify(...).doit().await
let r = hub.users().messages_send(...).doit().await
let r = hub.users().messages_trash(...).doit().await
let r = hub.users().messages_untrash(...).doit().await

资源（resource）和活动（activity）调用创建了构建器。第二个处理Activities，支持配置即将进行的操作（此处未展示）的各种方法。它是这样设计的，即所有必需的参数必须立即指定（即 (...)），而所有可选的参数都可以按需构建。doit()方法执行与服务器实际的通信并返回相应的结果。

用法

设置您的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

[dependencies]
google-gmail1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gmail1 as gmail1;
use gmail1::api::Message;
use gmail1::{Result, Error};
use std::fs;
use std::default::Default;
use gmail1::{Gmail, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Gmail::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Message::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload_resumable(...)`.
// Values shown here are possibly random and not representative !
let result = hub.users().messages_import(req, "userId")
             .process_for_calendar(true)
             .never_mark_spam(false)
             .internal_date_source("amet.")
             .deleted(true)
             .upload_resumable(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

系统产生的所有错误都作为 Result 枚举提供，作为 doit() 方法的返回值，或者作为可能的中级结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对各种错误都具有弹性。

上传和下载

如果某个方法支持下载，那么应该读取响应体以获取媒体，该响应体是 Result 的一部分。如果该方法还支持 Response Result，它将默认返回该值。您可以将它视为实际媒体的元数据。要触发媒体下载，您必须通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用多达 2 种不同的协议：简单和 可重传。每种协议的独特性都由定制的 doit(...) 方法表示，这些方法分别命名为 upload(...) 和 upload_resumable(...)。

自定义和回调

您可以通过在最终调用 doit() 之前向 Method Builder 提供一个 delegate 来更改 doit() 方法调用的方式。相应的方法将被调用以提供进度信息，以及确定系统是否应在失败时重试。

delegate trait 有默认实现，允许您以最少的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都设计为可通过编码和解码为 json 格式。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被视为部分，可以通过名称识别，这些部分将被发送到服务器以指示请求或响应中所需的部分。

构建器参数

通过使用方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受一个参数，以下陈述是正确的。

PODs 通过复制传递
字符串作为 &str 传递
请求值被移动

参数将始终被复制或克隆到构建器中，以确保它们与其原始生命周期独立。

Cargo 功能

utoipa - 添加对 utoipa 的支持，并从所有类型中派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型，否则生成的 openapi 规范将是无效的。

许可证

gmail1 库由 Sebastian Thiel 制作，并置于 MIT 许可证之下。您可以在仓库的许可证文件中阅读全文。

依赖关系

~12–23MB
~345K SLoC