sysmail_delete_profile_sp (Transact-SQL)

更新日期: 2006 年 12 月 12 日

删除数据库邮件使用的邮件配置文件。

主题链接图标Transact-SQL 语法约定

语法

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_idprofile_name
  • [ @profile_name= ] 'profile_name'
    要删除的配置文件的名称。profile_name 的数据类型为 sysname,默认值为 NULL。必须指定 profile_idprofile_name
  • [ @force_delete= ] force_delete
    force_delete 的数据类型为 bit。默认值 = 1。如果 force_delete 等于 1,则具有未发送或重试状态的所有电子邮件的状态都将更新为 failed

    如果 force_delete 等于 0 并且如有任何电子邮件的状态为 unsentretrying 时,则将引发一个错误,或者如果没有关联邮件,将删除此配置文件。

返回代码值

0(成功)或 1(失败)

结果集

备注

删除配置文件不会删除配置文件使用的帐户。

此存储过程删除配置文件时,不考虑用户是否有权访问该配置文件。删除用户的默认专用配置文件或 msdb 数据库的默认公共配置文件时,请保持谨慎。如果没有可用的默认配置文件,则 sp_send_dbmail 需要使用配置文件的名称作为参数。因此,删除默认配置文件可能会导致调用 sp_send_dbmail 失败。有关详细信息,请参阅 sp_send_dbmail (Transact-SQL)

存储过程 sysmail_delete_profile_spmsdb 数据库中,归属于 dbo 架构。如果当前数据库不是 msdb,则该过程必须使用由三部分组成的名称执行。

权限

默认情况下,sysadmin 固定服务器角色的成员有执行此过程的权限。

示例

以下示例将删除名为 AdventureWorks Administrator 的配置文件。如果存在与此配置文件关联的未发送邮件,则将引发一个错误并且不删除此配置文件。

EXECUTE msdb.dbo.sysmail_delete_profile_sp
    @profile_name = N'AdventureWorks Administrator' 
    ,@force_delete = 0;

请参阅

参考

数据库邮件和 SQL 邮件存储过程 (Transact-SQL)

其他资源

数据库邮件
数据库邮件配置文件
选择配置任务(数据库邮件)

帮助和信息

获取 SQL Server 2005 帮助

更改历史记录

发布日期 历史记录

2006 年 12 月 12 日

新增内容:
  • 在“语法”、“参数”和“示例”部分中添加了新参数 @force_delete