ScriptingOptions.NoMailProfilePrincipals Property

Applies To: SQL Server 2016 Preview

Gets or sets the Boolean property value that specifies whether principals that are referenced by mail profiles are included in the generated script.

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

Syntax

public bool NoMailProfilePrincipals { get; set; }

public:
property bool NoMailProfilePrincipals {
    bool get();
    void set(bool value);
}

member NoMailProfilePrincipals : bool with get, set

Public Property NoMailProfilePrincipals As Boolean

A Boolean value that specifies whether mail accounts that are referenced by principals are included in the generated script.

If True, principals referenced by mail profiles are not included in the generated script. Otherwise, False (default).

The following code example specifies principals referenced by mail profiles will not be scripted.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.NoMailProfilePrincipals = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.NoMailProfilePrincipals = $TRUE