通过

  • 项目

sysmail_help_profile_sp (Transact-SQL)

列出有关一个或多个邮件配置文件的信息。

主题链接图标Transact-SQL 语法约定

语法

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，则该过程必须使用由三部分组成的名称执行。

权限

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

示例

A. 列出所有配置文件

以下示例显示如何列出实例中的所有配置文件。

EXECUTE 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 的信息。

EXECUTE msdb.dbo.sysmail_help_profile_sp
    @profile_name = 'AdventureWorks Administrator' ;

下面是行长度经过调整的结果集示例：

profile_id  name                          description
----------- ----------------------------- ------------------------------
56          AdventureWorks Administrator  Administrative mail profile.