Configurar um servidor SMTP e personalizar emails para solicitações de alertas e comentários

Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Para que as solicitações de comentários e alertas funcionem, você deve configurar um servidor SMTP para Azure DevOps Server, anteriormente nomeado Visual Studio Team Foundation Server (TFS). O servidor SMTP dá suporte aos seguintes recursos:

Pré-requisitos

  • Para executar esses procedimentos, você deve ser membro do grupo de segurança Administradores no servidor da camada de aplicativo Azure DevOps.

Configurar um servidor SMTP

  1. Se você não for um administrador Azure DevOps, será adicionado como um agora.

  2. Abra o Console de Administração Azure DevOps Server no menu Iniciar. Ou, em um prompt de comando, digite TFSMgmt.exe. Para obter detalhes, consulte Abrir console de administração.

  3. Escolha Alerta Configurações.

    Open email alerts for the application tier

    Open email alerts for the application tier

  4. Habilite alertas de email e especifique o servidor SMTP e o endereço de email que deve ser usado para enviar emails.

    Enable and configure SMTP server

    Enable and configure SMTP server

    Se a sua implantação estiver configurada para usar SSL, marque a segunda caixa de seleção e insira um certificado. Veja também Como configurar HTTPS com a SSL (Secure Sockets Layer).

    Dica

    • Verifique se o firewall está configurado para permitir comunicações entre Azure DevOps e seu servidor SMTP.
    • Seu servidor SMTP deve estar configurado para permitir o envio de emails por remetentes anônimos, ou você deve ter criado uma conta específica para os alertas. Se você especificar a Azure DevOps conta de serviço (TFSService), essa conta deverá ser uma conta de domínio com permissão para enviar email.
    • Se você usou uma conta do sistema (como o Serviço de Rede) como a conta de serviço Azure DevOps, deixe os campos Usuário e Senha em branco para a configuração avançada e verifique se o servidor SMTP está configurado para permitir que usuários anônimos enviem emails. Você também pode especificar uma conta de domínio com email como conta de email para alertas. Se não fizer isso, as notificações de email não serão enviadas.
  5. Para verificar sua configuração, abra suas notificações pessoais. Talvez você precise atualizar seu navegador para ver essa opção se tiver a habilitação do servidor SMTP for recente.

    Open personal notification settings

    Open individual alerts

    Crie um alerta e execute uma ação que o acionará.

Personalizar o formato de alertas de email

Você pode personalizar o formato de notificações por email ou alertas aos quais os membros da equipe assinam. Essas notificações são enviadas quando ocorrem alterações em itens de trabalho, revisões de código-fonte, arquivos de controle do código-fonte e builds. Para personalizar o formato, você pode modificar os arquivos de transformação XSL associados. Além disso, os membros da sua equipe podem configurar alertas de projeto em Team Web Access (TWA) para várias notificações e especificar se desejam HTML ou texto sem formatação como o formato.

Os arquivos de transformação de formato de alerta são armazenados na seguinte pasta no servidor da camada de aplicativo:

Drive:\%programfiles%\Azure DevOps Server 2019\Application Tier\TFSJobAgent\Transforms\1033

Drive:\%programfiles%\Team Foundation Server 2018\Application Tier\TFSJobAgent\Transforms\1033

Você pode usar um editor XML, como Visual Studio, para alterar qualquer um dos arquivos de transformação. A tabela a seguir lista os dois arquivos de transformação usados quando notificações por email são enviadas para eventos de alteração de item de trabalho:

Arquivo de transformação Formatar
Workitemchangedevent.xsl Email HTML
WorkItemChangedEvent.plaintextXsl email de texto sem formatação

O serviço de eventos usa os arquivos .xsl e plaintextXsl para transformar os dados XML de um evento em uma mensagem de email. Edite o arquivo .xsl para obter um formato diferente para a notificação por email. Para mensagens de email formatadas em HTML, o layout principal de todos os eventos é armazenado em TeamFoundation.xsl. Você deve fazer uma cópia de backup de todos os arquivos que deseja alterar e testar suas alterações. Depois de fazer suas alterações, o TFS usará a transformação modificada na próxima vez que gerar uma notificação para um evento.

Observação

O conteúdo dos emails emitidos é gerado automaticamente do arquivo TeamFoundation.xsl e dos arquivos xsl WorkItemChangedEvent acima. Não é recomendável modificar o arquivo TeamFoundation.xsl. Se você modificar o conteúdo deste arquivo, deverá testar cuidadosamente suas modificações. Modificações incorretas desse arquivo podem resultar na falha de alertas de email do TFS e fazer com que você não consiga exibir itens de trabalho, conjuntos de alterações ou arquivos em um navegador da Web.

Para modificar o formato de alerta para alterações de item de trabalho

  1. No servidor da camada de aplicativo, abra a pasta para a versão em execução, por exemplo:

    Drive:\%programfiles%\Azure DevOps Server 2019\Application Tier\TFSJobAgent\Transforms\1033

    Drive:\%programfiles%\Team Foundation Server 2018\Application Tier\TFSJobAgent\Transforms\1033

  2. Abra WorkItemChangedEvent.xsl em Bloco de notas ou em outro editor de texto.

  3. Edite o arquivo para mostrar a mensagem desejada no email de notificação.

    Observação

    Você deve fazer alterações semelhantes no WorkItemChangedEvent.plaintextXsl para todos os usuários que solicitaram mensagens de texto sem formatação.

  4. Salve o arquivo WorkItemChangedEvent.xsl.