sysmail_update_account_sp (Transact-SQL)
Aplica-se: SQL Server
Altera as informações em uma conta existente do Database Mail.
Convenções de sintaxe de Transact-SQL
Sintaxe
sysmail_update_account_sp [ [ @account_id = ] account_id ] [ , ] [ [ @account_name = ] 'account_name' ]
, [ @email_address = ] 'email_address'
, [ @display_name = ] 'display_name'
, [ @replyto_address = ] 'replyto_address'
, [ @description = ] 'description'
, [ @mailserver_name = ] 'server_name'
, [ @mailserver_type = ] 'server_type'
, [ @port = ] port_number
, [ @timeout = ] 'timeout'
, [ @username = ] 'username'
, [ @password = ] 'password'
, [ @use_default_credentials = ] use_default_credentials
, [ @enable_ssl = ] enable_ssl
[ ; ]
Argumentos
@account_id [ = ] account_id
A ID da conta a ser atualizada. @account_id é int, com um padrão de NULL
. Pelo menos um dos @account_id ou @account_name deve ser especificado. Se ambos forem especificados, o procedimento alterará o nome da conta.
@account_name [ = ] 'account_name'
O nome da conta a ser atualizada. @account_name é sysname, com um padrão de NULL
. Pelo menos um dos @account_id ou @account_name deve ser especificado. Se ambos forem especificados, o procedimento alterará o nome da conta.
@email_address [ = ] 'email_address'
O novo endereço de email a partir do qual a mensagem será enviada. Esse endereço deve ser um endereço de email na Internet. O nome do servidor no endereço é o servidor que o Database Mail usa para enviar email dessa conta. @email_address é nvarchar(128), com um padrão de NULL
.
@display_name [ = ] 'display_name'
O novo nome para exibição a ser usado em mensagens de email enviadas por essa conta. @display_name é nvarchar(128), sem padrão.
@replyto_address [ = ] 'replyto_address'
O novo endereço a ser usado no cabeçalho Responder das mensagens de email desta conta. @replyto_address é nvarchar(128), sem padrão.
@description [ = ] 'descrição'
A nova descrição da conta. @description é nvarchar(256), com um padrão de NULL
.
@mailserver_name [ = ] 'server_name'
O novo nome do servidor de email SMTP a ser usado para essa conta. O computador que executa o SQL Server deve ser capaz de resolver o @mailserver_name para um endereço IP. @mailserver_name é sysname, sem padrão.
@mailserver_type [ = ] 'server_type'
O novo tipo do servidor de email. @mailserver_type é sysname, sem padrão. Há suporte apenas para um valor de SMTP
.
@port [ = ] port_number
O novo número da porta do servidor de email. @port é int, sem padrão.
@timeout [ = ] 'tempo limite'
Parâmetro Timeout para SmtpClient.Send
uma única mensagem de email. @timeout é int em segundos, sem padrão.
@username [ = ] 'nome de usuário'
O novo nome do usuário a ser usado para fazer logon no servidor de email. @username é sysname, sem padrão.
@password [ = ] 'senha'
A nova senha a ser usada para fazer logon no servidor de email. @password é sysname, sem padrão.
@use_default_credentials [ = ] use_default_credentials
Especifica se o email deve ser enviado para o servidor SMTP usando as credenciais do serviço Mecanismo de Banco de Dados do SQL Server. @use_default_credentials é bit, sem padrão. Quando esse parâmetro é 1, o Database Mail usa as credenciais do Mecanismo de Banco de Dados. Quando esse parâmetro é 0, o Database Mail usa o @username e o @password para autenticação no servidor SMTP. Se @username e @password forem NULL
, ele usará autenticação anônima. Consulte o administrador de SMTP antes de especificar este parâmetro.
@enable_ssl [ = ] enable_ssl
Especifica se o Database Mail criptografa a comunicação usando o Transport Layer Security (TLS), anteriormente conhecido como Secure Sockets Layer (SSL). Use essa opção se o TLS for necessário em seu servidor SMTP. @enable_ssl é bit, sem padrão.
Valores do código de retorno
0
(sucesso) ou 1
(falha).
Comentários
Quando o nome da conta e a ID da conta são especificados, o procedimento armazenado altera o nome da conta, além de atualizar as informações da conta. Alterar o nome da conta é útil para corrigir erros no nome da conta.
O procedimento sysmail_update_account_sp
armazenado está no msdb
banco de dados e pertence ao dbo
esquema. O procedimento deve ser executado com um nome de três partes se o banco de dados atual não msdb
for .
Permissões
Você pode conceder EXECUTE
permissões nesse procedimento, mas essas permissões podem ser substituídas durante uma atualização do SQL Server.
Exemplos
R. Alterar as informações de uma conta
O exemplo a seguir atualiza a conta AdventureWorks Administrator
no msdb
banco de dados. As informações da conta são definidas com os valores fornecidos.
EXEC msdb.dbo.sysmail_update_account_sp
@account_name = 'AdventureWorks Administrator',
@description = 'Mail account for administrative e-mail.',
@email_address = 'dba@adventure-works.com',
@display_name = 'AdventureWorks Automated Mailer',
@replyto_address = NULL,
@mailserver_name = 'smtp.adventure-works.com',
@mailserver_type = 'SMTP',
@port = 25,
@timeout = 60,
@username = NULL,
@password = NULL,
@use_default_credentials = 0,
@enable_ssl = 0;
B. Alterar o nome de uma conta e as informações de uma conta
O exemplo a seguir altera o nome e atualiza as informações da conta para o com ID da conta 125
. O novo nome da conta é Backup Mail Server
.
EXEC msdb.dbo.sysmail_update_account_sp
@account_id = 125,
@account_name = 'Backup Mail Server',
@description = 'Mail account for administrative e-mail.',
@email_address = 'dba@adventure-works.com',
@display_name = 'AdventureWorks Automated Mailer',
@replyto_address = NULL,
@mailserver_name = 'smtp-backup.adventure-works.com',
@mailserver_type = 'SMTP',
@port = 25,
@timeout = 60,
@username = NULL,
@password = NULL,
@use_default_credentials = 0,
@enable_ssl = 0;