sysmail_help_configure_sp (Transact-SQL)

Displays configuration settings for Database Mail.

Transact-SQL Syntax Conventions

Syntax

sysmail_help_configure_sp  [ [ @parameter_name = ] 'parameter_name' ]

Arguments

• [@parameter_name = ] 'parameter_name'
  The name of the configuration setting to retrieve. When specified, the value of the configuration setting is returned in the @parameter_value OUTPUT parameter. When no @parameter_name is specified, this stored procedure returns a result set containing all of the Database Mail configuration settings in the instance.

Return Code Values

0 (success) or 1 (failure)

Result Sets

When no @parameter_name is specified, returns a result set with the following columns.

Remarks

The stored procedure sysmail_help_configure_sp lists the current Database Mail configuration settings for the instance.

When a @parameter_name is specified, but no output parameter is provided for @parameter_value, this stored procedure produces no output.

The stored procedure sysmail_help_configure_sp is in the msdb database and is owned by the dbo schema. The procedure must be invoked with a three-part name if the current database is not msdb.

Permissions

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

Examples

The following example shows listing the Database Mail configuration settings for the SQL Server instance.

EXECUTE msdb.dbo.sysmail_help_configure_sp ;

Here is a sample result set, edited for line length:

paramname                       paramvalue      description
------------------------------- --------------- -----------------------------------------------------------------------------
AccountRetryAttempts            1               Number of retry attempts for a mail server
AccountRetryDelay               5000            Delay between each retry attempt to mail server
DatabaseMailExeMinimumLifeTime  600             Minimum process lifetime in seconds
DefaultAttachmentEncoding       MIME            Default attachment encoding
LoggingLevel                    2               Database Mail logging level: normal - 1, extended - 2 (default), verbose - 3
MaxFileSize                     1000000         Default maximum file size
ProhibitedExtensions            exe,dll,vbs,js  Extensions not allowed in outgoing mails

See Also

Reference

Database Mail Stored Procedures (Transact-SQL)

Concepts

Database Mail