sysmail_help_profile_sp (Transact-SQL)
适用于:SQL Server
列出有关一个或多个邮件配置文件的信息。
语法
sysmail_help_profile_sp [ [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' ]
[ ; ]
参数
[ @profile_id = ] profile_id
要返回其信息的配置文件 ID。 @profile_id为 int,默认值为 NULL
.
[ @profile_name = ] 'profile_name'
要返回其信息的配置文件名称。 @profile_name为 sysname,默认值为 NULL
.
返回代码值
0
(成功)或 1
(失败)。
结果集
返回包含以下列的结果集。
列名称 | 数据类型 | 说明 |
---|---|---|
profile_id |
int | 配置文件的配置文件 ID。 |
name |
sysname | 配置文件名。 |
description |
nvarchar(256) | 配置文件的说明。 |
注解
指定配置文件名称或配置文件 ID 时, sysmail_help_profile_sp
返回有关该配置文件的信息。 否则, sysmail_help_profile_sp
返回有关 SQL Server 实例中每个配置文件的信息。
存储过程 sysmail_help_profile_sp
位于 msdb
数据库中,由 dbo 架构拥有。 如果当前数据库不是 msdb
,则必须使用三部分名称执行该过程。
权限
此存储过程由 db_owner 角色拥有。 你可以为任何用户授予 EXECUTE
权限,但这些权限可能会在 SQL Server 升级期间被重写。
示例
A. 列出所有配置文件
以下示例显示如何列出实例中的所有配置文件。
EXEC msdb.dbo.sysmail_help_profile_sp;
下面是行长度经过调整的结果集示例:
profile_id name description
----------- ----------------------------- ------------------------------
56 AdventureWorks Administrator Administrative mail profile.
57 AdventureWorks Operator Operator mail profile.
B. 列出特定配置文件
以下示例显示如何列出配置文件 AdventureWorks Administrator
的信息。
EXEC msdb.dbo.sysmail_help_profile_sp
@profile_name = 'AdventureWorks Administrator' ;
下面是行长度经过调整的结果集示例:
profile_id name description
----------- ----------------------------- ------------------------------
56 AdventureWorks Administrator Administrative mail profile.