sysmail_delete_profile_sp (Transact-SQL)
更新 : 2006 年 12 月 12 日
データベース メールによって使用されるメール プロファイルを削除します。
構文
sysmail_delete_profile_sp { [ @profile_id = ] profile_id | [
@profile_name = ] 'profile_name' }
[, [ @force_delete = ] force_delete ]
引数
- [ @profile_id= ] profile_id
削除するプロファイルのプロファイル ID を指定します。profile_id のデータ型は int で、既定値は NULL です。profile_id または profile_name のいずれかを指定する必要があります。
- [ @profile_name= ] 'profile_name'
削除するプロファイルの名前を指定します。profile_name のデータ型は sysname で、既定値は NULL です。profile_id または profile_name のいずれかを指定する必要があります。
[ @force_delete= ] force_delete
force_delete のデータ型は bit です。既定値は 1 です。force_delete が 1 の場合、状態が unsent または retrying の電子メール メッセージはすべて failed に更新されます。force_delete が 0 で、状態が unsent または retrying の電子メール メッセージがある場合、エラーが発生します。関連するメッセージがない場合は、プロファイルが削除されます。
結果セット
なし
解説
プロファイルを削除しても、そのプロファイルで使用されているアカウントは削除されません。
このストアド プロシージャでは、プロファイルにアクセスできるかどうかに関係なく、プロファイルを削除できます。ユーザーの既定のプライベート プロファイルや、msdb データベースの既定のパブリック プロファイルを削除する場合は慎重に行ってください。既定のプロファイルがない場合、sp_send_dbmail には引数としてプロファイルの名前が必要になります。したがって、既定のプロファイルを削除すると、sp_send_dbmail への呼び出しが失敗する場合があります。詳細については、「sp_send_dbmail (Transact-SQL)」を参照してください。
ストアド プロシージャ sysmail_delete_profile_sp は msdb データベースにあり、dbo スキーマが所有しています。現在のデータベースが msdb でない場合、このプロシージャを実行するときには名前に 3 つの要素を指定する必要があります。
権限
このプロシージャの実行権限は、既定では sysadmin 固定サーバー ロールのメンバに与えられています。
戻り値
0 (成功) または 1 (失敗)
例
次の例では、AdventureWorks Administrator
というプロファイルを削除します。このプロファイルに関連する未送信のメッセージがある場合、エラーが発生し、プロファイルは削除されません。
EXECUTE msdb.dbo.sysmail_delete_profile_sp
@profile_name = N'AdventureWorks Administrator'
,@force_delete = 0;
参照
関連項目
データベース メールと SQL Mail のストアド プロシージャ (Transact-SQL)
その他の技術情報
データベース メール
データベース メール プロファイル
[構成タスクの選択] (データベース メール)
ヘルプおよび情報
変更履歴
リリース | 履歴 |
---|---|
2006 年 12 月 12 日 |
|