cardmagic / contacts

Click here to lend your support to: contacts and make a donation at www.pledgie.com !

A universal interface to import email contacts from various providers including Yahoo, Gmail, Hotmail, AOL and Plaxo.

This URL has Read+Write access

contacts / README
raw normal view history
a4a64892 » cardmagic 2008-03-21 first commit 1 == Welcome to Contacts
2
3 Contacts is a universal interface to grab contact list information from various providers including Hotmail, Gmail and Yahoo.
4
5 == Download
6
7 * gem install contacts
8 * http://rubyforge.org/projects/contacts
9 * svn co svn://rubyforge.org/var/svn/contacts
10
11 == Background
12
13 For a long time, the only way to get a list of contacts from your free online email accounts was with proprietary PHP scripts that would cost you $50. The act of grabbing that list is a simple matter of screen scrapping and this library gives you all the functionality you need. Thanks to the generosity of the highly popular Rails website MOG (http://mog.com) for allowing this library to be released open-source to the world. It is easy to extend this library to add new free email providers, so please contact the author if you would like to help.
14
15 == Usage
16
17 Contacts::Hotmail.new(login, password).contacts # => [["name", "foo@bar.com"], ["another name", "bow@wow.com"]]
18 Contacts::Yahoo.new(login, password).contacts
19 Contacts::Gmail.new(login, password).contacts
20
21 Contacts.new(:gmail, login, password).contacts
22 Contacts.new(:hotmail, login, password).contacts
23 Contacts.new(:yahoo, login, password).contacts
24
25 Contacts.guess(login, password).contacts
26
27 Notice there are three ways to use this library so that you can limit the use as much as you would like in your particular application. The Contacts.guess method will automatically concatenate all the address book contacts from each of the successful logins in the case that a username password works across multiple services.
28
29 == Examples
30
31 See the examples/ directory.
32
33 == Authors
34
35 * Lucas Carlson from MOG (mailto:lucas@rufy.com) - http://mog.com
36
37 == Contributors
38
39 * Britt Selvitelle from Twitter (mailto:anotherbritt@gmail.com) - http://twitter.com
40 * Tony Targonski from GigPark (mailto:tony@gigpark.com) - http://gigpark.com
41
42 This library is released under the terms of the BSD.
43