Lists the inboxes accessible by the current teammate.
function listInboxes(paginationToken?: string, cancelToken?: CancelToken): Promise<PaginatedResults<Inbox>>
Parameters
Parameter | Type | Description |
---|---|---|
paginationToken | PaginationToken | Token of the requested page. If omitted, will return the first page of results. |
cancelToken | Cancel token | Token to cancel the request. |
Return value
The function returns a promise that resolves with a paginated list of inboxes.
Property | Type | Description |
---|---|---|
nextPageToken | PaginationToken (optional) | Token to access the next page of results, if any. |
results | Array of Inbox | List of inboxes. |