sysmail_add_profile_sp (Transact-SQL)

Создает новый профиль компонента Database Mail.

ПримечаниеПримечание

Так как компонент Database Mail не использует интерфейс Messaging Application Programming Interface (MAPI), профили Database Mail не являются почтовыми профилями MAPI. Компонент Database Mail не использует профили службы SQL Mail.

Значок ссылки на разделСинтаксические обозначения в Transact-SQL

Синтаксис

sysmail_add_profile_sp [ @profile_name = ] 'profile_name'
    [ , [ @description = ] 'description' ]
    [ , [ @profile_id = ] new_profile_id OUTPUT ]

Аргументы

  • [ @profile_name = ] 'profile_name'
    Имя нового профиля. Аргумент profile_name имеет тип sysname и не имеет значения по умолчанию.

  • [ @description = ] 'description'
    Необязательное описание нового профиля. Аргумент description имеет тип nvarchar(256) и не имеет значения по умолчанию.

  • [ @profile_id = ] new_profile_idOUTPUT
    Возвращает идентификатор нового профиля. Аргумент new_profile_id имеет тип int и не имеет значения по умолчанию.

Значения кодов возврата

0 (успешное завершение) или 1 (неуспешное завершение)

Замечания

Профиль компонента Database Mail может хранить любое число учетных записей Database Mail. Хранимые процедуры компонента Database Mail могут ссылаться на профиль или по имени, или по идентификатору, создаваемому данной процедурой. Дополнительные сведения о добавлении учетных записей в профиль см. в разделе sysmail_add_profileaccount_sp (Transact-SQL).

Имя профиля и его описание могут быть изменены хранимой процедурой sysmail_update_profile_sp, но идентификатор профиля остается неизменным на протяжении всего срока использования профиля.

Имя профиля должно быть уникальным для компонента Microsoft SQL Server Database Engine, иначе хранимая процедура вернет ошибку.

Хранимая процедура sysmail_add_profile_sp принадлежит базе данных msdb и схеме dbo. Если текущей базой данных является не msdb, процедуру следует выполнять с трехкомпонентным именем.

Разрешения

Разрешения на выполнение этой процедуры по умолчанию есть у членов предопределенной роли сервера sysadmin.

Примеры

А. Создание профиля

В следующем примере показано создание профиля компонента Database Mail с именем AdventureWorks2008R2 Administrator.

EXECUTE msdb.dbo.sysmail_add_profile_sp
       @profile_name = 'AdventureWorks2008R2 Administrator',
       @description = 'Profile used for administrative mail.' ;

Б. Создание профиля, сохранение идентификатора профиля в переменной

В следующем примере показано создание профиля компонента Database Mail с именем AdventureWorks Administrator. В примере идентификатор нового профиля сохраняется в переменной @profileId и возвращается в результирующем наборе.

DECLARE @profileId INT ;

EXECUTE msdb.dbo.sysmail_add_profile_sp
       @profile_name = 'AdventureWorks2008R2 Administrator',
       @description = 'Profile used for administrative mail.',
       @profile_id = @profileId OUTPUT ;

SELECT @profileId ;