sysmail_add_profile_sp （Transact-SQL）

  • 發行項

適用於：SQL ServerAzure SQL 受控執行個體

建立新的 Database Mail 設定檔。

Transact-SQL 語法慣例

語法

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

引數

[ @profile_name = ] 'profile_name'

新配置檔的名稱。 @profile_name為 sysname，沒有預設值。

若要在 Azure SQL 受控執行個體 中使用 SQL Server Agent 作業傳送電子郵件，SQL Server Agent 只能使用 Database Mail 設定檔，而且必須呼叫 AzureManagedInstance_dbmail_profile。 如需詳細資訊和範例指令碼，請參閱 Azure SQL 受控執行個體 SQL Agent 作業通知。

[ @description = ] N'description'

新配置檔的選擇性描述。 @description為 nvarchar（256），沒有預設值。

[ @profile_id = ] new_profile_id OUTPUT

傳回新配置文件的識別碼。 @profile_id為 int，預設值為 NULL。

傳回碼值

0 （成功）或 1 （失敗）。

備註

Database Mail 配置檔會保存任意數目的 Database Mail 帳戶。 Database Mail 預存程式可以透過配置檔名稱或此程式所產生的配置檔識別碼來參考配置檔。 如需將帳戶新增至設定檔的詳細資訊，請參閱 sysmail_add_profileaccount_sp （Transact-SQL） 。

配置檔名稱和描述可以使用預存程式 sysmail_update_profile_sp來變更，而配置檔識別碼在配置檔存留期間會保持不變。

配置檔名稱在 SQL Server 資料庫引擎 實體中必須是唯一的，否則預存程式會傳回錯誤。

預存程式 sysmail_add_profile_sp 位於 msdb 資料庫中，而且是由 dbo 架構所擁有。 如果目前的資料庫不是 msdb，則必須使用三部分名稱執行程式。

權限

此預存程式是由 db_owner 角色所擁有。 您可以授與 EXECUTE 任何用戶的許可權，但這些許可權可能會在 SQL Server 升級期間覆寫。

範例

A. 建立新設定檔

下列範例會建立名為 AdventureWorks Administrator的新 Database Mail 配置檔。

EXEC 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;

相關內容