Viewpoint for Exchange Web Services 技术文档

1. 安装指南

安装环境要求

• Ruby 1.9 或更高版本
• Nokogiri gem

安装步骤

1. 使用 gem 命令安装 Viewpoint：

   gem install viewpoint
   

2. 确保你的 Ruby 环境已经安装了 Nokogiri：

   gem install nokogiri
   

2. 项目的使用说明

初始化客户端

首先，你需要初始化一个 Viewpoint::EWSClient 实例来连接到 Exchange Web Services。以下是初始化代码示例：

require 'viewpoint'
include Viewpoint::EWS

endpoint = 'https://example.com/ews/Exchange.asmx'
user = 'username'
pass = 'password'

cli = Viewpoint::EWSClient.new endpoint, user, pass

配置选项

• 忽略 SSL 验证：如果你在测试环境中使用自签名证书，可以通过以下方式忽略 SSL 验证：

  cli = Viewpoint::EWSClient.new endpoint, user, pass, http_opts: {ssl_verify_mode: 0}
  

• 指定 Exchange 版本：如果你需要与特定版本的 Exchange 服务器交互，可以指定服务器版本：

  cli = Viewpoint::EWSClient.new endpoint, user, pass, server_version: SOAP::ExchangeWebService::VERSION_2010_SP1
  

3. 项目API使用文档

文件夹操作

列出文件夹

• 列出所有根目录下的文件夹：

  folders = cli.folders
  

• 列出 Inbox 下的所有文件夹：

  inbox_folders = cli.folders root: :inbox
  

• 深度搜索根目录下的所有文件夹：

  all_folders = cli.folders root: :root, traversal: :deep
  

获取单个文件夹

• 通过 EWS ID 获取文件夹：

  cli.get_folder <folder_id>
  

• 通过符号获取标准文件夹：

  cli.get_folder :index
  

• 通过名称获取文件夹：

  cli.get_folder_by_name 'test'
  

• 在 Inbox 下通过名称获取子文件夹：

  cli.get_folder_by_name 'test', parent: :inbox
  

创建/删除文件夹

• 在根目录下创建文件夹：

  cli.make_folder 'myfolder'
  

• 在 Inbox 下创建文件夹：

  my_folder = cli.make_folder 'My Stuff', parent: :inbox
  

• 创建任务文件夹：

  tasks = cli.make_folder 'New Tasks', type: :tasks
  

• 删除文件夹：

  my_folder.delete!
  

项目操作

查找项目

• 获取 Inbox 中的所有项目：

  items = inbox.items
  

• 获取今天的项目：

  inbox.todays_items
  

• 获取自特定日期以来的项目：

  sd = Date.iso8601 '2013-01-01'
  inbox.items_since sd
  

• 获取两个日期之间的项目：

  sd = Date.iso8601 '2013-01-01'
  ed = Date.iso8601 '2013-02-01'
  inbox.items_between sd, ed
  

日历操作

获取用户的空闲/忙碌时间

• 查找用户在特定时间段的忙碌时间：

  require 'time'
  start_time = DateTime.parse("2013-02-19").iso8601
  end_time = DateTime.parse("2013-02-20").iso8601
  user_free_busy = cli.get_user_availability(['[e-mail]'],
    start_time: start_time,
    end_time:   end_time,
    requested_view: :free_busy)
  busy_times = user_free_busy.calendar_event_array
  

• 解析事件的开始/结束时间和类型：

  busy_times.each { | event |
    cli.event_busy_type(event)
    cli.event_start_time(event)
    cli.event_end_time(event)
  }
  

• 获取用户的工作时间：

  user_free_busy.working_hours
  

邮件操作

发送邮件

• 发送简单邮件：

  cli.send_message subject: "Test", body: "Test", to_recipients: ['[e-mail]']
  

• 使用块发送邮件：

  cli.send_message do |m|
    m.subject = "Test"
    m.body    = "Test"
    m.to_recipients << '[e-mail]'
    m.to_recipients << '[e-mail]'
  end
  

• 创建草稿邮件：

  cli.send_message subject: "Test", body: "Test", to_recipients: ['[e-mail]'], draft: true
  

4. 项目安装方式

通过 RubyGems 安装

gem install viewpoint

手动安装

1. 克隆项目仓库：

   git clone git://github.com/zenchild/Viewpoint.git
   

2. 进入项目目录并安装依赖：

   cd Viewpoint
   bundle install
   

3. 安装 gem：

   rake install
   

通过以上步骤，你可以成功安装并使用 Viewpoint for Exchange Web Services。