sysmail_add_profile_sp (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 托管实例

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

Transact-SQL 语法约定

语法

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

参数

[ @profile_name = ] 'profile_name'

新配置文件的名称。 @profile_name 为 sysname，无默认值。

若要在Azure SQL 托管实例中使用SQL Server 代理作业发送电子邮件，SQL Server 代理只能使用一个数据库邮件配置文件，必须调用AzureManagedInstance_dbmail_profile它。 有关详细信息和示例脚本，请参阅 Azure SQL 托管实例 SQL 代理作业通知。

[ @description = ] N'description'

新配置文件的说明（可选）。 @description为 nvarchar（256），没有默认值。

[ @profile_id = ] new_profile_id OUTPUT

返回新配置文件的 ID。 @profile_id为 int，默认值为 NULL.

返回代码值

0（成功）或 1（失败）。

注解

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

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

配置文件名称在 SQL Server 数据库引擎 实例中必须唯一，否则存储过程将返回错误。

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

权限

此存储过程由 db_owner 角色拥有。 你可以为任何用户授予 EXECUTE 权限，但这些权限可能会在 SQL Server 升级期间被重写。

示例

A. 创建新配置文件

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

EXEC 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;

相关内容