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

Addressbook.groups

Returns an array of all the groups in the Address Book database.

Component Version macOS Windows Linux Server iOS SDK
Addressbook 3.1 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes

Deprecated

This function was deprecated. Use Contacts functions instead.

MBS( "Addressbook.groups" { ; Account } )   More

Parameters

Parameter Description Example Flags
Account The account identifier to limit search for. _local Optional

Result

Returns list of group IDs.

Description

Returns an array of all the groups in the Address Book database.
If the database doesn't contain any groups, this method returns an empty array.

You can use Addressbook.record.displayname to find the display name of a group. Or you query the group name property with Addressbook.record.valueForProperty.

Examples

Query list of group IDs:

MBS( "Addressbook.groups" )

Query display name of first group:

MBS( "Addressbook.record.displayname"; ElementLeft ( MBS( "Addressbook.groups" ) ; 1 ))

See also

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 24th May 2016


Addressbook.group.subgroups - Addressbook.hasUnsavedChanges