Users Gmail Delegates

Users - Gmail - Delegates

• API documentation
• Collections of Users
• Definitions
• Create delegates
• Delete delegates
• Update delegates
• Display delegates

API documentation

• https://developers.google.com/gmail/api/v1/reference/users/settings/delegates
• https://support.google.com/a/answer/7223765?hl=en

Definitions

<DomainName> ::= <String>(.<String>)+
<EmailAddress> ::= <String>@<DomainName>
<UniqueID> ::= uid:<String>
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
<UserList> ::= "<UserItem>(,<UserItem>)*"
<UserEntity> ::= <UserList>|<FileSelector>|<CSVkmdSelector>|<CSVDataSelector>

Create delegates

These two commands are equivalent.

gam <UserTypeEntity> add delegate|delegates <UserEntity>
gam <UserTypeEntity> delegate|delegates to <UserEntity>

Delete delegates

gam <UserTypeEntity> delete|del delegate|delegates <UserEntity>

Update delegates

Update delegates to be able to access a user's contacts.

gam <UserTypeEntity> update delegate|delegates [<UserEntity>]

If <UserEntity> is omitted, all of a user's accepted delegates are updated.

Display delegates

gam <UserTypeEntity> show delegates|delegate [shownames] [csv]
gam <UserTypeEntity> print delegates|delegate [todrive <ToDriveAttribute>*] [shownames]

By default, delegate names are not displayed; use the shownames option to display the delegates name. This involves an extra API call per delegate email address.

By default, show delegates displays indented keys and values; use the csv option to have just the values shown as a comma separated list.