Хранимые процедуры служб Database Mail и SQL Mail (Transact-SQL)

Административные скрипты MS SQL > Хранимые процедуры служб Database Mail и SQL Mail (Transact-SQL)
11.04.2013 12:44:02



Статья:

sp_send_dbmail Отправляет сообщение электронной почты указанным получателям. Сообщение может включать результирующий набор запроса, файлы вложений или и то, и другое. Если почта успешно поставлена в очередь компонента Database Mail, процедура sp_send_dbmail возвращает идентификатор сообщенияmailitem_id. Эта хранимая процедура содержится в базе данных msdb.

sp_send_dbmail [ [ @profile_name = ] 'profile_name' ]
    [ , [ @recipients = ] 'recipients [ ; ...n ]' ]
    [ , [ @copy_recipients = ] 'copy_recipient [ ; ...n ]' ]
    [ , [ @blind_copy_recipients = ] 'blind_copy_recipient [ ; ...n ]' ]
    [ , [ @from_address = ] 'from_address' ]
    [ , [ @reply_to = ] 'reply_to' ] 
    [ , [ @subject = ] 'subject' ] 
    [ , [ @body = ] 'body' ] 
    [ , [ @body_format = ] 'body_format' ]
    [ , [ @importance = ] 'importance' ]
    [ , [ @sensitivity = ] 'sensitivity' ]
    [ , [ @file_attachments = ] 'attachment [ ; ...n ]' ]
    [ , [ @query = ] 'query' ]
    [ , [ @execute_query_database = ] 'execute_query_database' ]
    [ , [ @attach_query_result_as_file = ] attach_query_result_as_file ]
    [ , [ @query_attachment_filename = ] query_attachment_filename ]
    [ , [ @query_result_header = ] query_result_header ]
    [ , [ @query_result_width = ] query_result_width ]
    [ , [ @query_result_separator = ] 'query_result_separator' ]
    [ , [ @exclude_query_output = ] exclude_query_output ]
    [ , [ @append_query_error = ] append_query_error ]
    [ , [ @query_no_truncate = ] query_no_truncate ]
    [ , [ @query_result_no_padding = ] @query_result_no_padding ] 
    [ , [ @mailitem_id = ] mailitem_id ] [ OUTPUT ]

 

sysmail_add_account_sp Создает новую учетную запись компонента Database Mail, хранящую сведения об учетной записи SMTP.

sysmail_add_account_sp  [ @account_name = ] 'account_name',
    [ @email_address = ] 'email_address' ,
    [ [ @display_name = ] 'display_name' , ]
    [ [ @replyto_address = ] 'replyto_address' , ]
    [ [ @description = ] 'description' , ]
    [ @mailserver_name = ] 'server_name' 
    [ , [ @mailserver_type = ] 'server_type' ]
    [ , [ @port = ] port_number ]
    [ , [ @username = ] 'username' ]
    [ , [ @password = ] 'password' ]
    [ , [ @use_default_credentials = ] use_default_credentials ]
    [ , [ @enable_ssl = ] enable_ssl ]
    [ , [ @account_id = ] account_id OUTPUT ]

sysmail_add_principalprofile_sp Предоставляет пользователю или роли базы данных разрешение на использование профиля компонента Database Mail.

sysmail_add_principalprofile_sp  { [ @principal_id = ] principal_id | [ @principal_name = ] 'principal_name' } ,
    { [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' }
    [ , [ @is_default ] = 'is_default' ]
 
sysmail_add_profile_sp Создает новый профиль компонента Database Mail.
sysmail_add_profile_sp [ @profile_name = ] 'profile_name'
    [ , [ @description = ] 'description' ]
    [ , [ @profile_id = ] new_profile_id OUTPUT ]
 
sysmail_add_profileaccount_sp Добавляет учетную запись Database Mail к профилю компонента Database Mail. Необходимо выполнить хранимую процедуру sysmail_add_profileaccount_sp после создания учетной записи базы данных с помощью процедуры sysmail_add_account_sp (Transact-SQL) и профиля базы данных с помощью процедуры sysmail_add_profile_sp (Transact-SQL).
sysmail_add_profileaccount_sp { [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' } ,
    { [ @account_id = ] account_id | [ @account_name = ] 'account_name' }
    [ , [ @sequence_number = ] sequence_number ]
 
sysmail_configure_sp Изменяет настройки конфигурации компонента Database Mail. Настройки конфигурации, определенные процедурой sysmail_configure_sp, применяются ко всему экземпляру SQL Server.
sysmail_configure_sp [ [ @parameter_name = ] 'parameter_name' ]
    [ , [ @parameter_value = ] 'parameter_value' ]
    [ , [ @description = ] 'description' ]
 
sysmail_delete_account_sp Удаляет почтовую учетную запись SMTP-сервера компонента Database Mail. Для удаления учетной записи также можно воспользоваться мастером настройки компонента Database Mail.
sysmail_delete_account_sp { [ @account_id = ] account_id | [ @account_name = ] 'account_name' } 
 
sysmail_delete_log_sp Удаляет события из журнала компонента Database Mail. Удаляются либо все события, либо только события, удовлетворяющие критериям даты или типа.
sysmail_delete_log_sp  [ [ @logged_before = ] 'logged_before' ]
    [, [ @event_type = ] 'event_type' ]
 
sysmail_delete_mailitems_sp Окончательно удаляет сообщения электронной почты из внутренних таблиц компонента Database Mail.
sysmail_delete_mailitems_sp  [ [ @sent_before = ] 'sent_before' ]
    [ , [ @sent_status = ] 'sent_status' ]
 
sysmail_delete_principalprofile_sp Удаляет разрешение пользователя или роли базы данных на использование открытого или частного профиля компонента Database Mail.
sysmail_delete_principalprofile_sp  { [ @principal_id = ] principal_id | [ @principal_name = ] 'principal_name' } ,
    { [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' }
 
sysmail_delete_profile_sp  Удаляет почтовый профиль, используемый компонентом Database Mail.
sysmail_delete_profile_sp  { [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' }
 
sysmail_delete_profileaccount_sp Удаляет учетную запись из профиля компонента Database Mail.
      sysmail_delete_profileaccount_sp  {   [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' } ,
    {   [ @account_id = ] account_id | [ @account_name = ] 'account_name' }
 
sysmail_help_account_sp Предоставляет сведения (за исключением паролей) об учетных записях компонента Database Mail.
sysmail_help_account_sp [ [ @account_id = ] account_id | [ @account_name = ] 'account_name' ]
 
sysmail_help_configure_sp Отображает настройки конфигурации компонента Database Mail.
sysmail_help_configure_sp  [ [ @parameter_name = ] 'parameter_name' ]
 
sysmail_help_principalprofile_sp Выводит сведения об взаимосвязях между профилями компонента Database Mail и участниками базы данных.
sysmail_help_principalprofile_sp [ {   [ @principal_id = ] principal_id | [ @principal_name = ] 'principal_name' } ]
    [ [ , ] {   [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' } ]
 
sysmail_help_profile_sp Отображает сведения об одном или нескольких почтовых профилях.
sysmail_help_profile_sp  [   [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' ]
 
sysmail_help_profileaccount_sp Перечисляет ученые записи, связанные с одним или несколькими профилями компонента Database Mail.
sysmail_help_profileaccount_sp
   {   [ @profile_id = ] profile_id 
      | [ @profile_name = ] 'profile_name' }
   [ , {   [ @account_id = ] account_id
         | [ @account_name = ] 'account_name' } ]
 
sysmail_help_queue_sp Существуют две очереди в компоненте Database Mail: очередь почты и очередь состояний. Очередь почты содержит почтовые сообщения, ожидающие отправки. Очередь состояний содержит информацию о состоянии сообщений, которые уже были отправлены. Эта хранимая процедура позволяет просмотреть состояние очередей почты и состояний. Если аргумент @queue_type не указан, хранимая процедура возвращает по одной строке для каждой из очередей.
sysmail_help_queue_sp  [ @queue_type = ] 'queue_type'
 
sysmail_help_status_sp Выводит информацию о состоянии очередей компонента Database Mail. Для активации очередей компонента Database Mail следует использовать хранимую процедуру sysmail_start_sp, а для их деактивации — хранимую процедуру sysmail_stop_sp.
 
sysmail_start_sp Компонент Database Mail начинает работу, запуская объекты компонента Service Broker, используемые внешней программой.
 
sysmail_stop_sp Прекращает работу компонента Database Mail, останавливая работу объектов компонента Service Broker, используемых внешней программой.
 
sysmail_update_account_sp Изменяет данные в существующей учетной записи компонента Database Mail.
sysmail_update_account_sp [ [ @account_id = ] account_id ] [ , ] [ [ @account_name = ] 'account_name' ] ,
    [ @email_address = ] 'email_address' , 
    [ @display_name = ] 'display_name' , 
    [ @replyto_address = ] 'replyto_address' ,
    [ @description = ] 'description' , 
    [ @mailserver_name = ] 'server_name' , 
    [ @mailserver_type = ] 'server_type' , 
    [ @port = ] port_number , 
    [ @username = ] 'username' ,
    [ @password = ] 'password' ,
    [ @use_default_credentials = ] use_default_credentials ,
    [ @enable_ssl = ] enable_ssl
 
sysmail_update_principalprofile_sp Обновляет данные о взаимосвязи между каким-либо участником и профилем.
sysmail_update_principalprofile_sp { @principal_id = principal_id | @principal_name = 'principal_name' } ,
    { [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' } ,
    [ @is_default = ] 'is_default'
 
sysmail_update_profile_sp Изменяет описание или имя профиля компонента Database Mail
sysmail_update_profile_sp [ [ @profile_id = ] profile_id , ] [ [ @profile_name = ] 'profile_name' , ]
    [ [ @description = ] 'description' ]
 
sysmail_update_profileaccount_sp Обновляет порядковый номер учетной записи в профиле компонента Database Mail.
sysmail_update_profileaccount_sp  { [ @profile_id = ] profile_id 
| [ @profile_name = ] 'profile_name' } ,
    { [ @account_id = ] account_id | [ @account_name = ] 'account_name' } ,
    [ @sequence_number = ] sequence_number