Skip to main content

autessa.outlook

8 methods in the outlook namespace.

autessa.outlook.connectors.allREAD

autessa.outlook.connectors.all()

List every Outlook connector you can access in your company.

Returns all Outlook connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other outlook.connectors.* methods. Credentials are never included in the returned DTOs.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectors
    Type
    OutlookConnectorDto[]
    Description

autessa.outlook.connectors.deleteMUTATE

autessa.outlook.connectors.delete({ connectorId })

Permanently delete a Outlook connector and its stored credential.

Removes the Outlook connector for connectorId (owner only), revoking every tool and script that relied on it. This deletes the Autessa record and its stored tokens only — it does NOT revoke the grant on the Microsoft side; revoke that in the Microsoft account's connected-apps settings. Reconnecting requires the full OAuth flow again.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description

autessa.outlook.connectors.getREAD

autessa.outlook.connectors.get({ connectorId })

Fetch one Outlook connector by id.

Returns the full Outlook connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    OutlookConnectorDto
    Description

autessa.outlook.connectors.getSharingDetailsREAD

autessa.outlook.connectors.getSharingDetails({ connectorId })

Read the current sharing configuration of a Outlook connector.

Returns how the Outlook connector is shared: the overall sharingLevel, the companyPermissionLevel granted for COMPANY sharing, the explicit sharedWith members, and your own userAccessLevel. Use before share to see the current state.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    sharingLevel
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    companyPermissionLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    sharedWith
    Type
    UserShareWrapper[]
    Description
  • Name
    userAccessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description

autessa.outlook.connectors.listFoldersREAD

autessa.outlook.connectors.listFolders({ connectorId })

List the mail folders of an Outlook connector's mailbox.

Returns the mail folders of the connector's Outlook mailbox, read live from Microsoft Graph, each with its folder id and display name. Returns up to 100 folders and does not paginate. Needs a valid OAuth token (the SDK refreshes it automatically). Use the returned folderId to scope Outlook mail tools to a folder. Requires READ access to the connector.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    folders
    Type
    ResponseFolderDto[]
    Description

autessa.outlook.connectors.shareMUTATE

autessa.outlook.connectors.share({ connectorId, level, accessLevel, usersToAdd, usersToRemove })

Change who in your company can use a Outlook connector.

Sets the sharing scope of the Outlook connector. level=PRIVATE keeps it to the owner; level=COMPANY grants everyone in the company the given accessLevel; level=SPECIFIC_MEMBER shares with named users — add them in usersToAdd and revoke via usersToRemove (each as a UserShareWrapper). accessLevel applies to COMPANY sharing. Sharing lets other members' tools and scripts use the connector; the credential itself is never exposed. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersToAdd
    Type
    UserShareWrapper[]
    Description
  • Name
    usersToRemove
    Type
    UserShareWrapper[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersWithAccess
    Type
    UserShareWrapper[]
    Description

autessa.outlook.connectors.updateMUTATE

autessa.outlook.connectors.update({ connectorId, connectorName, isActive })

Rename a Outlook connector or toggle whether it is active.

Applies a sparse patch to the Outlook connector for connectorId: send connectorName to rename it, isActive to enable/disable it. This is a partial update — omit a field to leave it unchanged; sending null or an empty name is ignored. Does not touch the stored credential or sharing. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    connectorName
    Type
    string
    Description
  • Name
    isActive
    Type
    boolean
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    connector
    Type
    OutlookConnectorDto
    Description