sysmail_update_account_sp (Transact-SQL)

Cambia la información de una cuenta existente del Correo electrónico de base de datos.

Icono de vínculo a temasConvenciones de sintaxis de Transact-SQL

Sintaxis

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 ,
    [ @enable_ssl = ] enable_ssl 

Argumentos

  • [ @account_id = ] account_id
    Identificador de cuenta que se va a actualizar. account_id es de tipo int y su valor predeterminado es NULL. Se debe especificar account_id o account_name. Si se especifican los dos, el procedimiento cambia el nombre de la cuenta.

  • [ @account_name = ] 'account_name'
    Nombre de la cuenta que se va a actualizar. account_name es de tipo sysname y su valor predeterminado es NULL. Se debe especificar account_id o account_name. Si se especifican los dos, el procedimiento cambia el nombre de la cuenta.

  • [ @email_address = ] 'email_address'
    Es la nueva dirección de correo electrónico desde la que se envía el mensaje. Esta dirección debe ser una dirección de correo electrónico de Internet. El nombre del servidor en la dirección es el servidor que el Correo electrónico de base de datos utiliza para enviar correo desde esta cuenta. email_address es de tipo nvarchar(128) y su valor predeterminado es NULL.

  • [ @display_name = ] 'display_name'
    Es el nuevo nombre para mostrar que se debe utilizar en los mensajes de correo electrónico que se envían desde esta cuenta. display_name es de tipo nvarchar(128) y no tiene ningún valor predeterminado.

  • [ @replyto_address = ] 'replyto_address'
    Es la nueva dirección que se debe utilizar en el encabezado Responder a de los mensajes de correo electrónico que se envían desde esta cuenta. replyto_address es de tipo nvarchar(128) y no tiene ningún valor predeterminado.

  • [ @description = ] 'description'
    Es la nueva descripción de la cuenta. description es de tipo nvarchar(256) y su valor predeterminado es NULL.

  • [ @mailserver_name = ] 'server_name'
    Es el nuevo nombre del servidor de correo SMTP que se debe utilizar para esta cuenta. El equipo que ejecuta SQL Server debe poder resolver el valor de server_name como una dirección IP. server_name es de tipo sysname y no tiene ningún valor predeterminado.

  • [ @mailserver_type = ] 'server_type'
    Es el nuevo tipo del servidor de correo. server_type es de tipo sysname y no tiene ningún valor predeterminado. En SQL Server 2005 y versiones posteriores, sólo se admite un valor 'SMTP'.

  • [ @port = ] port_number
    Es el nuevo número de puerto del servidor de correo. port_number es de tipo int y no tiene ningún valor predeterminado.

  • [ @username = ] 'username'
    Nuevo nombre de usuario que se utilizará para iniciar sesión en el servidor de correo electrónico. User name es de tipo sysname y no tiene ningún valor predeterminado.

  • [ @password = ] 'password'
    Es la nueva contraseña que se debe utilizar para iniciar sesión en el servidor de correo. password es de tipo sysname y no tiene ningún valor predeterminado.

  • [ @use_default_credentials = ] use_default_credentials
    Especifica si se debe enviar el correo al servidor SMTP con las credenciales del servicio SQL Server Database Engine (Motor de base de datos de SQL Server). use_default_credentials es de tipo bit y no tiene valor predeterminado. Si el valor de este parámetro es 1, el Correo electrónico de base de datos usa las credenciales de Motor de base de datos. Si el valor de este parámetro es 0, el Correo electrónico de base de datos utiliza @username y @password para la autenticación en el servidor SMTP. Si @username y @password son NULL, el Correo electrónico de base de datos utiliza la autenticación anónima. Consulte con el administrador de SMTP antes de especificar este parámetro.

  • [ @enable_ssl = ] enable_ssl
    Especifica si el Correo electrónico de base de datos cifra la comunicación mediante Capa de sockets seguros (SSL) . Utilice esta opción si se requiere SSL en el servidor SMTP. enable_ssl es de tipo bit y no tiene valor predeterminado.

Valores de código de retorno

0 (correcto) o 1 (error)

Comentarios

Si se especifican el nombre y el Id. de cuenta, el procedimiento almacenado cambia el nombre de la cuenta además de actualizar su información. Cambiar el nombre de la cuenta puede ser útil para corregir errores en el nombre.

El procedimiento almacenado sysmail_update_account_sp se encuentra en la base de datos msdb y pertenece al esquema dbo. El procedimiento se debe ejecutar con un nombre de tres partes si la base de datos actual no es msdb.

Permisos

Requiere la pertenencia al rol fijo de servidor sysadmin.

Ejemplos

A. Cambiar información de una cuenta

En el ejemplo siguiente se actualiza la cuenta AdventureWorks Administrator en la base de datos msdb. La información de la cuenta se establece con los valores proporcionados.

EXECUTE msdb.dbo.sysmail_update_account_sp
    ,@account_name = 'AdventureWorks2008R2 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. Cambiar el nombre y la información de una cuenta

En el ejemplo siguiente se cambia el nombre y se actualiza la información de la cuenta con el Id. de cuenta 125. El nuevo nombre de la cuenta es Backup Mail Server.

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;