Partilhar via


xp_startmail (Transact-SQL)

Inicia uma sessão cliente do SQL Mail. O início de uma sessão de email abre os componentes cliente MAPI faz logon no servidor de email.

ObservaçãoObservação

Esse recurso será removido em uma versão futura do Microsoft SQL Server. Evite usar esse recurso em desenvolvimentos novos e planeje modificar os aplicativos que atualmente o utilizam.

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

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

Argumentos

  • [ @user = ] 'mapi_profile_name'
    É um parâmetro opcional que especifica um nome de perfil de email. mapi_profile_name é sysname, sem nenhum padrão. Se este parâmetro não for fornecido, o padrão configurado no Microsoft Outlook é usado.

  • [ @password = ] 'mapi_profile_password'
    É a senha de email para o mapi_profile_name especificado. mapi_profile_password é sysname, sem nenhum padrão. Um valor NULL é permitido quando o cliente de email é iniciado (no mesmo computador) antes de executar xp_startmail.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

xp_startmail retorna esta mensagem:

SQL mail session started.

Comentários

Se mapi_profile_name e mapi_profile_password forem fornecidos, o SQL Server tentará fazer logon no provedor MAPI usando esse nome de perfil e senha. Se mapi_profile_name e mapi_profile_password forem fornecidos mas estiverem incorretos, uma mensagem de erro será retornada. Se mapi_profile_name e mapi_profile_password não forem fornecidos, o SQL Server usará o nome de perfil e senha especificados na caixa de diálogo Configuração do SQL Mail. Se nenhum nome de perfil ou senha forem explicitamente fornecidos, o SQL Server tentará fazer logon no provedor MAPI usando o perfil MAPI padrão. Alguns provedores MAPI podem ser configurados para usar o Windows Authentication e, nesse caso, a senha MAPI é ignorada.

ObservaçãoObservação

Se você usar xp_startmail para iniciar as sessões de email, poderá fornecer opcionalmente seu nome de login e senha para que não tenha de digitá-los no prompt de comando. Entretanto, o SQL Mail não será executado em uma sessão MAPI existente se houver uma em execução. Este comportamento é diferente do SQL Server versão 7.0 e anteriores.

Se houver uma sessão de email existente, xp_startmail não iniciará uma nova. Se o email estiver sendo usado no mesmo computador em que o SQL Server é executado, o cliente de email deverá ser iniciado antes que xp_startmail seja executado ou antes que SQL Server seja iniciado, se o SQL Mail estiver configurado para iniciar automaticamente quanto o SQL Server for iniciado.

Permissões

Requer associação na função de servidor fixa sysadmin, mas permissões EXECUTE podem ser concedidas a outros usuários. Mas, por razões de segurança, é recomendável que as permissões desse procedimento armazenado sejam limitadas aos membros da função de servidor fixa sysadmin.

Exemplos

O exemplo a seguir inicia o email usando o nome de usuário e senha especificados no Microsoft Outlook como perfil padrão para a conta do Microsoft Windows com a qual o SQL Server é executado.

USE master;
GO
EXEC xp_startmail;
GO