Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 3.89 KB

sysmail-configure-sp-transact-sql.md

File metadata and controls

102 lines (71 loc) · 3.89 KB
Raw
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sysmail_configure_sp (Transact-SQL)
Changes configuration settings for Database Mail.
markingmyname
maghan
randolphwest
05/30/2023
sql
system-objects
reference
sysmail_configure_sp_TSQL
sysmail_configure_sp
sysmail_configure_sp
TSQL

sysmail_configure_sp (Transact-SQL)

[!INCLUDE SQL Server]

Changes configuration settings for Database Mail. The configuration settings specified with sysmail_configure_sp apply to the entire [!INCLUDE ssNoVersion] instance.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

sysmail_configure_sp [ [ @parameter_name = ] 'parameter_name' ]
    [ , [ @parameter_value = ] 'parameter_value' ]
    [ , [ @description = ] 'description' ]
[ ; ]

Arguments

[ @parameter_name = ] 'parameter_name'

The name of the parameter to change.

[ @parameter_value = ] 'parameter_value'

The new value of the parameter.

[ @description = ] 'description'

A description of the parameter.

Return code values

0 (success) or 1 (failure).

Result set

None.

Remarks

Database Mail uses the following parameters:

Parameter name Description Default value
AccountRetryAttempts The number of times that the external mail process attempts to send the e-mail message using each account in the specified profile. 1
AccountRetryDelay The amount of time, in seconds, for the external mail process to wait between attempts to send a message. 5000
DatabaseMailExeMinimumLifeTime The minimum amount of time, in seconds, that the external mail process remains active. When Database Mail is sending many messages, increase this value to keep Database Mail active and avoid the overhead of frequent starts and stops. 600
DefaultAttachmentEncoding The default encoding for e-mail attachments. MIME
MaxFileSize The maximum size of an attachment, in bytes. 1000000
ProhibitedExtensions A comma-separated list of extensions that can't be sent as an attachment to an e-mail message. exe,dll,vbs,js
LoggingLevel Specify which messages are recorded in the Database Mail log. One of the following numeric values:

1 - This is normal mode. Logs only errors.

2 - This is extended mode. Logs errors, warnings, and informational messages.

3 - This is verbose mode. Logs errors, warnings, informational messages, success messages, and additional internal messages. Use this mode for troubleshooting.		 2

The stored procedure sysmail_configure_sp is in the msdb database and is owned by the dbo schema. The procedure must be executed with a three-part name if the current database isn't msdb.

Permissions

[!INCLUDE msdb-execute-permissions]

Examples

A. Set Database Mail to retry each account 10 times

The following example shows setting Database Mail to retry each account 10 times before considering the account to be unreachable.

EXEC msdb.dbo.sysmail_configure_sp
    'AccountRetryAttempts', '10';

B. Set the maximum attachment size to 2 megabytes

The following example shows setting the maximum attachment size to 2 megabytes.

EXEC msdb.dbo.sysmail_configure_sp
    'MaxFileSize', '2097152';

Related content