MailAccount Class

The MailAccount class represents a SQL Server Database Mail subsystem mail account.

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

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

Syntax

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

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

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

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

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

The MailAccount type exposes the following members.

Constructors

	Name	Description
	MailAccount()	Initializes a new instance of the MailAccount class.
	MailAccount(SqlMail, String)	Initializes a new instance of the MailAccount class on the specified instance of SQL Server Database Mail subsystem and with the specified name.
	MailAccount(SqlMail, String, String)	Initializes a new instance of the MailAccount class on the specified instance of SQL Server Database Mail subsystem and with the specified name and description.
	MailAccount(SqlMail, String, String, String, String)	Initializes a new instance of the MailAccount class on the specified instance of SQL Server Database Mail subsystem and with the specified name, description, display name, and e-mail address.

Top

Properties

	Name	Description
	Description	Gets or sets a textual description of the purpose of the mail account.
	DisplayName	Gets or sets the name of the mail account that is displayed in messages.
	EmailAddress	Gets or sets the e-mail address of the mail account.
	ID	Gets the ID value that uniquely identifies the mail account.
	IsBusyAccount	Gets a Boolean which indicates whether the account has unsent items.
	MailServers	Represents a collection of MailServer objects. Each MailServer object represents a mail server associated with the mail account.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Parent	Gets or sets the SqlMail object that is the parent of the MailAccount object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ReplyToAddress	Gets or sets the e-mail address to which the mail account replies.
	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.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any MailAccount object property changes on an instance of SQL Server running the SQL Server Database Mail subsystem.
	Create	Creates a mail account on the instance of SQL Server running the SQL Server Database Mail subsystem, as defined by the MailAccount object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes an existing mail account.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetAccountProfileNames	Gets a string array containing the names of the Mail Profiles which this Mail Account belongs to.
	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 account.
	Script()	Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail account.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the SQL Server Database Mail account, as specified by the scripting options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	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

The MailAccount object provides programmatic access to the mail account in the SQL Server Database Mail subsystem. By using the MailAccount object, you can manage SQL Server Database Mail accounts. 

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