sysmail_add_profile_sp (Transact-SQL)

  • [アーティクル]

新しいデータベース メール プロファイルを作成します。

トピック リンク アイコン Transact-SQL 構文表記規則

構文

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
    新しいプロファイルの ID を返します。 new_profile_id のデータ型は int で、既定値は NULL です。

リターン コード値

0 (成功) または 1 (失敗)

説明

データベース メール プロファイルにはデータベース メール アカウントをいくつでも保持できます。 データベース メールのストアド プロシージャでは、このプロシージャで生成されたプロファイル名またはプロファイル ID によって、プロファイルを参照できます。 プロファイルへのアカウント追加に関する詳細については、「sysmail_add_profileaccount_sp (Transact-SQL)」を参照してください。

プロファイルの名前と説明はストアド プロシージャ sysmail_update_profile_sp で変更できますが、プロファイル ID はそのプロファイルが存在する限り変わりません。

プロファイル名は Microsoft SQL Server データベース エンジンで一意になっている必要があります。一意でない場合、このストアド プロシージャではエラーが返されます。

ストアド プロシージャ sysmail_add_profile_sp は msdb データベースにあり、dbo スキーマが所有しています。 現在のデータベースが msdb でない場合、このプロシージャを実行するときには名前に 3 つの要素を指定する必要があります。

権限

このプロシージャの実行権限は、既定では sysadmin 固定サーバー ロールのメンバーに与えられています。

使用例

A. 新しいプロファイルを作成する

次の例では、AdventureWorks Administrator という新しいデータベース メール プロファイルを作成します。

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

B. 新しいプロファイルを作成し、プロファイル ID を変数に格納する

次の例では、AdventureWorks Administrator という新しいデータベース メール プロファイルを作成します。 この例では、プロファイル ID 番号を変数 @profileId に格納し、新しいプロファイルのプロファイル ID 番号を含む結果セットを返します。

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 ;

関連項目

参照

データベース メール ストアド プロシージャ (Transact-SQL)

概念

データベース メール

データベース メール アカウントの作成

データベース メール構成オブジェクト