sysmail_add_account_sp (Transact-SQL)sysmail_add_account_sp (Transact-SQL)

S’APPLIQUE À : ouiSQL Server ouiAzure SQL Database (Managed Instance uniquement) nonAzure SQL Data Warehouse nonParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database (Managed Instance only) noAzure SQL Data Warehouse noParallel Data Warehouse

Crée un nouveau compte de messagerie de base de données contenant des informations sur un compte SMTP.Creates a new Database Mail account holding information about an SMTP account.

Icône de lien de rubrique conventions de la syntaxe Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SyntaxeSyntax

  
sysmail_add_account_sp  [ @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 ]  
    [ , [ @account_id = ] account_id OUTPUT ]  

ArgumentsArguments

[ @account_name = ] 'account_name' nom du compte à ajouter.[ @account_name = ] 'account_name' The name of the account to add. nom_de_compte est de type sysname, sans valeur par défaut.account_name is sysname, with no default.

[ @email_address = ] 'email_address' adresse de messagerie à partir de laquelle envoyer le message.[ @email_address = ] 'email_address' The e-mail address to send the message from. Cette adresse doit être une adresse de messagerie Internet.This address must be an internet e-mail address. email_address est de type nvarchar (128) , sans valeur par défaut.email_address is nvarchar(128), with no default. Par exemple, un compte pour l’agent SQL ServerSQL Server peut envoyer un message électronique à partir de l’adresse SQLAgent@Adventure-Works.com.For example, an account for SQL ServerSQL Server Agent may send e-mail from the address SqlAgent@Adventure-Works.com.

[ @display_name = ] 'display_name' nom complet à utiliser pour les messages électroniques à partir de ce compte.[ @display_name = ] 'display_name' The display name to use on e-mail messages from this account. display_name est de type nvarchar (128) , avec NULL comme valeur par défaut.display_name is nvarchar(128), with a default of NULL. Par exemple, un compte pour l’agent SQL ServerSQL Server peut afficher le nom SQL Server Agent courrier électronique automatisé sur les messages électroniques.For example, an account for SQL ServerSQL Server Agent may display the name SQL Server Agent Automated Mailer on e-mail messages.

[ @replyto_address = ] 'replyto_address' adresse à laquelle les réponses aux messages de ce compte sont envoyées.[ @replyto_address = ] 'replyto_address' The address that responses to messages from this account are sent to. replyto_address est de type nvarchar (128) , avec NULL comme valeur par défaut.replyto_address is nvarchar(128), with a default of NULL. Par exemple, les réponses à un compte pour l’agent SQL ServerSQL Server peuvent être envoyées à l’administrateur de la base de données, danw@Adventure-Works.com.For example, replies to an account for SQL ServerSQL Server Agent may go to the database administrator, danw@Adventure-Works.com.

[ @description = ] 'description' est une description du compte.[ @description = ] 'description' Is a description for the account. Description est de type nvarchar (256) , avec NULL comme valeur par défaut.description is nvarchar(256), with a default of NULL.

[ @mailserver_name = ] 'server_name' le nom ou l’adresse IP du serveur de messagerie SMTP à utiliser pour ce compte.[ @mailserver_name = ] 'server_name' The name or IP address of the SMTP mail server to use for this account. L’ordinateur qui exécute SQL ServerSQL Server doit être en mesure de résoudre le SERVER_NAME en adresse IP.The computer that runs SQL ServerSQL Server must be able to resolve the server_name to an IP address. SERVER_NAME est de type sysnameet n’a pas de valeur par défaut.server_name is sysname, with no default.

[ @mailserver_type = ] 'server_type' type de serveur de messagerie.[ @mailserver_type = ] 'server_type' The type of e-mail server. server_type est de type sysname, avec 'SMTP' comme valeur par défaut.server_type is sysname, with a default of 'SMTP'..

[ @port = ] port_number le numéro de port du serveur de messagerie.[ @port = ] port_number The port number for the e-mail server. numéro_port est de type int, avec 25 comme valeur par défaut.port_number is int, with a default of 25.

[ @username = ] 'username' nom d’utilisateur à utiliser pour se connecter au serveur de messagerie.[ @username = ] 'username' The user name to use to log on to the e-mail server. username est de type nvarchar (128) , avec NULL comme valeur par défaut.username is nvarchar(128), with a default of NULL. Lorsque ce paramètre possède la valeur NULL, la messagerie de base de données n'utilise pas d'authentification pour ce compte.When this parameter is NULL, Database Mail does not use authentication for this account. Si le serveur de messagerie ne nécessite pas d'authentification, utilisez NULL comme nom d'utilisateur.If the mail server does not require authentication, use NULL for the username.

[ @password = ] 'password' mot de passe à utiliser pour se connecter au serveur de messagerie.[ @password = ] 'password' The password to use to log on to the e-mail server. Password est de type nvarchar (128) , avec NULL comme valeur par défaut.password is nvarchar(128), with a default of NULL. Il est inutile de fournir un mot de passe, sauf si un nom d'utilisateur est spécifié.There is no need to provide a password unless a username is specified.

[ @use_default_credentials = ] use_default_credentials indique si le courrier électronique doit être envoyé au serveur SMTP à l’aide des informations d’identification de la Moteur de base de données SQL ServerSQL Server Database Engine.[ @use_default_credentials = ] use_default_credentials Specifies whether to send the mail to the SMTP server using the credentials of the Moteur de base de données SQL ServerSQL Server Database Engine. use_default_credentials est de valeur de bit, avec 0 comme valeur par défaut.use_default_credentials is bit, with a default of 0. Lorsque la valeur de ce paramètre est définie sur 1, la messagerie de base de données utilise les informations d'identification du moteur de base de données Moteur de base de donnéesDatabase Engine.When this parameter is 1, Database Mail uses the credentials of the Moteur de base de donnéesDatabase Engine. Lorsque ce paramètre a la valeur 0, Database Mail envoie les paramètres @username et @password s’ils sont présents, sinon envoie le courrier sans les paramètres @Username et @password .When this parameter is 0, Database Mail sends the @username and @password parameters if present, otherwise sends mail without @username and @password parameters.

[ @enable_ssl = ] enable_ssl spécifie si Database Mail chiffre les communications à l’aide de protocole SSL.[ @enable_ssl = ] enable_ssl Specifies whether Database Mail encrypts communication using Secure Sockets Layer. Enable_ssl est de valeur de bit, avec 0 comme valeur par défaut.Enable_ssl is bit, with a default of 0.

[ @account_id = ] account_id OUTPUT retourne l’ID de compte pour le nouveau compte.[ @account_id = ] account_id OUTPUT Returns the account id for the new account. account_id est de type int, avec NULL comme valeur par défaut.account_id is int, with a default of NULL.

Valeurs des codes de retourReturn Code Values

0 (succès) ou 1 (échec)0 (success) or 1 (failure)

NotesRemarks

Database Mail fournit des paramètres distincts pour @email_address, @display_nameet @replyto_address.Database Mail provides separate parameters for @email_address, @display_name, and @replyto_address. Le paramètre @email_address est l’adresse à partir de laquelle le message est envoyé.The @email_address parameter is the address from which the message is sent. Le paramètre @display_name est le nom affiché dans le champ de : du message électronique.The @display_name parameter is the name shown in the From: field of the e-mail message. Le paramètre @replyto_address est l’adresse à laquelle les réponses au message électronique sont envoyées.The @replyto_address parameter is the address where replies to the e-mail message will be sent. Par exemple, un compte utilisé pour l'Agent SQL ServerSQL Server peut envoyer des messages électroniques à partir d'une adresse de messagerie utilisée uniquement pour l'Agent SQL ServerSQL Server.For example, an account used for SQL ServerSQL Server Agent may send e-mail messages from an e-mail address that is only used for SQL ServerSQL Server Agent. Les messages provenant de cette adresse doivent afficher un nom convivial, afin que les destinataires puissent aisément déterminer que le message a été envoyé par l'Agent SQL ServerSQL Server.Messages from that address should display a friendly name, so recipients can easily determine that SQL ServerSQL Server Agent sent the message. Si un destinataire répond au message, la réponse doit arriver à l'administrateur de bases de données et non à l'adresse utilisée par l'Agent SQL ServerSQL Server.If a recipient replies to the message, the reply should go to the database administrator rather than the address used by SQL ServerSQL Server Agent. Pour ce scénario, le compte utilise **SqlAgent@Adventure-Works.com** comme adresse de messagerie.For this scenario, the account uses **SqlAgent@Adventure-Works.com** as the e-mail address. Le nom d’affichage est défini sur SQL Server Agent Mailer automatisé.The display name is set to SQL Server Agent Automated Mailer. Le compte utilise **danw@Adventure-Works.com** comme adresse de réponse, donc les réponses aux messages envoyés à partir de ce compte sont envoyées à l’administrateur de base de données plutôt qu’à l’adresse de messagerie de l’agent SQL ServerSQL Server.The account uses **danw@Adventure-Works.com** as the reply to address, so replies to messages sent from this account go to the database administrator rather than the e-mail address for SQL ServerSQL Server Agent. En fournissant des paramètres indépendants pour ces trois paramètres, la messagerie de base de données vous permet de configurer des messages afin qu'ils répondent à vos besoins.By providing independent settings for these three parameters, Database Mail allows you to configure messages to suit your needs.

Le paramètre @mailserver_type prend en charge la valeur « SMTP » .The @mailserver_type parameter supports the value 'SMTP'.

Lorsque la valeur de @use_default_credentials est 1, le courrier est envoyé au serveur SMTP à l’aide des informations d’identification du Moteur de base de données SQL ServerSQL Server Database Engine.When @use_default_credentials is 1 mail is sent to the SMTP server using the credentials of the Moteur de base de données SQL ServerSQL Server Database Engine. Lorsque @use_default_credentials est égal à 0 et qu’un @username et @password sont spécifiés pour un compte, le compte utilise l’authentification SMTP.When @use_default_credentials is 0 and a @username and @password are specified for an account, the account uses SMTP authentication. Les @username et @password sont les informations d’identification utilisées par le compte pour le serveur SMTP, et non les informations d’identification pour SQL ServerSQL Server ou le réseau sur lequel se trouve l’ordinateur.The @username and @password are the credentials the account uses for the SMTP server, not credentials for SQL ServerSQL Server or the network that the computer is on.

La procédure stockée sysmail_add_account_sp se trouve dans la base de données msdb et appartient au schéma dbo .The stored procedure sysmail_add_account_sp is in the msdb database and is owned by the dbo schema. La procédure doit être exécutée avec un nom en trois parties si la base de données actuelle n’est pas msdb.The procedure must be executed with a three-part name if the current database is not msdb.

PermissionsPermissions

Les autorisations d’exécution pour cette procédure sont octroyées par défaut aux membres du rôle serveur fixe sysadmin .Execute permissions for this procedure default to members of the sysadmin fixed server role.

ExemplesExamples

L'exemple suivant crée un compte nommé AdventureWorks Administrator.The following example creates an account named AdventureWorks Administrator. Ce compte utilise l'adresse de messagerie électronique dba@Adventure-Works.com en envoie du courrier électronique au serveur de messagerie SMTP smtp.Adventure-Works.com.The account uses the e-mail address dba@Adventure-Works.com and sends mail to the SMTP mail server smtp.Adventure-Works.com. Les messages électroniques envoyés à partir de ce compte affichent AdventureWorks Automated Mailer sur la ligne de : du message.E-mail messages sent from this account show AdventureWorks Automated Mailer on the From: line of the message. Les réponses aux messages sont envoyés vers danw@Adventure-Works.com.Replies to the messages are directed to danw@Adventure-Works.com.

EXECUTE msdb.dbo.sysmail_add_account_sp  
    @account_name = 'AdventureWorks Administrator',  
    @description = 'Mail account for administrative e-mail.',  
    @email_address = 'dba@Adventure-Works.com',  
    @display_name = 'AdventureWorks Automated Mailer',  
    @mailserver_name = 'smtp.Adventure-Works.com' ;  

Voir aussiSee Also

Messagerie de base de données Database Mail
Créer un compte Database Mail Create a Database Mail Account
Procédures (stockées Database mail Transact-SQL)Database Mail Stored Procedures (Transact-SQL)