sysmail_help_profile_sp (Transact-SQL)

列出一或多個郵件設定檔的相關資訊。

主題連結圖示 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_spmsdb 資料庫中,擁有者是 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.  

請參閱

參考

Database Mail 預存程序 (Transact-SQL)

概念

Database Mail