TweetFollow Us on Twitter

Introduction to Scripting Address Book

Volume Number: 21 (2005)
Issue Number: 10
Column Tag: Programming

AppleScript Essentials

Introduction to Scripting Address Book

by Benjamin S. Waldie

If you have a large number of contacts in your contact management application, then you are probably already aware that maintaining your existing contacts, adding new ones, removing outdated ones, etc., can quickly become a time consuming process. Yet again, AppleScript is ready to come to your rescue. Using AppleScript and Address Book in Mac OS X, you can begin to automate the process of adding and removing contacts, creating groups, and even more.

Throughout this article, we will discuss a number of techniques for automating aspects of Address Book in Mac OS X. Once you have an understanding of these basic techniques, you can begin combining them together, in order to automate your contact management workflow on a larger scale.

Figure 1 shows an example of an Address Book person, which has been created and added to a new group, all with AppleScript. The code that was used to create this entry and group was developed using the example code snippets that are provided throughout this article.

Please note that all code specified in this article was developed using Address Book version 4.0.2 in Mac OS X 10.4.x Tiger. Due to AppleScript terminology changes between versions of Address Book, some code may be slightly different, or may not function properly if you are using an older version of Address Book.

Working with People

Making a New Person

To create a new person in Address Book, use the make command, which can be found in the Standard Suite in Address Book's AppleScript dictionary. While using this command, you may also specify values for various properties of the person. This is demonstrated in the following code, which will create a new person, while assigning values to the first name, last name, organization, and job title properties.


Figure 1. A Person Created by a Script in a Specific Group

tell application "Address Book"		
   set thePerson to make new person with properties 
   {first name:"Ben", last name:"Waldie", organization:"Automated Workflows, 
   LLC", job title:"President"}
end tell
--> person id "778C4D8D-0A22-4918-A5B6-73361FFF8779:ABPerson" of application "Address Book"

The result of the make command is a reference to the newly created class. In the example code above, we have captured this reference in a variable named thePerson. This variable may now be referenced in future code, so that we may add email addresses, phone numbers, and more to the newly created person.

When writing code that interacts with Address Book, you might notice that Address Book's display is not immediately updated. Rather, it may take several seconds for the new person to appear. To force Address Book to update its display immediately, you may use the save addressbook command. For example:

save addressbook

It is good practice to use this command regularly in an Address Book script, in order to ensure that the display always shows the current information, as well as to prevent data loss in the unlikely event of an application crash.

Adding Email Addresses

In Address Book, email addresses, URL's, phone numbers, and addresses are not properties of a person. Rather, they are classes themselves, and are contained as elements of a person. The following example code demonstrates how to add an email address to a specified person.

make new email at end of emails of thePerson with properties 
{label:"Work", value:"applescriptguru@mac.com"}

In the example code above, the label property of the email address indicates the label text that will precede the email address in the person's address card in Address Book's interface. For example, an email address label might read "Work", "Home", "Other", etc. As you will see in some additional examples throughout this article, many other classes in Address Book also possess a label property.

Adding URL's

The method for adding a URL to a person is generally the same as that for adding an email address. The following example code demonstrates how to add a work URL to a specified person in Address Book.

make new url at end of urls of thePerson with properties 
{label:"Work", value:"http://www.automatedworkflows.com"}

Adding Phone Numbers

The following example code demonstrates how to add a work phone number to a specified person in Address Book. Again, as you can see, this code is generally the same as that for adding email addresses or URL's to a person.

make new phone at end of phones of thePerson with properties 
{label:"Work", value:"610.935.0652"}

Adding Addresses

Adding an address to a person is slightly different than the process of adding an email address, a URL, or a phone number. While you can still specify a label property for an address, addresses also possess many other properties. For example, in an address entry, you may specify a street, city, state, zip code, and more. The following example code demonstrates how to add a work address to a specified person in Address Book.

make new address at end of addresses of thePerson with properties 
{label:"Work", street:"123 Anystreet", city:"Anytown", state:"PA", zip:"99999"}

Finding a Person

In some cases, you may not actually want to create a person. Rather, you may want to locate an existing person. One way to access an existing person is by accessing the selection property of the Address Book application. This will return a list of any selected people. The following example code demonstrates how to retrieve the selection.

set thePeople to selection
--> {person id "778C4D8D-0A22-4918-A5B6-73361FFF8779:ABPerson" of application "Address Book"}

However, you may not always want to access the selected person or people. There may be times when you need to locate a person by name, or by another criteria. The following example code demonstrates how to search for specific people by retrieving a list of people matching a given last name.

set thePeople to every person whose last name = "Waldie"
--> {person id "778C4D8D-0A22-4918-A5B6-73361FFF8779:ABPerson" of application "Address Book"}

Retrieving Information for a Person

Once you have retrieved a list of people in Address Book, you will more than likely want to retrieve information about those people, such as their names, email addresses, etc. For starters, the following code demonstrates how you can retrieve a list of all properties of a specified person.

properties of (item 1 of thePeople)
--> {first name:"Ben", maiden name:missing value, 
id:"E9A1B78D-AE19-46D1-98A8-76ADB82E4C49:ABPerson", modification date:..

You may also retrieve the properties of specific elements of a person. For example, the following example code will retrieve properties of any email addresses of a specified person.

properties of emails of (item 1 of thePeople) -->
{{id:"9495797E-3942-4CA2-9EB7-A85CC1420A40", 
class:email, label:"work",value:"applescriptguru@mac.com"}}

Similar to the previous example code, the following example code demonstrates how to retrieve the properties of any phone numbers of a specified person.

properties of phones of (item 1 of thePeople) -->
{{id:"5D411959-09F0-4A65-82FA-01449FD50268", class:phone, label:"work", value:"610.935.0652"}}

Working with Groups

In Address Book, groups are also an important part of contact management. Groups allow you to organize your contacts into sets of contacts, all related in some manner of your choosing. Like people, groups in Address Book are also accessible via scripting.

Making a New Group

In a manner similar to that for creating a new person, the make command may be used to create a new group. For example:

set theGroup to make new group with properties {name:"My Group"} --> group id
"D988FC9B-62FC-4ABA-9C70-E5F5821D2724:ABGroup" of application "Address Book"

As mentioned previously, the result of the make command is a reference to the newly created class. In the case above, this reference is placed into a variable named theGroup, which may be accessed later in your code.

Adding a Person to a Group

To add a person to a group in Address Book, you may use the add command. The following example code demonstrates how to add a person to a group that is referenced through the variable theGroup.

add thePerson to theGroup

Alternatively, you may choose to add a person to a group directly, rather than through the use of a variable. For example:

add thePerson to group "My Group"

Removing a Person from a Group

Removing a person from a group is just as straightforward as adding a person to a group. To remove a person from a specified group, you may use the remove command. The following example code demonstrates the proper use of this code.

remove thePerson from group "My Group"

Again, as mentioned in a tech block earlier in this article, be sure to use the save addressbook command regularly throughout your code, in order to ensure that Address Book's display is immediately updated when creating groups, adding people to groups, or removing people from groups.

Retrieving a List of Groups

There may also be times when you need to retrieve a listing of groups in Address Book. The following example code demonstrates how to retrieve a list of references to any existing groups.

groups -->
{group id "D988FC9B-62FC-4ABA-9C70-E5F5821D2724:ABGroup" of application "Address Book"}

If you prefer to retrieve only the names of the groups in Address Book, the following example code may be used.

name of every group 
--> {"My Group"}

Pulling It Together

Using the sample code and techniques that were discussed thus far throughout this article, you should now be able to start building some basic Address Book scripts, which can be expanded and integrated into a larger workflow. For example, you could develop a script that will extract contact information from a database or from an email message, and then use that content to automatically add or update contacts in your Address Book.

The example code below provides a basic demonstration of how code elements and techniques specified in this article can be pulled together to form a single script. The following example will create a new person, complete with a work email address, URL, phone number, and address.

tell application "Address Book"
   set thePerson to make new person with properties 
      {first name:"Ben", last name:"Waldie", organization:"Automated Workflows, LLC", 
      job title:"President"}
   tell thePerson
      make new email at end of emails with properties {label:"Work", 
         value:"applescriptguru@mac.com"}
      make new url at end of urls with properties 
         {label:"Work", value:"http://www.automatedworkflows.com"}
      make new phone at end of phones with properties {label:"Work", value:"610.935.0652"}
      make new address at end of addresses with properties 
         {label:"Work", street:"123 Anystreet", city:"Anytown", state:"PA", zip:"99999"}
   end tell
   make new group with properties {name:"My Group"}
   add thePerson to group "My Group"
   save addressbook
end tell

Address Book Plug-Ins

When browsing the Address Book Script Suite in Address Book's AppleScript dictionary, you may notice the action property, action title, perform action, and should enable action commands. See figure 2.


Figure 2. Address Book Plug-In Handlers

These commands are actually handlers, which may be added to a script in order to create an Address Book plug-in script. An Address Book plug-in script is a script that may be triggered from a rollover button. Rollover buttons are popup buttons, which appear when a user drags the mouse pointer over and clicks on certain labels, including phone numbers, email addresses, addresses, and more, on a person's Address Book card.

The following is example code for an Address Book plug-in. This plug-in will add a new menu item, called "Speak Phone Number" to the rollover button popup menu for each phone number of a person in Address Book. See figure 3.


Figure 3. Accessing an Address Book Plug-In Script

Whenever the "Speak Phone Number" menu item is selected, the corresponding phone number's digits will be spoken, using the say command.

The say command may be found in the User Interaction Suite of the Standard Additions scripting addition.

using terms from application "Address Book"
   on action property
      return "phone"
   end action property

   on should enable action for thePerson with theEntry
      if theEntry <> missing value then
         return true
      else
         return false
      end if
   end should enable action

   on action title for thePerson with theEntry
      return "Speak Phone Number"
   end action title

   on perform action for thePerson with theEntry
      set thePhoneNumber to value of theEntry
      repeat with a from 1 to length of thePhoneNumber
         set theCharacter to character a of thePhoneNumber
         if "0123456789" contains theCharacter then say theCharacter
      end repeat
   end perform action
end using terms from

We will now take a few moments to walk through the different handlers in the code above.

action property Handler

This handler is called when the mouse pointer first rolls over a label that serves as a rollover button, after Address Book has been launched. When triggered, the handler should return a string indicating the type of rollover button under which the script should be displayed. Options may include phone, email, address, and more.

should enable action Handler

This handler is invoked when the user actually clicks on the rollover button on a person's card. Once triggered, this handler should return a boolean value indicating whether the plug-in script may be available for the currently selected rollover. The example code above uses this opportunity to verify that the value of the phone number is not a missing value. If it is a missing value, then the menu item will not be enabled in the rollover button popup menu.

action title Handler

This handler is also triggered when the user clicks on the rollover button, but after the should enable action handler is triggered, if present. This handler should return as its result the name of the menu item that should be displayed in the rollover button popup menu.

perform action Handler

This handler is triggered when the user selects the menu item from the rollover popup menu. A reference to the selected person, as well as the selected data on which the rollover button was clicked, are passed to the handler as parameters. Add your processing code to this handler to perform the desired function.

Installing an Address Book Plug-In Script

Once you have written your Address Book plug-in script, save it as a compiled script into the Library > Address Book Plug-Ins folder at the local or user level of your hard drive. Next, re-launch the Address Book application to load the plug-in script and begin using it.

In Closing

As you are probably aware, there are other applications available for the Macintosh that provide contact management capabilities, many of which are AppleScriptable. Microsoft Entourage, Eudora, Now Up-To-Date & Contact are a few of such programs. If you are not an Address Book user, you are encouraged to explore your favorite contact management application, in order to determine whether it is scriptable. If it is scriptable, while the AppleScript terminology will be different, many of the tasks discussed in this article may still be possible to automate.

Regarding Address Book, the examples shown throughout this article should help you to begin automating some basic Address Book functions. You are encouraged to begin integrating these examples into your own custom scripts, and exploring some of the other possibilities for automating Address Book, which may not have been discussed in this article.

Until next time, keep scripting!


Ben Waldie is author of the best selling books "AppleScripting the Finder" and the "Mac OS X Technology Guide to Automator", available from http://www.spiderworks.com. Ben is also president of Automated Workflows, LLC, a firm specializing in AppleScript and workflow automation consulting. For years, Ben has developed professional AppleScript-based solutions for businesses including Adobe, Apple, NASA, PC World, and TV Guide. For more information about Ben, please visit http://www.automatedworkflows.com, or email Ben at applescriptguru@mac.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple Pro Video Formats 2.0.2 - Updates...
Apple Pro Video Formats brings updates to Apple's professional-level codes for Final Cut Pro X, Motion 5, and Compressor 4. Version 2.0.2: Includes support for the following professional video codecs... Read more
Apple Final Cut Pro X 10.2.2 - Professio...
Apple Final Cut Pro X is a professional video editing solution.Completely redesigned from the ground up, Final Cut Pro adds extraordinary speed, quality, and flexibility to every part of the post-... Read more
Apple Compressor 4.2.1 - Adds power and...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Powerful... Read more
Apple Motion 5.2.2 - Create and customiz...
Apple Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time... Read more
A Better Finder Rename 10.00b1 - File, p...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
CrossOver 14.1.6 - Run Windows apps on y...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more
Printopia 2.1.14 - Share Mac printers wi...
Run Printopia on your Mac to share its printers to any capable iPhone, iPad or iPod Touch. Printopia will also add virtual printers, allowing you to save print-outs to your Mac and send to apps.... Read more
Google Drive 1.24 - File backup and shar...
Google Drive is a place where you can create, share, collaborate, and keep all of your stuff. Whether you're working with a friend on a joint research project, planning a wedding with your fiancé, or... Read more
Chromium 45.0.2454.85 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 45.0.2454.85: Note: Does not contain the "... Read more
OmniFocus 2.2.5 - GTD task manager with...
OmniFocus helps you manage your tasks the way that you want, freeing you to focus your attention on the things that matter to you most. Capturing tasks and ideas is always a keyboard shortcut away in... Read more

Zen Brush 2 (Entertainment)
Zen Brush 2 1.0 Device: iOS Universal Category: Entertainment Price: $2.99, Version: 1.0 (iTunes) Description: Zen Brush 2 is a drawing app focused on the strong yet beautiful feel of the East Asian ink brush. | Read more »
NetNewsWire (News)
NetNewsWire 4.0.0 Device: iOS iPhone Category: News Price: $3.99, Version: 4.0.0 (iTunes) Description: Follow the Web NetNewsWire 4, completely written from the ground up for iPhone. NetNewsWire is the best way to keep up with the... | Read more »
Huzzah! Farming Simulator 16 Supports Cl...
As though it weren't difficult enough to resist the siren call of Farming Simulator 16, now it's been updated with cloud saves - so you can jump between devices without missing any of that precious crop-harvesting time. [Read more] | Read more »
Don't Starve: Pocket Edition Finall...
I've made no effort to hide my enjoyment of Don't Starve: Pocket Edition, but I will admit I was a tiny bit disappointed that it was only available for the iPad. Well nuts to that, because Klei Entertainment has made it universal! [Read more] | Read more »
Goat Simulator Wasn't Enough? Then...
If you just didn't get enough goat in Goat Simulator - or if you've been wanting to play a simulated MMO as a microwave - then you're in luck! Goat Simulator MMO Simulator is out now, and it's a game about simulated goats in simulated MMOs. Plus... | Read more »
You Can Play Madfinger Games' Unkil...
Madfinger Games - probably best known for the Dead Trigger series - has officially launched their newest zombie shooter (that isn't called Dead Trigger), named Unkilled. [Read more] | Read more »
KORG iELECTRIBE for iPhone (Music)
KORG iELECTRIBE for iPhone 1.0.1 Device: iOS iPhone Category: Music Price: $9.99, Version: 1.0.1 (iTunes) Description: ** 50% OFF Special Launch Sale - For a Limited Time **The ELECTRIBE reborn in an even smaller form A full-fledged... | Read more »
Toca Life: City Just Got a Bunch of New...
Toca Life: City is Toca Boca's most popular app (number 1 in 47 different countries, apparently), and it's just had an update that adds a bunch of new content. [Read more] | Read more »
My Country 3D is More About Cities than...
My Country 3D is an upcoming city builder from Game Insight that looks pretty decent - although the name seems a tad out of whack for a city builder. Ah well, it is what it is. [Read more] | Read more »
I am Bread (Games)
I am Bread 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: ‘I am Bread’ is the latest quirky adventure from the creators of 'Surgeon Simulator', Bossa Studios. This isn't the best thing... | Read more »

Price Scanner via MacPrices.net

Near-Office Input Functionality Virtually Any...
Today Logitech introduced the Logitech K380 Multi-Device Bluetooth Keyboard and the Logitech M535 Bluetooth Mouse, giving users the freedom to work on any device, most anywhere. According to... Read more
College Student Deals: Additional $100 off Ma...
Take an additional $100 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through September 4, 2015. Anyone with a valid .EDU email address can take... Read more
2.8GHz Mac mini available for $988, includes...
Adorama has the 2.8GHz Mac mini available for $988, $11 off MSRP, including a free copy of Apple’s 3-Year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax in NY & NJ... Read more
Will You Buy An iPad Pro? – The ‘Book Mystiqu...
It looks like we may not have to wait much longer to see what finally materializes as a new, larger-panel iPad (Pro/Plus?) Usually reliable Apple product prognosticator KGI Securities analyst Ming-... Read more
eFileCabinet Announces SMB Document Managemen...
Electronic document management (EDM) eFileCabinet, Inc., a hosted solutions provider for small to medium businesses, has announced that its SecureDrawer and eFileCabinet Online services will be... Read more
WaterField Designs Unveils American-Made, All...
San Francisco’s WaterField Designs today unveiled their all-leather Cozmo 2.0 — an elegant attach laptop bag with carefully-designed features to suit any business environment. The Cozmo 2.0 is... Read more
Apple’s 2015 Back to School promotion: Free B...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
128GB MacBook Airs on sale for $100 off MSRP,...
B&H Photo has 11″ & 13″ MacBook Airs with 128GB SSDs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/128GB MacBook Air: $799.99, $100 off MSRP... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.... Read more
27-inch 3.2GHz iMac on sale for $1679, save $...
B&H Photo has the 27″ 3.2GHz iMac on sale for $1679.99 including free shipping plus NY sales tax only. Their price is $120 off MSRP. Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Content Partner Engineer - *Apple* TV - App...
**Job Summary** The Apple TV team is looking for an experienced engineer with a passion for delivering first in class home entertainment solutions. The candidate will Read more
*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
*Apple* Retail - Multiple Customer Support P...
Job Description: Customer Support Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the Read more
*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.