sysmail_stop_sp (Transact-SQL)

Stops Database Mail by stopping the Service Broker objects that the external program uses.

Transact-SQL Syntax Conventions

Syntax

sysmail_stop_sp

Arguments

None

Return Code Values

0 (success) or 1 (failure)

Remarks

This stored procedure is in the msdb database.

This stored procedure stops the Database Mail queue that holds outgoing message requests and turns off Service Broker activation for the external program.

When the queues are stopped, the Database Mail external program does not process messages. This stored procedure allows you to stop Database Mail for troubleshooting or maintenance purposes.

To start Database Mail, use sysmail_start_sp. Notice that sp_send_dbmail still accepts mail when the Service Broker objects are stopped.

Note

This stored procedure only stops the queues for Database Mail. This stored procedure does not deactivate Service Broker message delivery in the database. This stored procedure does not disable the Database Mail extended stored procedures to reduce the surface area. To disable the extended stored procedures, see the Database Mail XPs option of the sp_configure system stored procedure.

Permissions

Execute permissions for this procedure default to members of the sysadmin fixed server role.

Examples

The following example shows stopping Database Mail in the msdb database. The example assumes that Database Mail has been enabled.

USE msdb ;
GO

EXECUTE dbo.sysmail_stop_sp ;
GO

See Also

Reference

sysmail_start_sp (Transact-SQL)

Database Mail Stored Procedures (Transact-SQL)

Concepts

Database Mail