Export (0) Print
Expand All

MailProfile Class

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

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

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

The MailProfile type exposes the following members.

  NameDescription
Public methodMailProfile()Initializes a new instance of the MailProfile class.
Public methodMailProfile(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 methodMailProfile(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

  NameDescription
Public propertyDescriptionGets or sets a textual description of the purpose of the mail profile.
Public propertyForceDeleteForActiveProfilesGets or sets a Boolean which determines whether active profiles are deleted.
Public propertyIDGets the ID value that uniquely identifies the mail profile.
Public propertyIsBusyProfileGets a Boolean which determines whether the profile is busy. Busy in this context means that there are unsent items associated to this profile.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyParentGets or sets the SqlMail object that is the parent of the MailProfile object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAddAccountAssociates a mail account with the referenced mail profile.
Public methodAddPrincipal(String)Associates a security principal with the referenced mail profile.
Public methodAddPrincipal(String, Boolean)Associates a security principal with the referenced mail profile.
Public methodAlterUpdates any MailProfile object property changes on an instance of SQL Server running the SQL Server Database Mail subsystem. 
Public methodCreateCreates a mail profile on the instance of SQL Server running the SQL Server Database Mail subsystem, as defined by the MailProfile object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves an existing mail profile.
Public methodEnumAccountsReturns an enumerated list of email accounts associated with the referenced mail profile.
Public methodEnumPrincipalsReturns an enumerated list of security principals associated with the referenced mail profile.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRemoveAccountRemoves the association between a mail account and the referenced mail profile.
Public methodRemovePrincipalRemoves the association between a principal and the referenced mail profile.
Public methodRenameRenames the referenced mail profile.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail profile.
Public methodScript(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 methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft