Share via

MailProfile Class

  • Article

The MailProfile class represents a SQL Server Database Mail subsystem mail profile.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Mail.MailProfile

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

Syntax

'Declaration
Public NotInheritable Class MailProfile _
    Inherits ScriptNameObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Usage
Dim instance As MailProfile

public sealed class MailProfile : ScriptNameObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

public ref class MailProfile sealed : public ScriptNameObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[<SealedAttribute>]
type MailProfile =  
    class 
        inherit ScriptNameObjectBase 
        interface IAlterable 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IScriptable 
    end

public final class MailProfile extends ScriptNameObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

The MailProfile type exposes the following members.

Constructors

  Name Description
Public method MailProfile() Initializes a new instance of the MailProfile class.
Public method MailProfile(SqlMail, String) Initializes a new instance of the MailProfile class on the specified instance of SQL Server Database Mail subsystem and with the specified name.
Public method MailProfile(SqlMail, String, String) Initializes a new instance of the MailProfile class on the specified instance of SQL Server Database Mail subsystem and with the specified name and description.

Top

Properties

  Name Description
Public property Description Gets or sets a textual description of the purpose of the mail profile.
Public property ForceDeleteForActiveProfiles Gets or sets a Boolean which determines whether active profiles are deleted.
Public property ID Gets the ID value that uniquely identifies the mail profile.
Public property IsBusyProfile Gets a Boolean which determines whether the profile is busy. Busy in this context means that there are unsent items associated to this profile.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Parent Gets or sets the SqlMail object that is the parent of the MailProfile object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method AddAccount Associates a mail account with the referenced mail profile.
Public method AddPrincipal(String) Associates a security principal with the referenced mail profile.
Public method AddPrincipal(String, Boolean) Associates a security principal with the referenced mail profile.
Public method Alter Updates any MailProfile object property changes on an instance of SQL Server running the SQL Server Database Mail subsystem. 
Public method Create Creates a mail profile on the instance of SQL Server running the SQL Server Database Mail subsystem, as defined by the MailProfile object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes an existing mail profile.
Public method EnumAccounts Returns an enumerated list of email accounts associated with the referenced mail profile.
Public method EnumPrincipals Returns an enumerated list of security principals associated with the referenced mail profile.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method RemoveAccount Removes the association between a mail account and the referenced mail profile.
Public method RemovePrincipal Removes the association between a principal and the referenced mail profile.
Public method Rename Renames the referenced mail profile.
Public method Script() Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail profile.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail profile, as specified by the scripting options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

The MailProfile object provides programmatic access to the mail profile in the SQL Server Database Mail subsystem. With the MailAccount object you can manage SQL Server Database Mail profiles.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Using Database Mail

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Mail Namespace

Other Resources

Database Mail