$client->notifications
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
What the bell in the app shows the person behind the key or the app: the invitations to join a workspace sent to their address, read or unread, open or answered, with the count of unread ones and a way to mark them read.
notifications->list
List your notifications
list(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): NotificationPageReturns one page of the notifications of the person behind the key or the app, newest first, as the bell in the app lists them, with unreadCount for every unread one on any page.
Today each notification is an invitation to join a workspace, sent to the address the person signs in with. It stays listed once it is answered, withdrawn or expires, and invitation['status'] says which: open, accepted, declined, withdrawn or expired. Answer an open one with account->acceptInvitation or account->declineInvitation and the id in invitation['id'], which also marks it read. New kinds of notification will be added, and invitation is null on a kind that is about something else, so skip a kind you do not know.
Parameters
limitintPage size, from 1 to 50. The server defaults to 20.
cursorstringThe
nextCursorof the previous page. Leave it out for the first page.apiKeystringOverrides the client's API key for this call only.
Returns
A NotificationPage with items, unreadCount, hasMore and nextCursor. Each notification is an array with object set to notification, id, kind, read, readAt, notifiedAt and invitation, an array with id, workspaceId, workspaceName, roleName, inviterName, inviterEmail, inviterImage, addresses, status and expiresAt, or null. Looping over it or counting it goes through items.
Example
use Nextmail\Constants\NotificationInvitationStatuses; $page = $client->notifications->list(); echo $page->unreadCount, ' unread', PHP_EOL; foreach ($page as $notification) { if (($notification['invitation']['status'] ?? null) === NotificationInvitationStatuses::OPEN) { echo 'Invited to ', $notification['invitation']['workspaceName'], PHP_EOL; }}Notes
The values of
kindare inNextmail\Constants\NotificationKinds, and those ofinvitation['status']inNextmail\Constants\NotificationInvitationStatuses.An invitation sent again comes back to the top unread, so
notifiedAtis when the person was last told, not when the invitation was first sent.A cursor that names nothing in this list is 400
invalid_cursor.
Also available in
notifications->unreadCount
Count your unread notifications
unreadCount(?string $apiKey = null): arrayReturns how many notifications the person behind the key or the app has not read yet, the number on the bell in the app. It is cheaper than list, so poll this one and list only when it changes.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to notification_count and unreadCount.
Example
$count = $client->notifications->unreadCount(); if ($count['unreadCount'] > 0) { echo $count['unreadCount'], ' new notifications', PHP_EOL;}Notes
An invitation sent to the person before they signed up counts as soon as they have an account.
Also available in
notifications->markRead
Mark notifications read
markRead(array $ids, ?string $apiKey = null): arrayMarks the notifications with these ids read, up to 100 at a time. An id that is already read, or that is not one of the person's notifications, is skipped, so marked counts only the ones that changed. Reading a notification never answers it: an open invitation stays open.
Parameters
idsstring[]RequiredNotification ids from
list, 1 to 100 of them.apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to notifications_read, marked and the unreadCount left.
Example
$unread = []; foreach ($client->notifications->list() as $notification) { if (!$notification['read']) { $unread[] = $notification['id']; }} if ($unread !== []) { $result = $client->notifications->markRead($unread); echo $result['marked'], ' marked read, ', $result['unreadCount'], ' left', PHP_EOL;}Notes
Retried automatically on network failure, since marking a notification read twice changes nothing.
Also available in
notifications->markAllRead
Mark every notification read
markAllRead(?string $apiKey = null): arrayMarks every notification of the person behind the key or the app read, as Mark all as read in the app does, and clears the number on the bell. Open invitations stay open and can still be answered.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to notifications_read, marked and the unreadCount left, which is 0 unless a notification arrived meanwhile.
Example
$result = $client->notifications->markAllRead(); echo $result['marked'], ' marked read', PHP_EOL;Notes
Retried automatically on network failure, since marking everything read twice changes nothing.
Also available in
notifications->clear
Clear your notifications
clear(?bool $declineInvitations = null, ?string $apiKey = null): arrayRemoves the notifications of the person behind the key or the app, as Clear notifications in the app does. The notification of an invitation that is still open stays, because the invitation still waits for an answer, unless declineInvitations: is true: then every open invitation is declined first, as account->declineInvitation declines one, and its notification goes too. A declined invitation cannot be accepted, so only a new invitation brings the person in.
Parameters
declineInvitationsboolDecline every invitation that is still open first, so its notification goes too. False when left out, which keeps open invitations and their notifications.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to notifications_cleared, how many notifications were cleared, how many invitations it declined (declinedInvitations), how many are still open (openInvitations) and the unreadCount left.
Example
$result = $client->notifications->clear(); if ($result['openInvitations'] > 0) { echo $result['openInvitations'], ' invitations are still open and stay listed', PHP_EOL;}Notes
Retried automatically on network failure, since clearing again removes nothing more and declines nothing twice.
Google Workspace