xp_startmail (Transact-SQL)

Запускает сеанс клиента службы SQL Mail. При запуске почтового сеанса открываются клиентские компоненты MAPI и выполняется регистрация на сервере электронной почты.

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

В будущей версии Microsoft SQL Server эта возможность будет удалена. Избегайте использования этой возможности в новых разработках и запланируйте изменение существующих приложений, в которых она применяется.

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

Синтаксис

xp_startmail [ [ @user= ] 'mapi_profile_name' ]
     [ , [ @password= ] 'mapi_profile_password' ] 

Аргументы

  • [ @user=] 'mapi_profile_name'
    Необязательный аргумент, указывающий имя почтового профиля. Аргумент mapi_profile_name имеет тип sysname и не имеет значения по умолчанию. Если этот аргумент не указан, то используется значение по умолчанию, указанное в приложении Microsoft Outlook.

  • [ @password=] 'mapi_profile_password'
    Это почтовый пароль для указанного аргумента mapi_profile_name. Аргумент mapi_profile_password имеет тип sysname и не имеет значения по умолчанию. Значение NULL разрешено, если почтовый клиент запускается (на том же компьютере) перед выполнением процедуры xp_startmail.

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

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

Результирующие наборы

Процедура xp_startmail возвращает сообщение

SQL mail session started.

Замечания

Если предоставляются аргументы mapi_profile_name и mapi_profile_password, то SQL Server пытается зарегистрироваться в поставщике MAPI с использованием этого имени профиля и пароля. Если аргументы mapi_profile_name и mapi_profile_password предоставляются, но являются неправильными, то возвращается сообщение об ошибке. Если аргументы mapi_profile_name и mapi_profile_password не предоставляются, то SQL Server использует имя профиля и пароль, указанные в диалоговом окне SQL Mail Configuration. Если имя профиля и пароль не указываются явно, то SQL Server пытается зарегистрироваться в поставщике MAPI с использованием профиля MAPI по умолчанию. Некоторые поставщики MAPI могут быть настроены на использование проверки подлинности Windows. В этом случае пароль MAPI не учитывается.

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

Если процедура xp_startmail используется для запуска почтового сеанса, то можно по выбору предоставить имя входа и пароль, чтобы не вводить его из командной строки. Однако служба SQL Mail не будет выполняться совместно с активным сеансом MAPI. В этом состоит отличие от характера действий SQL Server версии 7.0 или более ранних.

Если имеется существующий почтовый сеанс, то процедура xp_startmail не запускает новый сеанс. Если почта и SQL Server функционируют на одном компьютере, то почтовый клиент должен быть запущен до запуска процедуры xp_startmail или перед запуском SQL Server, если служба SQL Mail настроена на автоматический запуск при запуске SQL Server.

Разрешения

Требует членства в предопределенной роли сервера sysadmin, но разрешения EXECUTE могут предоставляться другим пользователям. Однако в целях безопасности разрешения для этой хранимой процедуры рекомендуется ограничить членами предопределенной роли сервера sysadmin.

Примеры

В следующем примере запускается почтовая программа с использованием имени пользователя и пароля, указанных в приложении Microsoft Outlook, в качестве профиля по умолчанию для учетной записи Microsoft Windows, с которой работает SQL Server.

USE master;
GO
EXEC xp_startmail;
GO