Syntax

object.OperatorToEmail [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

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-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 SQL Server e-mail notification based on job completion.

See Also