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](component_Addressbook.md) 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](component_Contacts.md) functions for newer API which works better with multple accounts.  
  
Deprecated. Please move to [Contacts](component_Contacts.md) functions.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [3.1](newinversion31.md "First functions introduced with version 3.1.") / [8.2](newinversion82.md "Newest functions in version 8.2.") | ✅ Yes | ❌ No | ❌ No | ❌ No | 🔶 58% |

  
| Item | Details |
|:--|:--|
| [Addressbook.Account.Name](AddressbookAccountName.md)  **Deprecated**    Queries name of account. | Mac only   6.2 |
| [Addressbook.Account.Type](AddressbookAccountType.md)  **Deprecated**    Queries type identifier for account. | Mac only   6.2 |
| [Addressbook.Account.URL](AddressbookAccountURL.md)  **Deprecated**    Queries base URL for account. | Mac only   6.2 |
| [Addressbook.Account.isMainAccount](AddressbookAccountisMainAccount.md)  **Deprecated**    Queries whether this is main account. | Mac only   6.2 |
| [Addressbook.LocalizedPropertyOrLabel](AddressbookLocalizedPropertyOrLabel.md)  **Deprecated**    Queries a localized name for a label or property. | Mac only   3.5 |
| [Addressbook.NewGroup](AddressbookNewGroup.md)  **Deprecated**    Creates a new group. | Mac/iOS   3.1 |
| [Addressbook.NewPerson](AddressbookNewPerson.md)  **Deprecated**    Creates a new person. | Mac/iOS   3.1 |
| [Addressbook.Notification.Clear](AddressbookNotificationClear.md)  **Deprecated**    Clears the registered notification script. | Mac only   3.5 |
| [Addressbook.Notification.Evaluate](AddressbookNotificationEvaluate.md)  **Deprecated**    Installs a notification evaluate. | Mac only   6.2 |
| [Addressbook.Notification.GetChangedExternally](AddressbookNotificationGetChangedExternally.md)  **Deprecated**    Queries if the last notification script call was caused by a changed in another app. | Mac only   3.5 |
| [Addressbook.Notification.GetDeletedRecords](AddressbookNotificationGetDeletedRecords.md)  **Deprecated**    Queries list of deleted records. | Mac only   3.5 |
| [Addressbook.Notification.GetInsertedRecords](AddressbookNotificationGetInsertedRecords.md)  **Deprecated**    Queries list of inserted records. | Mac only   3.5 |
| [Addressbook.Notification.GetProcessID](AddressbookNotificationGetProcessID.md)  **Deprecated**    Queries the process ID. | Mac only   3.5 |
| [Addressbook.Notification.GetProcessName](AddressbookNotificationGetProcessName.md)  **Deprecated**    Queries the process name. | Mac only   3.5 |
| [Addressbook.Notification.GetUpdatedRecords](AddressbookNotificationGetUpdatedRecords.md)  **Deprecated**    Queries list of updated records. | Mac only   3.5 |
| [Addressbook.Notification.GetUserUID](AddressbookNotificationGetUserUID.md)  **Deprecated**    Queries the user ID. | Mac only   3.5 |
| [Addressbook.Notification.Set](AddressbookNotificationSet.md)  **Deprecated**    Installs a notification script. | Mac only   3.5 |
| [Addressbook.Record.Account](AddressbookRecordAccount.md)  **Deprecated**    Queries account identifier for record. | Mac only   6.2 |
| [Addressbook.addRecord](AddressbookaddRecord.md)  **Deprecated**    Adds an person or group record to the Address Book database. | Mac/iOS   3.1 |
| [Addressbook.allAccounts](AddressbookallAccounts.md)  **Deprecated**    Queries list of account identifies for all accounts. | Mac only   6.2 |
| [Addressbook.defaultAccount](AddressbookdefaultAccount.md)  **Deprecated**    Queries default account identifier. | Mac only   6.2 |
| [Addressbook.enabledAccounts](AddressbookenabledAccounts.md)  **Deprecated**    Queries list of account identifies for enabled accounts. | Mac only   6.2 |
| [Addressbook.formattedAddress](AddressbookformattedAddress.md)  **Deprecated**    Returns an attributed string containing the formatted address. | Mac only   3.1 |
| [Addressbook.group.addMember](AddressbookgroupaddMember.md)  **Deprecated**    Adds a person to a group. | Mac/iOS   3.1 |
| [Addressbook.group.addSubgroup](AddressbookgroupaddSubgroup.md)  **Deprecated**    Adds a subgroup to another group. | Mac/iOS   3.1 |
| [Addressbook.group.members](Addressbookgroupmembers.md)  **Deprecated**    Returns an array of persons in a group. | Mac/iOS   3.1 |
| [Addressbook.group.parentGroups](AddressbookgroupparentGroups.md)  **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](AddressbookgroupremoveMember.md)  **Deprecated**    Removes a person from a group. | Mac/iOS   3.1 |
| [Addressbook.group.removeSubgroup](AddressbookgroupremoveSubgroup.md)  **Deprecated**    Removes a subgroup from a group. | Mac/iOS   3.1 |
| [Addressbook.group.subgroups](Addressbookgroupsubgroups.md)  **Deprecated**    Returns an array containing a group's subgroups. | Mac only   3.1 |
| [Addressbook.groups](Addressbookgroups.md)  **Deprecated**    Returns an array of all the groups in the Address Book database. | Mac/iOS   3.1 |
| [Addressbook.hasUnsavedChanges](AddressbookhasUnsavedChanges.md)  **Deprecated**    Indicates whether an address book has changes that have not been saved to the Address Book database. | Mac/iOS   3.1 |
| [Addressbook.me](Addressbookme.md)  **Deprecated**    Returns the person record that represents the logged-in user. | Mac/iOS   3.1 |
| [Addressbook.multivalue.New](AddressbookmultivalueNew.md)  **Deprecated**    Creates a new multivalue object. | Mac/iOS   3.1 |
| [Addressbook.multivalue.addAddress](AddressbookmultivalueaddAddress.md)  **Deprecated**    Adds an address and its label to a multivalue list. | Mac/iOS   5.1 |
| [Addressbook.multivalue.addValue](AddressbookmultivalueaddValue.md)  **Deprecated**    Adds a value and its label to a multivalue list. | Mac/iOS   3.1 |
| [Addressbook.multivalue.count](Addressbookmultivaluecount.md)  **Deprecated**    Returns the number of entries in a multivalue list. | Mac/iOS   3.1 |
| [Addressbook.multivalue.identifierAtIndex](AddressbookmultivalueidentifierAtIndex.md)  **Deprecated**    Returns the identifier for the given index. | Mac/iOS   3.1 |
| [Addressbook.multivalue.identifiers](Addressbookmultivalueidentifiers.md)  **Deprecated**    Returns the list of all identifiers. | Mac/iOS   6.1 |
| [Addressbook.multivalue.indexForIdentifier](AddressbookmultivalueindexForIdentifier.md)  **Deprecated**    Returns the index for the given identifier. | Mac/iOS   3.1 |
| [Addressbook.multivalue.indexForLabel](AddressbookmultivalueindexForLabel.md)  **Deprecated**    Returns the index for the given label. | Mac/iOS   8.2 |
| [Addressbook.multivalue.insertValue](AddressbookmultivalueinsertValue.md)  **Deprecated**    Inserts a value and its label at the given index in a multivalue list. | Mac/iOS   3.1 |
| [Addressbook.multivalue.labelAtIndex](AddressbookmultivaluelabelAtIndex.md)  **Deprecated**    Returns the label for the given index. | Mac/iOS   3.1 |
| [Addressbook.multivalue.labelForIdentifier](AddressbookmultivaluelabelForIdentifier.md)  **Deprecated**    Returns the label for the given identifier. | Mac/iOS   3.1 |
| [Addressbook.multivalue.labels](Addressbookmultivaluelabels.md)  **Deprecated**    Returns the list of all labels. | Mac/iOS   6.1 |
| [Addressbook.multivalue.primaryIdentifier](AddressbookmultivalueprimaryIdentifier.md)  **Deprecated**    Returns the identifier for the primary value. | Mac/iOS   3.1 |
| [Addressbook.multivalue.removeValueAndLabelAtIndex](AddressbookmultivalueremoveValueAndLabelAtIndex.md)  **Deprecated**    Removes the value and label at the given index. | Mac/iOS   3.1 |
| [Addressbook.multivalue.replaceLabelAtIndex](AddressbookmultivaluereplaceLabelAtIndex.md)  **Deprecated**    Replaces the label at the given index. | Mac/iOS   3.1 |
| [Addressbook.multivalue.replaceValueAtIndex](AddressbookmultivaluereplaceValueAtIndex.md)  **Deprecated**    Replaces the value at the given index. | Mac/iOS   3.1 |
| [Addressbook.multivalue.setPrimaryIdentifier](AddressbookmultivaluesetPrimaryIdentifier.md)  **Deprecated**    Sets the primary value to be the value for the given identifier. | Mac only   3.1 |
| [Addressbook.multivalue.valueAtIndex](AddressbookmultivaluevalueAtIndex.md)  **Deprecated**    Returns the value for the given index. | Mac/iOS   3.1 |
| [Addressbook.multivalue.valueForIdentifier](AddressbookmultivaluevalueForIdentifier.md)  **Deprecated**    Returns the value for the given identifier. | Mac/iOS   3.1 |
| [Addressbook.multivalue.valueForLabel](AddressbookmultivaluevalueForLabel.md)  **Deprecated**    Returns value for label. | Mac/iOS   6.1 |
| [Addressbook.multivalue.values](Addressbookmultivaluevalues.md)  **Deprecated**    Returns the list of all values. | Mac/iOS   6.1 |
| [Addressbook.people](Addressbookpeople.md)  **Deprecated**    Returns an array of all the people in the Address Book database. | Mac/iOS   3.1 |
| [Addressbook.persistentAccounts](AddressbookpersistentAccounts.md)  **Deprecated**    Queries list of account identifies for persistent accounts. | Mac only   6.2 |
| [Addressbook.person.EditInAddressbook](AddressbookpersonEditInAddressbook.md)  **Deprecated**    Launches Contacts application to edit this person. | Mac only   3.1 |
| [Addressbook.person.ExternalUID](AddressbookpersonExternalUID.md)  **Deprecated**    Queries external UID for person. | Mac/iOS   6.1 |
| [Addressbook.person.GetImage](AddressbookpersonGetImage.md)  **Deprecated**    Returns data that contains a picture of this person. | Mac/iOS   3.1 |
| [Addressbook.person.SetBirthdayComponents](AddressbookpersonSetBirthdayComponents.md)  **Deprecated**    Sets the birthday data components. | Mac/iOS   5.4 |
| [Addressbook.person.SetImage](AddressbookpersonSetImage.md)  **Deprecated**    Sets the image for this person to the given image. | Mac/iOS   3.1 |
| [Addressbook.person.ShowInAddressbook](AddressbookpersonShowInAddressbook.md)  **Deprecated**    Launches Contacts application to show this person. | Mac only   3.1 |
| [Addressbook.person.linkedPeople](AddressbookpersonlinkedPeople.md)  **Deprecated**    Returns the array of all person records that are linked to the person this record represents. | Mac/iOS   3.1 |
| [Addressbook.person.parentGroups](AddressbookpersonparentGroups.md)  **Deprecated**    Returns an array of the address book groups that this person belongs to. | Mac only   3.1 |
| [Addressbook.person.vCardRepresentation](AddressbookpersonvCardRepresentation.md)  **Deprecated**    Returns the vCard representation of the person record as a data object in vCard format. | Mac/iOS   3.1 |
| [Addressbook.personFromVCardRepresentation](AddressbookpersonFromVCardRepresentation.md)  **Deprecated**    Creates an Person instance initialized with the given data. | Mac/iOS   3.1 |
| [Addressbook.personFromVCardTextRepresentation](AddressbookpersonFromVCardTextRepresentation.md)  **Deprecated**    Creates an Person instance initialized with the given text. | Mac/iOS   3.5 |
| [Addressbook.record.SetValueForProperty](AddressbookrecordSetValueForProperty.md)  **Deprecated**    Sets the value of a given property for a record. | Mac/iOS   3.1 |
| [Addressbook.record.UniqueID](AddressbookrecordUniqueID.md)  **Deprecated**    Returns the unique ID for a record. | Mac/iOS   3.1 |
| [Addressbook.record.displayname](Addressbookrecorddisplayname.md)  **Deprecated**    Convenience function to return a display name for a record. | Mac/iOS   3.1 |
| [Addressbook.record.isReadOnly](AddressbookrecordisReadOnly.md)  **Deprecated**    Returns whether a record is read-only. | Mac/iOS   3.1 |
| [Addressbook.record.removeValueForProperty](AddressbookrecordremoveValueForProperty.md)  **Deprecated**    Removes the value for a given property. | Mac/iOS   3.1 |
| [Addressbook.record.valueForProperty](AddressbookrecordvalueForProperty.md)  **Deprecated**    Returns the value of a given property for a record. | Mac/iOS   3.1 |
| [Addressbook.recordsMatchingSearchElement](AddressbookrecordsMatchingSearchElement.md)  **Deprecated**    Searches matching records. | Mac only   5.4 |
| [Addressbook.removeRecord](AddressbookremoveRecord.md)  **Deprecated**    Removes an person or group record from the Address Book database. | Mac/iOS   3.1 |
| [Addressbook.save](Addressbooksave.md)  **Deprecated**    Saves all the changes made since the last save. | Mac/iOS   3.1 |
| [Addressbook.searchElementForConjunction](AddressbooksearchElementForConjunction.md)  **Deprecated**    Joins several search elements. | Mac only   5.4 |
| [Addressbook.searchElementForProperty](AddressbooksearchElementForProperty.md)  **Deprecated**    Creates a new search element. | Mac only   5.4 |
| [Addressbook.searchGroupsWithName](AddressbooksearchGroupsWithName.md)  **Deprecated**    Searches groups matching the group name. | Mac only   3.3 |
| [Addressbook.searchPeopleWithCreationDate](AddressbooksearchPeopleWithCreationDate.md)  **Deprecated**    Searches for people in address book with creation date between both dates. | Mac only   3.5 |
| [Addressbook.searchPeopleWithEmail](AddressbooksearchPeopleWithEmail.md)  **Deprecated**    Searches all people with given email address. | Mac only   3.1 |
| [Addressbook.searchPeopleWithModificationDate](AddressbooksearchPeopleWithModificationDate.md)  **Deprecated**    Searches for people in address book with modification date between both dates. | Mac only   3.5 |
| [Addressbook.searchPeopleWithName](AddressbooksearchPeopleWithName.md)  **Deprecated**    Searches people matching the first and/or last name. | Mac only   3.1 |
| [Addressbook.searchPersonWithExternalUID](AddressbooksearchPersonWithExternalUID.md)  **Deprecated**    Searches addressbook for given external ID. | Mac only   6.1 |
| [Addressbook.setMe](AddressbooksetMe.md)  **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

- **Version 10.3**
    - Deprecated [Addressbook](https://www.mbsplugins.eu/component_Addressbook.shtml) functions in favor of [Contacts](https://www.mbsplugins.eu/component_Contacts.shtml) functions.
- **Version 8.2**
    - Added [Addressbook.multivalue.indexForLabel](http://www.mbsplugins.eu/AddressbookmultivalueindexForLabel.shtml) function.
    - Improved [Addressbook.record.SetValueForProperty](http://www.mbsplugins.eu/AddressbookrecordSetValueForProperty.shtml) to better handle keeping the record current.

### Blog Entries

- [macOS Privacy and FileMaker](https://www.mbsplugins.de/archive/2020-08-11/macOS_Privacy_and_FileMaker/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, version 10.3pr5](https://www.mbsplugins.de/archive/2020-06-20/MBS_FileMaker_Plugin_version_1/monkeybreadsoftware_blog_filemaker)
- [Neues MBS FileMaker Plugin 8.4 - Über 5400 Funktionen in einem Plugin](https://www.mbsplugins.de/archive/2018-09-25/Neues_MBS_FileMaker_Plugin_84_/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 8.4 - More than 5400 Functions In One Plugin](https://www.mbsplugins.de/archive/2018-09-25/MBS_FileMaker_Plugin_84_-_More/monkeybreadsoftware_blog_filemaker)
- [New Contacts functions for FileMaker](https://www.mbsplugins.de/archive/2018-08-08/New_Contacts_functions_for_Fil/monkeybreadsoftware_blog_filemaker)
- [New functions for MBS FileMaker Plugin coming soon](https://www.mbsplugins.de/archive/2016-03-17/New_functions_for_MBS_FileMake/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 6.1 für OS X/Windows](https://www.mbsplugins.de/archive/2016-03-08/MBS_FileMaker_Plugin_61_fuuml;/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plug-in 6.1 for OS X/Windows](https://www.mbsplugins.de/archive/2016-03-08/MBS_FileMaker_Plug-in_61_for_O/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 3.2 for OS X/Windows](https://www.mbsplugins.de/archive/2013-05-07/MBS_FileMaker_Plugin_32_for_OS/monkeybreadsoftware_blog_filemaker)

### Example Databases

- [Mac and iOS/Addressbook/Addressbook Changes](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20and%20iOS/Addressbook/Addressbook%20Changes.shtml#1ScriptAnchor_)
- [Mac and iOS/Addressbook/Addressbook](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20and%20iOS/Addressbook/Addressbook.shtml#1ScriptAnchor_)

[HTML Version](component_Addressbook.shtml)