sysmail_add_profile_sp (Transact-SQL)

项目
06/18/2013

创建新的数据库邮件配置文件。

语法

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

参数

[ @profile_name = ] 'profile_name'
新配置文件的名称。 profile_name 的数据类型为 sysname，无默认值。
[ @description = ] 'description'
新配置文件的说明（可选）。 description 的数据类型为 nvarchar(256)，无默认值。
[ @profile_id = ] new_profile_idOUTPUT
返回新配置文件的 ID。 new_profile_id 的数据类型为 int，默认值为 NULL。

返回代码值

0（成功）或 1（失败）

注释

数据库邮件配置文件可以保存任意数目的数据库邮件帐户。数据库邮件存储过程可以通过配置文件名称或此过程生成的配置文件 ID 来引用配置文件。有关向配置文件添加帐户的详细信息，请参阅 sysmail_add_profileaccount_sp (Transact-SQL)。

可以使用存储过程 sysmail_update_profile_sp 更改配置文件的名称和说明，但配置文件 ID 在配置文件的生存期间保持不变。

配置文件名称对于 Microsoft SQL Server 数据库引擎必须是唯一的，否则存储过程将返回一个错误。

存储过程 sysmail_add_profile_sp 在 msdb 数据库中，归 dbo 架构所有。如果当前数据库不是 msdb，则该过程必须使用由三部分组成的名称执行。

权限

默认情况下，sysadmin 固定服务器角色的成员具有执行此过程的权限。

示例

A. 创建一个新配置文件

以下示例将创建一个名为 AdventureWorks Administrator 的新数据库邮件配置文件。

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

B. 创建一个新配置文件，并将配置文件 ID 保存在一个变量中

以下示例将创建一个名为 AdventureWorks Administrator 的新数据库邮件配置文件。该示例将配置文件 ID 号存储在变量 @profileId 中，并返回一个包含新配置文件的配置文件 ID 号的结果集。

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 ;