| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sysmail_stop_sp (Transact-SQL) |
Stops Database Mail by stopping the Service Broker objects that the external program uses. |
MashaMSFT |
mathoma |
randolphwest |
08/21/2024 |
sql |
system-objects |
reference |
|
|
|
[!INCLUDE SQL Server]
Stops Database Mail by stopping the [!INCLUDE ssSB] objects that the external program uses.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sysmail_stop_sp
[ ; ]
None.
0 (success) or 1 (failure).
This stored procedure is in the msdb database.
sysmail_stop_sp stops the Database Mail queue that holds outgoing message requests and turns off [!INCLUDE ssSB] activation for the external program.
When the queues are stopped, the Database Mail external program doesn't process messages. This stored procedure allows you to stop Database Mail for troubleshooting or maintenance purposes.
To start Database Mail, use sysmail_start_sp. sp_send_dbmail still accepts mail when the [!INCLUDE ssSB] objects are stopped.
Note
sysmail_stop_sp only stops the queues for Database Mail. This stored procedure doesn't deactivate [!INCLUDE ssSB] message delivery in the database. This stored procedure doesn't disable the Database Mail extended stored procedures to reduce the surface area. To disable the extended stored procedures, see the Database Mail XPs (server configuration option) of the sp_configure system stored procedure.
[!INCLUDE msdb-execute-permissions]
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