# Alert Configuration

Defines email alerts for document library and list changes.

Referenced by: DocLibCfg.Alerts, SharepointCfg (via array).

# Overview

AlertCfg defines email alert rules that notify users when items are added, modified, or deleted in a document library or list.

# Applied when

Alerts are created when:

The parent DocLibCfg is provisioned and includes this alert in the Alerts array
Applied during document library provisioning; alerts are created after the library is created
The User must be a valid user in the SharePoint directory; if the user is not found, alert creation may fail
The Folder path, if specified, must exist in the library; if not found, the alert applies to the entire library
Alerts begin monitoring immediately after creation and send notifications based on the configured AlertTime schedule

# Core settings

# Name

Type: string | Required: Yes

Alert name (used as email subject prefix). Identifies the alert in SharePoint and in alert emails.

Example: "New Documents", "Daily Updates"

# Folder

Type: string | Required: No

Folder path to monitor. Leave empty to monitor the entire library. If specified, the alert only triggers for items in that folder and subfolders.

Example: "Active Cases", "2024 Matters"

# User

Type: string | Required: Yes

User login name to receive the alert. Must be a valid user in the SharePoint directory. If the user is not found, alert creation fails.

Example: "john.smith@company.com", "jsmith"

# Alert triggers

# AlertEventType

Type: enum | Required: No | Applies When: SharePoint Online only

When to trigger the alert. Valid values:

All — All changes (adds, modifies, deletes, moves)
AddObject — Item created
ModifyObject — Item modified
DeleteObject — Item deleted
MoveObject — Item moved

Note: This setting is ignored on SharePoint 2016 and on-premises deployments.

# AlertTime

Type: TimeSpan? | Required: No

Time of day for digest delivery (e.g., "08:00:00" for 8 AM). Controls both the delivery time and the alert frequency:

`AlertTime`	`AlertDayOfWeek`	Frequency
not set	—	Immediate — alert fires as soon as a change occurs
set	not set	Daily digest — sent once per day at the specified time
set	set	Weekly digest — sent once per week on the specified day at the specified time

# AlertDayOfWeek

Type: DayOfWeek? | Required: Conditional

Day of week for weekly digest delivery. Valid values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

Note: Only applies when AlertTime is also set. If set without AlertTime, it is ignored.

# Filtering

# QuickFilter

Type: enum | Required: No

Quick filter type for the alert. Valid values:

AnythingChanges — Alert on all changes
SomeoneElseChangesADocument — Only changes made by other users
SomeoneElseChangesADocumentCreatedByMe — Only changes by others to documents created by me
SomeoneElseChangesADocumentModifiedByMe — Only changes by others to documents last modified by me

# CAMLFilter