Address Books¶
Manage address books.
Address Book¶
Name¶
User-visible name of the address book.
Text. Name in the API: name.
Description¶
Longer-form description of the address book, useful in shared environments.
Text. Name in the API: description.
Sort Order¶
Display order (lower values first). Address books with equal order sort alphabetically by name.
A number. Default: 0. Name in the API: sortOrder.
Display¶
Default Address Book¶
Whether this is the account's default address book. At most one address book per account may be default.
On or off. Read only. Name in the API: isDefault.
Subscribed¶
Whether the user has subscribed to see this address book in their client.
On or off. Default: On. Name in the API: isSubscribed.
Sharing¶
Shared With¶
Share this address book with other accounts, and specify the access rights they have on it.
A set of entries, each a key and its value. Name in the API: shareWith.
My Rights¶
Access rights the current user has on this address book.
Settings of their own: see Address book rights. Read only. Name in the API: myRights.