Share via

MailProfile.AddPrincipal Method (String, Boolean)

  • Article

Associates a security principal with the referenced mail profile.

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

Syntax

'Declaration
Public Sub AddPrincipal ( _
    principalName As String, _
    isDefaultProfile As Boolean _
)
'Usage
Dim instance As MailProfile 
Dim principalName As String 
Dim isDefaultProfile As Boolean

instance.AddPrincipal(principalName, _
    isDefaultProfile)

public void AddPrincipal(
    string principalName,
    bool isDefaultProfile
)

public:
void AddPrincipal(
    String^ principalName, 
    bool isDefaultProfile
)

member AddPrincipal : 
        principalName:string * 
        isDefaultProfile:bool -> unit

public function AddPrincipal(
    principalName : String, 
    isDefaultProfile : boolean
)

Parameters

  • principalName
    Type: System.String
    A String value that specifies the name of the security principal.
  • isDefaultProfile
    Type: System.Boolean
    A Boolean value that specifies whether the referenced profile is set as the default profile for the principal. If True, the referenced profile is the default profile for the principal.If False, the referenced profile is not the default profile for the principal.

Remarks

A principal refers to a database user, a database role or server role, an application role, or a SQL Server login. You can add these types of users to the mail profile.

Examples

Using Database Mail

See Also

Reference

MailProfile Class

AddPrincipal Overload

Microsoft.SqlServer.Management.Smo.Mail Namespace

Other Resources

Database Mail