MailServer Class

The MailServer class represents a SQL Server Database Mail subsystem mail server.

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.MailServer

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

Syntax

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

public sealed class MailServer : ScriptNameObjectBase, 
    IRenamable, IAlterable, IScriptable

public ref class MailServer sealed : public ScriptNameObjectBase, 
    IRenamable, IAlterable, IScriptable

[<SealedAttribute>]
type MailServer =  
    class 
        inherit ScriptNameObjectBase 
        interface IRenamable 
        interface IAlterable 
        interface IScriptable 
    end

public final class MailServer extends ScriptNameObjectBase implements IRenamable, IAlterable, IScriptable

The MailServer type exposes the following members.

Properties

	Name	Description
	EnableSsl	Gets or sets whether the secure socket layer is enabled.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	NoCredentialChange	Gets or sets whether credentials can be changed.
	Parent	Gets or sets the MailAccount object that is the parent of the MailServer object.
	Port	Gets or sets the port setting for the mail server.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ServerType	Gets the type of mail server.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UseDefaultCredentials	Gets or sets whether to use default credentials.
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
	UserName	Gets or sets the user name associated with the referenced mail server.

Top

Methods

	Name	Description
	Alter	Updates any MailServer object property changes on an instance of SQL Server.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Rename	Renames the mail server.
	Script()	Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail server.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail server.
	SetAccount(String, SecureString)	Sets the mail server account.
	SetAccount(String, String)	Sets the mail server account.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetPassword(SecureString)	Sets the password.
	SetPassword(String)	Sets the password for the user account.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

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

Top

Remarks

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