Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Component: Addressbook

Functions for the macOS addressbook.

You can use this to sync contacts from FileMaker database to system addressbook. As your addressbook can be synchronized via iCloud to iPhones or via Google/Exchange to any other devices, you only need one Mac to sync contacts to devices.

On Server you can only use addressbook functions if you got a addressbook for the user account where the server runs. Normally the server user account has no addressbook.
For 32-bit and 64-bit Mac application.

See contacts functions for newer API which works better with multple accounts.

Version macOS Windows Linux Server iOS SDK
3.1 / 8.2 ✅ Yes ❌ No ❌ No ❌ No 🔶 58%

Item Details
Addressbook.Account.Name   Deprecated
Queries name of account.
Mac only
6.2
Addressbook.Account.Type   Deprecated
Queries type identifier for account.
Mac only
6.2
Addressbook.Account.URL   Deprecated
Queries base URL for account.
Mac only
6.2
Addressbook.Account.isMainAccount   Deprecated
Queries whether this is main account.
Mac only
6.2
Addressbook.LocalizedPropertyOrLabel   Deprecated
Queries a localized name for a label or property.
Mac only
3.5
Addressbook.NewGroup   Deprecated
Creates a new group.
Mac/iOS
3.1
Addressbook.NewPerson   Deprecated
Creates a new person.
Mac/iOS
3.1
Addressbook.Notification.Clear   Deprecated
Clears the registered notification script.
Mac only
3.5
Addressbook.Notification.Evaluate   Deprecated
Installs a notification evaluate.
Mac only
6.2
Addressbook.Notification.GetChangedExternally   Deprecated
Queries if the last notification script call was caused by a changed in another app.
Mac only
3.5
Addressbook.Notification.GetDeletedRecords   Deprecated
Queries list of deleted records.
Mac only
3.5
Addressbook.Notification.GetInsertedRecords   Deprecated
Queries list of inserted records.
Mac only
3.5
Addressbook.Notification.GetProcessID   Deprecated
Queries the process ID.
Mac only
3.5
Addressbook.Notification.GetProcessName   Deprecated
Queries the process name.
Mac only
3.5
Addressbook.Notification.GetUpdatedRecords   Deprecated
Queries list of updated records.
Mac only
3.5
Addressbook.Notification.GetUserUID   Deprecated
Queries the user ID.
Mac only
3.5
Addressbook.Notification.Set   Deprecated
Installs a notification script.
Mac only
3.5
Addressbook.Record.Account   Deprecated
Queries account identifier for record.
Mac only
6.2
Addressbook.addRecord   Deprecated
Adds an person or group record to the Address Book database.
Mac/iOS
3.1
Addressbook.allAccounts   Deprecated
Queries list of account identifies for all accounts.
Mac only
6.2
Addressbook.defaultAccount   Deprecated
Queries default account identifier.
Mac only
6.2
Addressbook.enabledAccounts   Deprecated
Queries list of account identifies for enabled accounts.
Mac only
6.2
Addressbook.formattedAddress   Deprecated
Returns an attributed string containing the formatted address.
Mac only
3.1
Addressbook.group.addMember   Deprecated
Adds a person to a group.
Mac/iOS
3.1
Addressbook.group.addSubgroup   Deprecated
Adds a subgroup to another group.
Mac/iOS
3.1
Addressbook.group.members   Deprecated
Returns an array of persons in a group.
Mac/iOS
3.1
Addressbook.group.parentGroups   Deprecated
Returns an array containing a group's parents—that is, the groups that a group belongs to.
Mac only
3.1
Addressbook.group.removeMember   Deprecated
Removes a person from a group.
Mac/iOS
3.1
Addressbook.group.removeSubgroup   Deprecated
Removes a subgroup from a group.
Mac/iOS
3.1
Addressbook.group.subgroups   Deprecated
Returns an array containing a group's subgroups.
Mac only
3.1
Addressbook.groups   Deprecated
Returns an array of all the groups in the Address Book database.
Mac/iOS
3.1
Addressbook.hasUnsavedChanges   Deprecated
Indicates whether an address book has changes that have not been saved to the Address Book database.
Mac/iOS
3.1
Addressbook.me   Deprecated
Returns the person record that represents the logged-in user.
Mac/iOS
3.1
Addressbook.multivalue.New   Deprecated
Creates a new multivalue object.
Mac/iOS
3.1
Addressbook.multivalue.addAddress   Deprecated
Adds an address and its label to a multivalue list.
Mac/iOS
5.1
Addressbook.multivalue.addValue   Deprecated
Adds a value and its label to a multivalue list.
Mac/iOS
3.1
Addressbook.multivalue.count   Deprecated
Returns the number of entries in a multivalue list.
Mac/iOS
3.1
Addressbook.multivalue.identifierAtIndex   Deprecated
Returns the identifier for the given index.
Mac/iOS
3.1
Addressbook.multivalue.identifiers   Deprecated
Returns the list of all identifiers.
Mac/iOS
6.1
Addressbook.multivalue.indexForIdentifier   Deprecated
Returns the index for the given identifier.
Mac/iOS
3.1
Addressbook.multivalue.indexForLabel   Deprecated
Returns the index for the given label.
Mac/iOS
8.2
Addressbook.multivalue.insertValue   Deprecated
Inserts a value and its label at the given index in a multivalue list.
Mac/iOS
3.1
Addressbook.multivalue.labelAtIndex   Deprecated
Returns the label for the given index.
Mac/iOS
3.1
Addressbook.multivalue.labelForIdentifier   Deprecated
Returns the label for the given identifier.
Mac/iOS
3.1
Addressbook.multivalue.labels   Deprecated
Returns the list of all labels.
Mac/iOS
6.1
Addressbook.multivalue.primaryIdentifier   Deprecated
Returns the identifier for the primary value.
Mac/iOS
3.1
Addressbook.multivalue.removeValueAndLabelAtIndex   Deprecated
Removes the value and label at the given index.
Mac/iOS
3.1
Addressbook.multivalue.replaceLabelAtIndex   Deprecated
Replaces the label at the given index.
Mac/iOS
3.1
Addressbook.multivalue.replaceValueAtIndex   Deprecated
Replaces the value at the given index.
Mac/iOS
3.1
Addressbook.multivalue.setPrimaryIdentifier   Deprecated
Sets the primary value to be the value for the given identifier.
Mac only
3.1
Addressbook.multivalue.valueAtIndex   Deprecated
Returns the value for the given index.
Mac/iOS
3.1
Addressbook.multivalue.valueForIdentifier   Deprecated
Returns the value for the given identifier.
Mac/iOS
3.1
Addressbook.multivalue.valueForLabel   Deprecated
Returns value for label.
Mac/iOS
6.1
Addressbook.multivalue.values   Deprecated
Returns the list of all values.
Mac/iOS
6.1
Addressbook.people   Deprecated
Returns an array of all the people in the Address Book database.
Mac/iOS
3.1
Addressbook.persistentAccounts   Deprecated
Queries list of account identifies for persistent accounts.
Mac only
6.2
Addressbook.person.EditInAddressbook   Deprecated
Launches Contacts application to edit this person.
Mac only
3.1
Addressbook.person.ExternalUID   Deprecated
Queries external UID for person.
Mac/iOS
6.1
Addressbook.person.GetImage   Deprecated
Returns data that contains a picture of this person.
Mac/iOS
3.1
Addressbook.person.SetBirthdayComponents   Deprecated
Sets the birthday data components.
Mac/iOS
5.4
Addressbook.person.SetImage   Deprecated
Sets the image for this person to the given image.
Mac/iOS
3.1
Addressbook.person.ShowInAddressbook   Deprecated
Launches Contacts application to show this person.
Mac only
3.1
Addressbook.person.linkedPeople   Deprecated
Returns the array of all person records that are linked to the person this record represents.
Mac/iOS
3.1
Addressbook.person.parentGroups   Deprecated
Returns an array of the address book groups that this person belongs to.
Mac only
3.1
Addressbook.person.vCardRepresentation   Deprecated
Returns the vCard representation of the person record as a data object in vCard format.
Mac/iOS
3.1
Addressbook.personFromVCardRepresentation   Deprecated
Creates an Person instance initialized with the given data.
Mac/iOS
3.1
Addressbook.personFromVCardTextRepresentation   Deprecated
Creates an Person instance initialized with the given text.
Mac/iOS
3.5
Addressbook.record.SetValueForProperty   Deprecated
Sets the value of a given property for a record.
Mac/iOS
3.1
Addressbook.record.UniqueID   Deprecated
Returns the unique ID for a record.
Mac/iOS
3.1
Addressbook.record.displayname   Deprecated
Convenience function to return a display name for a record.
Mac/iOS
3.1
Addressbook.record.isReadOnly   Deprecated
Returns whether a record is read-only.
Mac/iOS
3.1
Addressbook.record.removeValueForProperty   Deprecated
Removes the value for a given property.
Mac/iOS
3.1
Addressbook.record.valueForProperty   Deprecated
Returns the value of a given property for a record.
Mac/iOS
3.1
Addressbook.recordsMatchingSearchElement   Deprecated
Searches matching records.
Mac only
5.4
Addressbook.removeRecord   Deprecated
Removes an person or group record from the Address Book database.
Mac/iOS
3.1
Addressbook.save   Deprecated
Saves all the changes made since the last save.
Mac/iOS
3.1
Addressbook.searchElementForConjunction   Deprecated
Joins several search elements.
Mac only
5.4
Addressbook.searchElementForProperty   Deprecated
Creates a new search element.
Mac only
5.4
Addressbook.searchGroupsWithName   Deprecated
Searches groups matching the group name.
Mac only
3.3
Addressbook.searchPeopleWithCreationDate   Deprecated
Searches for people in address book with creation date between both dates.
Mac only
3.5
Addressbook.searchPeopleWithEmail   Deprecated
Searches all people with given email address.
Mac only
3.1
Addressbook.searchPeopleWithModificationDate   Deprecated
Searches for people in address book with modification date between both dates.
Mac only
3.5
Addressbook.searchPeopleWithName   Deprecated
Searches people matching the first and/or last name.
Mac only
3.1
Addressbook.searchPersonWithExternalUID   Deprecated
Searches addressbook for given external ID.
Mac only
6.1
Addressbook.setMe   Deprecated
Sets the record that represents the logged-in user.
Mac/iOS
3.1

85 functions shown.

These functions require a license (58%).

Release notes

Blog Entries

Example Databases