sysmail_add_profile_sp (Transact-SQL)

Article
03/07/2014

Crée un nouveau profil de messagerie de base de données.

S'applique à : SQL Server (SQL Server 2008 via la version actuelle).

Icône Lien de rubrique Conventions de la syntaxe Transact-SQL

Syntaxe

sysmail_add_profile_sp [ @profile_name = ] 'profile_name'
    [ , [ @description = ] 'description' ]
    [ , [ @profile_id = ] new_profile_id OUTPUT ]

Arguments

[ @profile_name = ] 'profile_name'
Nom du nouveau profil. profile_name est de type sysname et n'a pas de valeur par défaut.
[ @description = ] 'description'
Description facultative du nouveau profil. description est de type nvarchar(256) et n'a pas de valeur par défaut.
[ @profile_id = ] new_profile_idOUTPUT
Retourne l'ID du nouveau profil. new_profile_id est de type int, avec NULL comme valeur par défaut.

Valeurs des codes de retour

0 (succès) ou 1 (échec)

Notes

Un profil de messagerie de base de données contient un nombre quelconque de comptes de messagerie de base de données. Les procédures stockées de la messagerie de base de données peuvent faire référence à un profil par son nom ou par l'ID généré par cette procédure. Pour plus d'informations sur l'ajout d'un compte à un profil, consultez sysmail_add_profileaccount_sp (Transact-SQL).

Le nom et la description du profil peuvent être modifiés à l'aide de la procédure stockée sysmail_update_profile_sp, tandis que son ID reste constant pendant la durée de vie du profil.

Le nom du profil doit être unique pour le moteur de base de données Microsoft SQL Server, sans quoi la procédure stockée retourne une erreur.

La procédure stockée sysmail_add_profile_sp est dans la base de données msdb et est possédée par le schéma dbo. Cette procédure doit être exécutée avec un nom en trois parties si la base de données active n'est pas msdb.

Autorisations

Les autorisations d'exécution de cette procédure reviennent par défaut aux membres du rôle de serveur fixe sysadmin.

Exemples

A. Création d'un profil

L'exemple ci-dessous crée un profil de messagerie de base de données nommé AdventureWorks Administrator.

EXECUTE msdb.dbo.sysmail_add_profile_sp
       @profile_name = 'AdventureWorks Administrator',
       @description = 'Profile used for administrative mail.' ;

B. Création d'un profil et enregistrement de son ID dans une variable

L'exemple ci-dessous crée un profil de messagerie de base de données nommé AdventureWorks Administrator. L'exemple stocke l'ID du profil dans la variable @profileId et retourne un jeu de résultats contenant l'ID du nouveau profil.

DECLARE @profileId INT ;

EXECUTE msdb.dbo.sysmail_add_profile_sp
       @profile_name = 'AdventureWorks Administrator',
       @description = 'Profile used for administrative mail.',
       @profile_id = @profileId OUTPUT ;

SELECT @profileId ;