• Article

OperatorToEmail Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The OperatorToEmail property specifies the SQL Server Agent operator receiving e-mail notification of job completion.

Syntax

object
.OperatorToEmail [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A string that identifies a SQL Server Agent operator by name

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetOperatorToEmail(SQLDMO_LPBSTR pRetVal);
HRESULT SetOperatorToEmail(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

SQL Server Agent can send notification of job completion using e-mail, network message, or pager.

The operator specified by the OperatorToEmail property should be configured with an e-mail address for notification routing. SQL Mail must be configured and running before e-mail notification can be successfully sent.

To enable a job for e-mail notification

  1. Set the OperatorToEmail property to the name of an existing SQL Server Agent operator.

  2. Set the EmailLevel property to control Microsoft SQL Server e-mail notification based on job completion.

Applies To:

Job Object