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

Lyn 1.5.11 - Lightweight image browser a...
Lyn is a lightweight and fast image browser and viewer designed for photographers, graphic artists and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it... Read more
NeoOffice 2014.11 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
LaunchBar 6.4 - Powerful file/URL/email...
LaunchBar is an award-winning productivity utility that offers an amazingly intuitive and efficient way to search and access any kind of information stored on your computer or on the Web. It provides... Read more
Remotix 3.1.4 - Access all your computer...
Remotix is a fast and powerful application to easily access multiple Macs (and PCs) from your own Mac. Features Complete Apple Screen Sharing support - including Mac OS X login, clipboard... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
VOX 2.5.1 - Music player that supports m...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more
NetNewsWire 4.0.0 - RSS and Atom news re...
NetNewsWire is the best way to keep up with the sites and authors you read most regularly. Let NetNewsWire pull down the latest articles, and read them in a distraction-free and Mac-like way. Native... Read more
MacUpdate Desktop 6.0.6 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
ForkLift 2.6.5 - Powerful file manager:...
ForkLift is a powerful file manager and ferociously fast FTP client clothed in a clean and versatile UI that offers the combination of absolute simplicity and raw power expected from a well-executed... Read more
Drive Genius 4.1.0 - Powerful system uti...
Drive Genius 4 gives you faster performance from your Mac while also protecting it. The award-winning and improved DrivePulse feature alerts you to hard drive issues before they become major problems... Read more

Biz Builder Delux (Games)
Biz Builder Delux 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Ah, there's nothing like the rhythmic bustle of a burgeoning business burg... especially when you're the one building it... | Read more »
Auroch Digital is Bringing Back Games Wo...
| Read more »
Carbo - Handwriting in the Digital Age...
Carbo - Handwriting in the Digital Age 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Draggy Dead (Games)
Draggy Dead 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Ditch your dead end job and take up a rewarding career in Grave Robbing today!Guide the recently deceased to a fun filled life of... | Read more »
Bad Dinos (Games)
Bad Dinos 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: | Read more »
The Apple Watch isn't Great as a Fi...
| Read more »
Show the World What You See With Stre.am...
Live broadcasting is getting popular on mobile devices, which is why you can now get Stre.am, by Infinite Takes. [Read more] | Read more »
PhotoTime's 2.1 Update Adds Apple W...
The latest PhotoTime update is adding even more functionality to the handy photo organizing app. Yep, including Apple Watch support. [Read more] | Read more »
Oh My Glob! Adventure Time Puzzle Quest...
Finn and Jake are taking over D3 Go!'s popular puzzle game series in the upcoming Adventure Time Puzzle Quest. [Read more] | Read more »
Earthcore: Shattered Elements - Tips, Tr...
At first glance, Earthcore: Shattered Elements seems like a rather simple card-battling game. Once you’re introduced to skills that will change quite a bit. Even more so once you start to acquire hero cards. But it’s not so complicated that we... | Read more »

Price Scanner via MacPrices.net

OtterBox Maximizes Portability, Productivity...
From the kitchen recipe book to the boarsroom presentation, the OtterBox Agility Tablet System turns tablets into one of the most versatile pieces of handheld technology available. Available now, the... Read more
Launch of New Car App Gallery and Open Develo...
Automatic, a company on a mission to bring the power of the Internet into every car, has announced the launch of the Automatic App Gallery, an app store for nearly every car or truck on the road... Read more
Memorial Day Weekend Sale: 13-inch 1.6GHz Mac...
Best Buy has the new 13″ 1.6GHz/128GB MacBook Air on sale for $849 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Memorial Day Weekend Sale: 27-inch 3.5GHz 5K...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2099.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary.... Read more
Sale! 16GB iPad mini 3 for $349, save $50
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Price drop on 2014 15-inch Retina MacBook Pro...
B&H Photo has dropped prices on 2014 15″ Retina MacBook Pros by $200. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799.99 save $200 - 15″ 2.5GHz... Read more
With a Mission to Make Mobile Free, Scratch W...
Scratch Wireless, claiming to be the world’s first truly free mobile service, has announced the availability of a new Scratch-enabled Android smartphone, the Coolpad Arise. The smartphone is equipped... Read more
First-Ever Titanium Alloy Curved iPhone 6 Scr...
One of the most common problems with mobile phones is damage to the screens. The slightest drop can cause a dreaded spider web of gashes and cracks in the glass panel surface that can cost $hundreds... Read more
Preorder new 12-inch MacBook, $10 off, save o...
Adorama has new 12″ Retina MacBooks available for preorder for $10 off MSRP including free shipping plus NY & NJ sales tax only. For a limited time, Adorama will include a free Apple USB-C to USB... Read more
Will iOS 9 Finally Bring Productivity Friendl...
Ah, the irony. From its original announcement in 2010, Apple has doggedly insisted that the iPad remain “simple,” thus arbitrarily limiting its considerable potential as a content creation and... Read more

Jobs Board

*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
Business Development Manager - *Apple* Pay...
**Job Summary** Apple Pay is seeking an experienced Business Development professional to join the Apple Pay team to develop partnerships and strategic alliances with Read more
Project Manager, *Apple* Retail New Store O...
**Job Summary** An Apple Retail New Store Openings & Remodels Project Manager is responsible for successfully managing the openings, remodels, and small works of Read more
SW QA Engineer - *Apple* TV - Apple (United...
**Job Summary** The Apple TV team is looking for experienced Quality Assurance Engineers with a passion for delivering first in class home entertainment solutions. **Key Read more
Partner Marketing Manager - *Apple* Pay - A...
**Job Summary** The Apple Pay partner marketing team is looking for a marketing manager to develop and drive US marketing programs with our financial institution Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.