Classe SqlMail
A classe SqlMail representa o subsistema SQL Server Database Mail.
Hierarquia de herança
System. . :: . .Object
Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
Microsoft.SqlServer.Management.Smo.Mail..::..SqlMail
Namespace: Microsoft.SqlServer.Management.Smo.Mail
Assembly: Microsoft.SqlServer.Smo (em Microsoft.SqlServer.Smo.dll)
Sintaxe
'Declaração
<SfcElementTypeAttribute("Mail")> _
Public NotInheritable Class SqlMail _
Inherits SqlSmoObject _
Implements IScriptable
'Uso
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
O tipo SqlMail expõe os membros a seguir.
Propriedades
Nome | Descrição | |
---|---|---|
Accounts | Representa uma coleção de objetos MailAccount. Cada objeto MailAccount representa uma conta do SQL Server Database Mail. | |
ConfigurationValues | Representa uma coleção de objetos ConfigurationValue. Cada objeto ConfigurationValue representa uma opção de configuração do SQL Server Database Mail. | |
ExecuteForScalar | Obtém ou define o valor da propriedade Boolean que especifica se o objeto esta definido para a opção execute for scalar. (Herdado de SqlSmoObject.) | |
IsTouched | Obtém o valor da propriedade Boolean que especifica se as propriedades do objeto foram atualizadas, mas ainda não foram persistidas no servidor. (Herdado de SqlSmoObject.) | |
ObjectInSpace | Obtém o valor da propriedade Boolean que especifica se o objeto existe em isolamento ou se está direta ou indiretamente conectado com a instância do SQL Server. (Herdado de SqlSmoObject.) | |
Parent | Obtém o objeto Server que é o pai do objeto SqlMail. | |
Profiles | Representa uma coleção de objetos MailProfile. Cada objeto MailProfile representa uma opção de configuração do SQL Server Database Mail. | |
Properties | Obtém uma coleção de objetos Property que representam as propriedades do objeto. (Herdado de SqlSmoObject.) | |
ScalarResult | Obtém o resultado escalar do objeto referenciado. (Herdado de SqlSmoObject.) | |
State | Gets the state of the referenced object. (Herdado de SmoObjectBase.) | |
Urn | Obtém o valor do endereço do URN (Uniform Resource Name) que identifica exclusivamente o objeto. (Herdado de SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.) |
Início
Métodos
Nome | Descrição | |
---|---|---|
AddDatabaseContext(StringCollection) | Adiciona o contexto do banco de dados à coleção de consultas identificadas pelo parâmetro queries. (Herdado de SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Adiciona o contexto de banco de dados à coleção de consultas identificadas pelo parâmetro queries e usando as opções de script especificadas. (Herdado de SqlSmoObject.) | |
AlterImpl | Ativa o evento alterado do objeto. (Herdado de SqlSmoObject.) | |
AlterImplFinish | Método chamado quando o evento alterado do objeto é concluído. (Herdado de SqlSmoObject.) | |
AlterImplInit | Método chamado quando o evento de alteração do objeto é inicializado. (Herdado de SqlSmoObject.) | |
AlterImplWorker | Chama os métodos Alter. (Herdado de SqlSmoObject.) | |
BindDefaultImpl | Associa os itens padrão identificados pelos parâmetros. (Herdado de SqlSmoObject.) | |
BindRuleImpl | Associa o esquema de regra à regra e às colunas identificadas pelos parâmetros. (Herdado de SqlSmoObject.) | |
CheckCollation | Verifica a ordem das opções de script pelo método de agrupamento identificado pelo parâmetro collationName. (Herdado de SqlSmoObject.) | |
CheckObjectState() () () () | Valida o estado do objeto referenciado. (Herdado de SqlSmoObject.) | |
CheckObjectState(Boolean) | Valida o estado do objeto referenciado com a opção de especificar que uma exceção será gerada se o objeto ainda não tiver sido criado. (Herdado de SqlSmoObject.) | |
CheckObjectStateImpl | Verifica o estado de um SqlSmoObject. (Herdado de SqlSmoObject.) | |
CheckVersion100 | Verifica se a versão do SQL Server é SQL Server 2008. (Herdado de SqlSmoObject.) | |
CheckVersion80 | Verifica a validade do objeto no SQL Server 2000. (Herdado de SqlSmoObject.) | |
CheckVersion80SP3 | Verifica a validade do objeto no SQL Server 2000 SP3. (Herdado de SqlSmoObject.) | |
CheckVersion90 | Verifica a validade do objeto no SQL Server 2005. (Herdado de SqlSmoObject.) | |
CheckVersionBelow90 | Verifica se a versão do SQL Server é anterior ao SQL Server 2005. (Herdado de SqlSmoObject.) | |
CleanObject | Define o objeto como estado inalterado. (Herdado de SqlSmoObject.) | |
CreateImpl | Cria um objeto com as opções do script. (Herdado de SqlSmoObject.) | |
CreateImplFinish | Método chamado quando o evento de criação é concluído. (Herdado de SqlSmoObject.) | |
CreateImplInit | Método chamado quando o evento de criação é inicializado. (Herdado de SqlSmoObject.) | |
Discover | Descobre uma lista do tipo Object. (Herdado de SqlSmoObject.) | |
DropImpl | Remove um SqlSmoObject. (Herdado de SqlSmoObject.) | |
DropImplWorker | Chama os métodos de remoção. (Herdado de SqlSmoObject.) | |
EnumScriptImpl | Enumera scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.) | |
EnumScriptImplWorker | Chama os métodos que enumeram scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Retorna uma cadeia de caracteres IEnumerable que descreve as opções de script de um objeto. (Herdado de SqlSmoObject.) | |
Equals | (Herdado de Object.) | |
ExecuteNonQuery | (Herdado de SqlSmoObject.) | |
Finalize | (Herdado de Object.) | |
FormatSqlVariant | Formata um objeto como tipo SqlVariant. (Herdado de SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Gera um script para criar arquivo de dados. (Herdado de SqlSmoObject.) | |
GenerateDataSpaceScript | Gera um script para alocar espaço no arquivo de dados. (Herdado de SqlSmoObject.) | |
GetBindDefaultScript | Obtém o script que associa padrões especificados pelos parâmetros defSchema e defName. (Herdado de SqlSmoObject.) | |
GetBindRuleScript | Obtém o script que especifica as regras de associação. (Herdado de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro booliano do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui uma propriedade booliana do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetDateTimeParameter | Atribui a propriedade datetime do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetDateTimeParameterAsInt | Atribuirá a propriedade datetime do SqlSmoObject como um valor inteiro se a propriedade datetime não for nula. (Herdado de SqlSmoObject.) | |
GetDBName | Obtém o nome do banco de dados associado ao objeto. (Herdado de SqlSmoObject.) | |
GetEnumParameter | Atribui uma propriedade de enumeração do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetFragOptionString | Obtém um objeto FragmentationOption como um valor de cadeia de caracteres. (Herdado de SqlSmoObject.) | |
GetGuidParameter | Atribui uma propriedade Guid do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetHashCode | (Herdado de Object.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValue | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValueOptional | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetRealValue | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetScriptingOptionsForCreate | Obtém ScriptingOptions para o objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetServerName | Obtém o nome da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.) | |
GetServerObject | Obtém o servidor do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetSqlServerVersionName | Obtém o nome da versão da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetTimeSpanParameterAsInt | Atribui um parâmetro de período de tempo do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetType | (Herdado de Object.) | |
GetUrnRecursive(StringBuilder) | Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
ImplInitialize | Inicializa os campos do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
Initialize() () () () | Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.) | |
Initialize(Boolean) | Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.) | |
IsObjectDirty | Verifica se as propriedades de objeto foram modificadas e se as alterações ainda não foram persistidas na instância do SQL Server. (Herdado de SqlSmoObject.) | |
IsObjectInitialized | Verifica se o objeto foi inicializado. (Herdado de SqlSmoObject.) | |
IsObjectInSpace | Verifica se o objeto está isolado ou conectado com a instância do SQL Server. (Herdado de SqlSmoObject.) | |
IsVersion80SP3 | Determina se a versão do SQL Server é SQL Server 2000 com SP3. (Herdado de SqlSmoObject.) | |
IsVersion90AndAbove | Determina se a versão do SQL Server é SQL Server 2005 ou posterior. (Herdado de SqlSmoObject.) | |
MarkDropped | Define o SqlSmoState como removido. (Herdado de SqlSmoObject.) | |
MarkForDropImpl | Define o SqlSmoState como removido. (Herdado de SqlSmoObject.) | |
MemberwiseClone | (Herdado de Object.) | |
PostAlter | Método ativado depois da alteração do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PostCreate | Método ativado depois da criação do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PostDrop | Método ativado depois da remoção do SqlSmoObject. (Herdado de SqlSmoObject.) | |
Refresh | Atualiza o objeto e recupera as propriedades na próxima vez que o objeto é acessado. (Herdado de SqlSmoObject.) | |
Script() () () () | Gera um script Transact-SQL que pode ser usado para recriar o subsistema SQL Server Agent Database Mail. | |
Script(ScriptingOptions) | Gera um script Transact-SQL que pode ser usado para recriar o subsistema SQL Server Database Mail, conforme especificado pelas opções do script. | |
ScriptAlter | Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.) | |
ScriptCreate | Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.) | |
ScriptDdl | Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.) | |
ScriptDrop | Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.) | |
ScriptImpl() () () () | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptImplWorker | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
SetParentImpl | Define o pai do SqlSmoObject como o parâmetro newParent. (Herdado de SqlSmoObject.) | |
ToString | Retorna um String que representa o objeto referenciado. (Herdado de SqlSmoObject.) | |
TouchImpl | Não implementado. (Herdado de SqlSmoObject.) | |
UnbindDefaultImpl | Desassocia as colunas padrão do SqlSmoObject. (Herdado de SqlSmoObject.) | |
UnbindRuleImpl | Desassocia as regras do SqlSmoObject. (Herdado de SqlSmoObject.) | |
Validate | Validates the state of an object. (Herdado de SmoObjectBase.) |
Início
Eventos
Nome | Descrição | |
---|---|---|
PropertyChanged | Representa o evento que ocorre quando uma propriedade é alterada. (Herdado de SqlSmoObject.) | |
PropertyMetadataChanged | Representa o evento que ocorre quando os metadados da propriedade são alterados. (Herdado de SqlSmoObject.) |
Início
Campos
Nome | Descrição | |
---|---|---|
m_ExtendedProperties | Representa uma propriedade definida para estender as propriedades fornecidas por um SqlSmoObject. (Herdado de SqlSmoObject.) | |
singletonParent | Representa o pai do singleton. (Herdado de SqlSmoObject.) |
Início
Implementações de interfaces explícitas
Nome | Descrição | |
---|---|---|
IAlienObject. . :: . .Discover | Descobre quaisquer dependências. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetDomainRoot | Retorna a raiz do domínio. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetParent | Obtém o pai do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyType | Obtém o tipo da propriedade especificada. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyValue | Obtém o valor da propriedade especificada. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetUrn | Obtém o Unified Resource Name do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .Resolve | Obtém a instância que contém as informações sobre o objeto a partir do Unified Resource Name do objeto. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .SetObjectState | Define o estado do objeto como o valor SfcObjectState especificado. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .SetPropertyValue | Define o valor da propriedade. (Herdado de SqlSmoObject.) | |
ISfcPropertyProvider. . :: . .GetPropertySet | Obtém a referência da interface para o conjunto de propriedades deste objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) |
Início
Comentários
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
Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads.
Segurança de thread
Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.
Consulte também