“google-admin2_email_migration” 库允许访问 Google admin 服务中的所有功能。

本文档是从 admin 程序包版本 0.1.11+20150303 生成的，其中 20150303 是由 mako 代码生成器 v0.1.11 构建的 admin:email_migration_v2 模式的确切修订。

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

功能

从中心 枢纽 轻松处理以下 资源...

• 邮件
• 插入

支持通过 ... 上传

• 插入邮件

本库结构

API 结构如下主要项目

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些方法构建器再依次允许访问单个 调用构建器
• 资源
  • 主要类型，可以应用于 活动
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中 never 直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或具体地 ...

let r = hub.mail().insert(...).doit()

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

用法

设置您的项目

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

[dependencies]
google-admin2_email_migration = "*"

完整示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_admin2_email_migration as admin2_email_migration;
use admin2_email_migration::MailItem;
use admin2_email_migration::{Result, Error};
use std::fs;
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use admin2_email_migration::Admin;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Admin::new(hyper::Client::new(), 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 = MailItem::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload(...)`.
// Values shown here are possibly random and not representative !
let result = hub.mail().insert(req, "userKey")
             .upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap());

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::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(...)。

自定义和回调

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