Share via

Job.EmailLevel Property

  • Article

Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property EmailLevel As CompletionAction 
    Get 
    Set
'Usage
Dim instance As Job 
Dim value As CompletionAction 

value = instance.EmailLevel

instance.EmailLevel = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public CompletionAction EmailLevel { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property CompletionAction EmailLevel {
    CompletionAction get ();
    void set (CompletionAction value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member EmailLevel : CompletionAction with get, set

function get EmailLevel () : CompletionAction 
function set EmailLevel (value : CompletionAction)

Property Value

Type: Microsoft.SqlServer.Management.Smo.Agent.CompletionAction
A CompletionAction object value that specifies whether to send an e-mail notification to an operator.

Remarks

If directed, Microsoft SQL Server Agent can send an e-mail message when execution succeeds or fails. E-mail messages can also be sent regardless of success or failure of the job. By default, e-mail messages are not sent when execution finishes.

Examples

The following code example specifies that an e-mail notification is always sent to the operator when the job execution has finished.

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.EmailLevel = CompletionAction.Always;

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.EmailLevel = [Microsoft.SqlServer.Management.Smo.Agent.CompletionAction]::Always

See Also

Reference

Job Class

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_add_job (Transact-SQL)

Scheduling Automatic Administrative Tasks in SQL Server Agent