sysmail_add_profile_sp (Transact-SQL)

發行項
06/18/2013

建立新的 Database Mail 設定檔。

語法

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

引數

[ @profile_name = ] 'profile_name'
新設定檔的名稱。 profile_name 是 sysname，沒有預設值。
[ @description = ] 'description'
新設定檔的選擇性描述。 description 是 nvarchar(256)，沒有預設值。
[ @profile_id = ] new_profile_idOUTPUT
傳回新設定檔的識別碼。 new_profile_id 是 int，預設值是 NULL。

傳回碼值

0 (成功) 或 1 (失敗)

備註

Database Mail 設定檔會保存任意數目的 Database Mail 帳戶。 Database Mail 預存程序可以利用這個程序所產生的設定檔名稱或設定檔識別碼來參考設定檔。如需有關將帳戶加入設定檔的詳細資訊，請參閱＜sysmail_add_profileaccount_sp (Transact-SQL)＞。

您可以利用 sysmail_update_profile_sp 預存程序來變更設定檔名稱和描述，設定檔識別碼在設定檔的有效期內則會維持不變。

Microsoft SQL Server Database Engine 的設定檔名稱必須是唯一的，否則，預存程序會傳回一則錯誤。

預存程序 sysmail_add_profile_sp 在 msdb 資料庫中，擁有者是 dbo 結構描述。如果目前的資料庫不是 msdb，就必須利用三部分名稱來執行這個程序。

權限

這個程序的執行權限預設會授與系統管理員 (sysadmin) 固定伺服器角色的成員。

範例

A. 建立新的設定檔

下列範例會建立名稱為 AdventureWorks Administrator 的新 Database Mail 設定檔。

EXECUTE msdb.dbo.sysmail_add_profile_sp
       @profile_name = 'AdventureWorks Administrator',
       @description = 'Profile used for administrative mail.' ;

B. 建立新的設定檔，將設定檔識別碼儲存在變數中

下列範例會建立名稱為 AdventureWorks Administrator 的新 Database Mail 設定檔。這個範例會將設定檔識別碼儲存在 @profileId 變數中，且會傳回包含新設定檔之設定檔識別碼的結果集。

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 ;