jreidthompson/exchanger

Ruby client for Exchange Web Services

Exchanger

Ruby library for accessing Microsoft Exchange using Exchange Web Services. This library tries to make creating and updating items as easy as possible. It will keep track of changed properties and will update only them.

Supported operations

• FindItem, GetItem, CreateItem, UpdateItem, DeleteItem
• FindFolder, GetFolder
• ResolveNames, ExpandDL
• GetUserAvailability

Installing

gem install exchanger

Configuration

Exchanger.configure do |config|
  config.endpoint = "https://domain.com/EWS/Exchanger.asmx"
  config.username = "username"
  config.password = "password"
end

or configure from YAML

Exchanger::Config.instance.from_hash(YAML.load_file("#{Rails.root}/config/exchanger.yml")[Rails.env])

Examples

Creating and updating contacts

folder = Exchanger::Folder.find(:contacts)
contact = folder.new_contact
contact.given_name = "Edgars"
contact.surname = "Beigarts"
contact.email_addresses = [ Exchanger::EmailAddress.new(:key => "EmailAddress1", :text => "[email protected]") ]
contact.phone_numbers = [ Exchanger::PhoneNumber.new(:key => "MobilePhone", :text => "[phone]") ]
contact.save # CreateItem operation
contact.company_name = "Example Inc."
contact.save # UpdateItem operation
contact.destroy # DeleteItem operation

Searching in Global Address Book

mailboxes = Exchanger::Mailbox.search("John")

Running specs with Exchange Server

The easiest way is to sign up for a Microsoft Office 365 free trial.

1. Create a random calendar entry in July 2016
2. Create a distribution list named 'Test'
3. Create spec/config.yml with your Exchange credentials
4. Create spec/fixtures/get_user_availability.yml with your Exchange email address
5. Clear the recorded VCR cassettes by removing spec/cassettes
6. Run the specs rake spec

It looks like Office 365 trial has some rate limits, so you may have to record the VCR cassettes for each spec separately.

Exchanger::Operation::ResponseError:
  An internal server error occurred. Try again later.

Alternatives

• Exchange Clients in Ruby Toolbox