1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Gmail
  7. \
  8. Resource
  9. \
  10. Users

Users

class Users extends Resource (View source)

The "users" collection of methods.

Typical usage is:

 $gmailService = new Google\Service\Gmail(...);
 $users = $gmailService->users;

Methods

Profile
getProfile(string $userId, array $optParams = [])

Gets the current user's Gmail profile. (users.getProfile)

stop(string $userId, array $optParams = [])

Stop receiving push notifications for the given user mailbox. (users.stop)

WatchResponse
watch(string $userId, WatchRequest $postBody, array $optParams = [])

Set up or update a push notification watch on the given user mailbox.

Details

at line 43
Profile getProfile(string $userId, array $optParams = [])

Gets the current user's Gmail profile. (users.getProfile)

Parameters

string $userId

The user's email address. The special value me can be used to indicate the authenticated user.
array $optParams

Optional parameters.

Return Value

Profile

Exceptions

Exception

at line 57
stop(string $userId, array $optParams = [])

Stop receiving push notifications for the given user mailbox. (users.stop)

Parameters

string $userId

The user's email address. The special value me can be used to indicate the authenticated user.
array $optParams

Optional parameters.

Exceptions

Exception

at line 74
WatchResponse watch(string $userId, WatchRequest $postBody, array $optParams = [])

Set up or update a push notification watch on the given user mailbox.

(users.watch)

Parameters

string $userId

The user's email address. The special value me can be used to indicate the authenticated user.
WatchRequest $postBody
array $optParams

Optional parameters.

Return Value

WatchResponse

Exceptions

Exception