sysmail_help_profile_sp (Transact-SQL)

適用於:SQL Server

列出一或多個郵件配置檔的相關信息。

Transact-SQL 語法慣例

語法

sysmail_help_profile_sp [ [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' ]
[ ; ]

引數

[ @profile_id = ] profile_id

要傳回資訊的配置檔識別碼。 @profile_id為 int,預設值為 NULL

[ @profile_name = ] 'profile_name'

要傳回資訊的配置檔名稱。 @profile_name為 sysname,預設值為 NULL

傳回碼值

0 (成功)或 1 (失敗)。

結果集

傳回具有下列數據行的結果集。

資料行名稱 資料類型 描述
profile_id int 配置檔的設定檔識別碼。
name sysname 配置檔的配置檔名稱。
description nvarchar(256) 配置檔的描述。

備註

指定設定檔名稱或設定檔識別碼時, 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.