sysmail_update_account_sp (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 , 
    [ @username = ] 'username' ,
    [ @password = ] 'password' ,
    [ @use_default_credentials = ] use_default_credentials ,
    [ @no_credential_change = ] changes to username and password ,
    [ @enable_ssl = ] enable_ssl 

Argumentos

• [ @account_id = ] account_id
  O ID da conta a ser atualizada. account_id é int, com um padrão NULL. Pelo menos uma account_id ou um 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 NULL. Pelo menos uma account_id ou um 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 de servidor no endereço é o servidor que o Database Mail usa para enviar email dessa conta. email_address é nvarchar(128), com um padrão NULL.

• [ @display_name = ] 'display_name'
  O novo nome para exibição a ser usado em mensagens de email desta conta. display_name é nvarchar(128), sem nenhum 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 nenhum padrão.

• [ @description = ] 'description'
  A nova descrição da conta. description é nvarchar(256), com um padrão 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 server_name para um endereço IP. server_name é sysname, sem padrão.

• [ @mailserver_type = ] 'server_type'
  O novo tipo do servidor de email. server_type é sysname, sem nenhum padrão. Para o SQL Server 2005 e posterior, há suporte somente para um valor de 'SMTP'.

• [ @port = ] port_number
  O número de porta novo do servidor de email. port_number é int, sem nenhum padrão.

• [ @username = ] 'username'
  O novo nome de usuário a ser usado para fazer logon no servidor de email. User name é sysname, sem nenhum padrão.

• [ @password = ] 'password'
  A nova senha a ser usada para fazer logon no servidor de email. password é sysname, sem nenhum padrão.

• [ @use_default_credentials = ] use_default_credentials
  Especifica se o email deve ser enviado para o servidor SMTP usando as credenciais de serviço do Mecanismo de Banco de Dados do SQL Server. use_default_credentials é bit, sem nenhum padrão. Quando este parâmetro for 1, o Database Mail usará as credenciais do Mecanismo de Banco de Dados. Quando este parâmetro for 0, o Database Mail usará @username e @password para autenticação no servidor SMTP. Se @username e @password forem NULL, ele usará a autenticação anônima. Consulte o administrador de SMTP antes de especificar este parâmetro.

• [ @no_credential_change =] alterações em nome de usuário e senha
  Especifica se as credenciais existentes (nome de usuário e senha) devem ser alteradas. Quando esse parâmetro for 1, indicará nenhuma alteração de credenciais, e @username e @password não serão necessários. Quando esse parâmetro for 0, indicará alterações de credenciais, e @username e @password deverão ser fornecidos. Esse parâmetro tem como padrão bit com 0.

• [ @enable_ssl = ] enable_ssl
  Especifica se o Database Mail criptografa a comunicação usando o Protocolo SSL. Use esta opção se o SSL for necessário em seu servidor SMTP. enable_ssl é bit, sem padrão.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Comentários

Quando o nome e a identificação da conta são especificados, o procedimento armazenado altera o nome da conta além de atualizar as informações da conta. A alteração do nome da conta pode ser útil para corrigir erros que existam nela.

O parâmetro @no_credential_change pode ser usado para fazer alterações que não sejam de nome de usuário e senha para uma conta que esteja usando autenticação básica para enviar email. Por exemplo, você pode habilitar o SSL sem precisar fornecer o nome de usuário e a senha especificando @no_credential_change = 1.

O procedimento armazenado sysmail_update_account_sp está no banco de dados msdb e pertence ao esquema dbo. O procedimento deverá ser executado com um nome de três partes se o banco de dados atual não for msdb.

Permissões

Requer associação à função de servidor fixa sysadmin.

Exemplos

A. Alterando as informações de uma conta

EXECUTE 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
    ,@username = NULL
    ,@password = NULL
    ,@use_default_credentials = 0
    ,@enable_ssl = 0;

B. Alterando o nome de uma conta e as informações de uma conta

EXECUTE 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,
    ,@username = NULL
    ,@password = NULL
    ,@use_default_credentials = 0
    ,@enable_ssl = 0;

C. Usando @no\_credential\_change para alterar somente o SSL de uma conta

EXECUTE msdb.dbo.sysmail_update_account_sp
    ,@account_id = 125
    ,@enable_ssl = 1
    ,@no_credential_change = 1;

Histórico de alterações

Consulte também

Referência

Conceitos