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
NotificationPage list(RequestOptions options)Returns 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.
The SDK reshapes the wire envelope: the server's data list arrives as items, and unreadCount comes along, so the result is a NotificationPage rather than a plain Page.
Parameters
options.limitintPage size, from 1 to 50. The server defaults to 20.
options.cursorStringThe
nextCursorof the previous page. Leave it out for the first page.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A NotificationPage with items, unreadCount, hasMore and nextCursor. Each item is a map with object, id, kind, read, readAt, notifiedAt and invitation, which is null or a map with id, workspaceId, workspaceName, roleName, inviterName, inviterEmail, inviterImage, addresses, status and expiresAt. Looping over the page or counting it goes through items.
Example
NotificationPage page = client.notifications().list(); System.out.println(page.unreadCount() + " unread"); for (Map<String, Object> notification : page) { if (notification.get("invitation") instanceof Map<?, ?> invitation && NotificationInvitationStatuses.OPEN.equals(invitation.get("status"))) { System.out.println("Invited to " + invitation.get("workspaceName")); }}Notes
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.The values of
kindare insh.nextmail.constants.NotificationKinds, and those ofinvitation.statusinsh.nextmail.constants.NotificationInvitationStatuses.addressescounts the addresses and the whole domains the invitation gives together.A cursor that names nothing in this list is 400
invalid_cursor.
Also available in
notifications().unreadCount
Count your unread notifications
Map<String, Object> unreadCount(RequestOptions options)Returns 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 notifications().list, so poll this one and list only when it changes.
Parameters
options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with object set to notification_count and unreadCount.
Example
Map<String, Object> count = client.notifications().unreadCount(); if (count.get("unreadCount") instanceof Number unread && unread.longValue() > 0) { System.out.println(unread + " new notifications");}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
Map<String, Object> markRead(List<String> ids, RequestOptions options)Marks 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
idsList<String>RequiredNotification ids from
notifications().list, 1 to 100 of them.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with object set to notifications_read, marked and the unreadCount left.
Example
NotificationPage page = client.notifications().list();List<String> unread = page.items().stream().filter(notification -> Boolean.FALSE.equals(notification.get("read"))).map(notification -> (String) notification.get("id")).toList(); if (!unread.isEmpty()) { Map<String, Object> result = client.notifications().markRead(unread); System.out.println(result.get("marked") + " marked read");}Notes
Retried automatically on network failure, since marking a notification read twice changes nothing.
Also available in
notifications().markAllRead
Mark every notification read
Map<String, Object> markAllRead(RequestOptions options)Marks 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
options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with object set to notifications_read, marked and the unreadCount left, which is 0 unless a notification arrived meanwhile.
Example
Map<String, Object> result = client.notifications().markAllRead(); System.out.println(result.get("marked") + " marked read, " + result.get("unreadCount") + " still unread");Notes
Retried automatically on network failure, since marking everything read twice changes nothing.
Also available in
notifications().clear
Clear your notifications
Map<String, Object> clear(RequestOptions options)Removes 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
options.declineInvitationsbooleanDecline every invitation that is still open first, so its notification goes too. False when left out, which keeps open invitations and their notifications.
options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map 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
Map<String, Object> result = client.notifications().clear(); if (result.get("openInvitations") instanceof Number open && open.longValue() > 0) { System.out.println(open + " invitations are still open and stay listed");}Notes
Retried automatically on network failure, since clearing again removes nothing more and declines nothing twice.
Google Workspace