Класс SqlMail

Класс SqlMail представляет подсистему SQL Server Database Mail.

Иерархия наследования

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
    Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
      Microsoft.SqlServer.Management.Smo.Mail..::..SqlMail

Пространство имен:  Microsoft.SqlServer.Management.Smo.Mail
Сборка:  Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)

Синтаксис

'Декларация
<SfcElementTypeAttribute("Mail")> _
Public NotInheritable Class SqlMail _
    Inherits SqlSmoObject _
    Implements IScriptable
'Применение
Dim instance As SqlMail

[SfcElementTypeAttribute("Mail")]
public sealed class SqlMail : SqlSmoObject, 
    IScriptable

[SfcElementTypeAttribute(L"Mail")]
public ref class SqlMail sealed : public SqlSmoObject, 
    IScriptable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Mail")>]
type SqlMail =  
    class
        inherit SqlSmoObject
        interface IScriptable
    end

public final class SqlMail extends SqlSmoObject implements IScriptable

Тип SqlMail обеспечивает доступ к следующим элементам.

Свойства

	Имя	Описание
	Accounts	Представляет набор объектов MailAccount. Каждый объект MailAccount представляет учетную запись подсистемы компонента SQL Server Database Mail.
	ConfigurationValues	Представляет набор объектов ConfigurationValue. Каждый объект ConfigurationValue представляет параметр конфигурации подсистемы SQL Server Database Mail.
	ExecuteForScalar	Возвращает или задает значение свойства типа Boolean, указывающее, настроен ли объект для выполнения в скалярном режиме. (Производный от SqlSmoObject.)
	IsTouched	Возвращает значение свойства типа Boolean, указывающее, были ли свойства объекта обновлены, но еще не сохранены на сервере. (Производный от SqlSmoObject.)
	ObjectInSpace	Возвращает значение свойства типа Boolean, указывающее, существует ли объект изолированно или же он явно или неявно подключен к экземпляру SQL Server. (Производный от SqlSmoObject.)
	Parent	Возвращает объект Server, являющийся родительским для объекта SqlMail.
	Profiles	Представляет набор объектов MailProfile. Каждый объект MailProfile представляет параметр конфигурации компонента SQL Server Database Mail.
	Properties	Возвращает коллекцию объектов Property, представляющих свойства объекта. (Производный от SqlSmoObject.)
	ScalarResult	Возвращает скалярный результат для объекта, на который ссылаются. (Производный от SqlSmoObject.)
	State	Gets the state of the referenced object. (Производный от SmoObjectBase.)
	Urn	Возвращает значение адреса универсального имени ресурса (URN), которое однозначно идентифицирует объект. (Производный от SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Производный от SmoObjectBase.)

В начало

Методы

	Имя	Описание
	AddDatabaseContext(StringCollection)	Добавляет контекст базы данных в коллекцию запросов, определенную параметром queries. (Производный от SqlSmoObject.)
	AddDatabaseContext(StringCollection, ScriptingOptions)	Добавляет контекст базы данных в коллекцию запросов, определяемую параметром queries при использовании указанных параметров создания скриптов. (Производный от SqlSmoObject.)
	AlterImpl	Активирует событие изменения объекта. (Производный от SqlSmoObject.)
	AlterImplFinish	Метод, вызываемый при завершении события изменения объекта. (Производный от SqlSmoObject.)
	AlterImplInit	Метод, вызываемый при инициализации события изменения объекта. (Производный от SqlSmoObject.)
	AlterImplWorker	Вызывает методы изменения. (Производный от SqlSmoObject.)
	BindDefaultImpl	Связывает элементы по умолчанию, определенные параметрами. (Производный от SqlSmoObject.)
	BindRuleImpl	Связывает схему правил с правилом и столбцами, определенными параметрами. (Производный от SqlSmoObject.)
	CheckCollation	Проверяет порядок параметров создания скриптов в методе сортировки, определенном параметром collationName. (Производный от SqlSmoObject.)
	CheckObjectState() () () ()	Проверяет состояние связанного объекта. (Производный от SqlSmoObject.)
	CheckObjectState(Boolean)	Проверяет состояние связанного объекта с возможностью указать исключение, возникающее, если объект еще не создан. (Производный от SqlSmoObject.)
	CheckObjectStateImpl	Проверяет состояние объекта SqlSmoObject. (Производный от SqlSmoObject.)
	CheckVersion100	Проверяет, является ли SQL Server версией SQL Server 2008. (Производный от SqlSmoObject.)
	CheckVersion80	Проверяет правильность объекта в SQL Server 2000. (Производный от SqlSmoObject.)
	CheckVersion80SP3	Проверяет правильность объекта в SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.)
	CheckVersion90	Проверяет правильность объекта в SQL Server 2005. (Производный от SqlSmoObject.)
	CheckVersionBelow90	Проверяет, является ли SQL Server более ранней версией, чем SQL Server 2005. (Производный от SqlSmoObject.)
	CleanObject	Устанавливает объект в неизмененное исходное состояние. (Производный от SqlSmoObject.)
	CreateImpl	Создает объект с параметрами создания скриптов. (Производный от SqlSmoObject.)
	CreateImplFinish	Метод, вызываемый при завершении события создания. (Производный от SqlSmoObject.)
	CreateImplInit	Метод, вызываемый при инициализации события создания. (Производный от SqlSmoObject.)
	Discover	Находит список типа Object. (Производный от SqlSmoObject.)
	DropImpl	Удаляет объект SqlSmoObject. (Производный от SqlSmoObject.)
	DropImplWorker	Вызывает методы удаления. (Производный от SqlSmoObject.)
	EnumScriptImpl	Перечисляет сценарии, заданные параметром so. (Производный от SqlSmoObject.)
	EnumScriptImplWorker	Вызывает методы, перечисляющие заданные параметром so сценарии. (Производный от SqlSmoObject.)
	EnumScriptImplWorkerSOChanged	Возвращает строку IEnumerable, описывающую параметры создания скриптов объекта. (Производный от SqlSmoObject.)
	Equals	(Производный от Object.)
	ExecuteNonQuery	(Производный от SqlSmoObject.)
	Finalize	(Производный от Object.)
	FormatSqlVariant	Форматирует объект как имеющий тип SqlVariant. (Производный от SqlSmoObject.)
	GenerateDataSpaceFileStreamScript	Формирует скрипт, создающий файл данных. (Производный от SqlSmoObject.)
	GenerateDataSpaceScript	Формирует скрипт, выделяющий пространство в файле данных. (Производный от SqlSmoObject.)
	GetBindDefaultScript	Возвращает скрипт, привязывающий значения по умолчанию, определенные параметрами defSchema и defName. (Производный от SqlSmoObject.)
	GetBindRuleScript	Возвращает скрипт, указывающий правила привязки. (Производный от SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Назначает параметр типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Назначает свойство типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetDateTimeParameter	Назначает свойство типа datetime объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetDateTimeParameterAsInt	Назначает свойство типа datetime объекта SqlSmoObject в виде целочисленного значения, если свойство типа datetime не равно NULL. (Производный от SqlSmoObject.)
	GetDBName	Возвращает имя базы данных, связанной с объектом. (Производный от SqlSmoObject.)
	GetEnumParameter	Назначает свойство перечисления SqlSmoObject. (Производный от SqlSmoObject.)
	GetFragOptionString	Возвращает объект FragmentationOption в виде строкового значения. (Производный от SqlSmoObject.)
	GetGuidParameter	Назначает свойство Guid объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetHashCode	(Производный от Object.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetPropValue	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetPropValueOptional	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetPropValueOptionalAllowNull	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetRealValue	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetScriptingOptionsForCreate	Возвращает параметры ScriptingOptions объектаSqlSmoObject. (Производный от SqlSmoObject.)
	GetServerName	Возвращает имя экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.)
	GetServerObject	Возвращает сервер объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetSqlServerVersionName	Возвращает имя версии экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetTimeSpanParameterAsInt	Назначает параметр временного диапазона объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetType	(Производный от Object.)
	GetUrnRecursive(StringBuilder)	Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.)
	ImplInitialize	Инициализирует поля объекта SqlSmoObject. (Производный от SqlSmoObject.)
	Initialize() () () ()	Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.)
	Initialize(Boolean)	Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.)
	IsObjectDirty	Проверяет, было ли изменено свойство объекта, еще не сохраненное в экземпляре SQL Server. (Производный от SqlSmoObject.)
	IsObjectInitialized	Проверяет, был ли объект инициализирован. (Производный от SqlSmoObject.)
	IsObjectInSpace	Проверяет, является ли объект изолированным или подключенным к экземпляру SQL Server. (Производный от SqlSmoObject.)
	IsVersion80SP3	Определяет, является ли SQL Server версией SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.)
	IsVersion90AndAbove	Определяет, является ли SQL Server версией SQL Server 2005 или более поздней. (Производный от SqlSmoObject.)
	MarkDropped	Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.)
	MarkForDropImpl	Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.)
	MemberwiseClone	(Производный от Object.)
	PostAlter	Метод, активируемый после изменения SqlSmoObject. (Производный от SqlSmoObject.)
	PostCreate	Метод, активируемый после создания SqlSmoObject. (Производный от SqlSmoObject.)
	PostDrop	Метод, активируемый после удаления SqlSmoObject. (Производный от SqlSmoObject.)
	Refresh	Обновляет объект и извлекает свойства объекта при следующем обращении. (Производный от SqlSmoObject.)
	Script() () () ()	Формирует скрипт Transact-SQL, который может быть использован для повторного создания подсистемы компонента SQL Server Database Mail.
	Script(ScriptingOptions)	Формирует скрипт Transact-SQL, который может быть использован для повторного создания подсистемы компонента SQL Server Database Mail, в соответствии с параметрами создания скрипта.
	ScriptAlter	Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
	ScriptCreate	Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
	ScriptDdl	Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
	ScriptDrop	Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
	ScriptImpl() () () ()	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptImplWorker	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	SetParentImpl	Устанавливает родительский объект объекта SqlSmoObject в значение параметра newParent. (Производный от SqlSmoObject.)
	ToString	Возвращает String, представляющее объект, на который ссылаются. (Производный от SqlSmoObject.)
	TouchImpl	Не реализовано. (Производный от SqlSmoObject.)
	UnbindDefaultImpl	Отменяет привязку столбцов по умолчанию для объекта SqlSmoObject. (Производный от SqlSmoObject.)
	UnbindRuleImpl	Отменяет привязку правил для объекта SqlSmoObject. (Производный от SqlSmoObject.)
	Validate	Validates the state of an object. (Производный от SmoObjectBase.)

В начало

События

	Имя	Описание
	PropertyChanged	Представляет событие, возникающее при изменении свойства. (Производный от SqlSmoObject.)
	PropertyMetadataChanged	Представляет событие, возникающее при изменении метаданных свойства. (Производный от SqlSmoObject.)

В начало

Поля

	Имя	Описание
	m_ExtendedProperties	Представляет свойство, определенное для расширения свойств, предоставляемых объектом SqlSmoObject. (Производный от SqlSmoObject.)
	singletonParent	Представляет единственного родителя. (Производный от SqlSmoObject.)

В начало

Явные реализации интерфейса

	Имя	Описание
	IAlienObject. . :: . .Discover	Находит любые зависимости. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetDomainRoot	Возвращает корневой элемент домена. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetParent	Возвращает родительский объект для данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetPropertyType	Возвращает тип указанного свойства. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetPropertyValue	Возвращает значение указанного свойства. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetUrn	Возвращает универсальное имя ресурса для объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .Resolve	Возвращает экземпляр, содержащий данные об объекте из универсального имени ресурса для объекта. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .SetObjectState	Задает состоянию объекта указанное значение SfcObjectState. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .SetPropertyValue	Устанавливает значение свойства. (Производный от SqlSmoObject.)
	ISfcPropertyProvider. . :: . .GetPropertySet	Возвращает ссылку на интерфейс для набора свойств данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)

В начало

Замечания

The SqlMail object provides programmatic access to the SQL Server Database Mail subsystem. With the SqlMail object you can:

• Configure the SQL Server Database Mail subsystem.

• Monitor the SQL Server Database Mail subsystem.

The SqlMail object does not provide access to individual mailboxes or the sending and receiving of messages. It provides configuration and monitoring functionality only.

The SqlMail class is the top level class in the Microsoft.SqlServer.Management.Smo.Mail namespace.

Thread Safety

Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Безопасная многопоточная работа с членами экземпляров типа не гарантируется.

Примеры

Использование компонента Database Mail

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Management.Smo.Mail

Другие ресурсы

Компонент Database Mail