MailboxEntity interface

Represents a mailbox entity.

Extends

Properties

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user.

displayName

The mailbox's display name

externalDirectoryObjectId

The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.

kind

The kind of the entity.

mailboxPrimaryAddress

The mailbox's primary address

upn

The mailbox's UPN

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user.

additionalData?: Record<string, any>

Property Value

Record<string, any>

displayName

The mailbox's display name

displayName?: string

Property Value

string

externalDirectoryObjectId

The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side

externalDirectoryObjectId?: string

Property Value

string

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.

friendlyName?: string

Property Value

string

kind

The kind of the entity.

kind: "Mailbox"

Property Value

"Mailbox"

mailboxPrimaryAddress

The mailbox's primary address

mailboxPrimaryAddress?: string

Property Value

string

upn

The mailbox's UPN

upn?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From Entity.id

name

The name of the resource

name?: string

Property Value

string

Inherited From Entity.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From Entity.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From Entity.type