Criar pendências e comentários a partir de e-mails
Configurar a criação de pendências ou comentários a partir de e-mails
As pendências e os comentários no JIRA podem ser gerados a partir de:
- mensagens de e-mail enviadas a uma conta em um servidor de e-mail POP ou IMAP, ou
- mensagens escritas ao sistema de arquivos e geradas por um serviço de e-mail externo.
Observe que, para todos os procedimentos a seguir, você precisa estar conectado como um usuário com permissão globalde administrador JIRA.
Primeiro passo: configurar um servidor/serviço de e-mail
Mensagens de e-mail POP ou IMAP
Para configurar a criação de pendências e comentários a partir de e-mails, você precisa criar uma conta de e-mail para um servidor de e-mail POP ou IMAP que o JIRA possa acessar. Normalmente, é criada uma conta de e-mail para cada projeto JIRA. Por exemplo, para o projeto "ABC", você pode estabelecer a conta abc-issues@example.com
O JIRA verificará periodicamente novas mensagens de e-mail recebidas em sua conta de e-mail (por meio de um serviço) e criará pendências ou comentários de acordo com os e-mails que encontrar (por meio de um manipulador de e-mail).
Os manipuladores de e-mail do JIRA também podem, opcionalmente, criar novas contas de usuário para remetentes não vistos anteriormente. Consulte a seção Criar uma nova pendência ou adicionar um comentário a uma pendência existente para obter mais detalhes.
Observe que isso não é possível se você estiver usando o gerenciamento externo de usuários.
Depois de criar uma conta de e-mail em um servidor de e-mail POP ou IMAP, configure o JIRA para receber e-mail da conta do servidor de e-mail.
Dica: você pode configurar os servidores de e-mail do JIRA para que os destinatários das notificações de e-mail possam simplesmente responder a essas mensagens e ter o corpo de suas respostas adicionado como comentários à pendência relevante. Para isso, configure o Endereço do remetente no servidor de e-mail SMTP do JIRA para coincidir com o da conta do servidor de e-mail POP ou IMAP monitorada. Na maioria dos casos, isso significa que os servidores de e-mail SMTP e POP ou IMAP do JIRA usarão a mesma conta de e-mail. Consulte abaixo para obter detalhes sobre como configurar o JIRA para lidar com essas respostas enviadas por e-mail.
Mensagens do sistema de arquivos
Para configurar a criação de comentários e pendências a partir de mensagens gravadas no sistema de arquivos por um serviço de e-mail externo, o serviço de e-mail externo deve poder gravar essas mensagens dentro do subdiretório import/mail
do diretório inicial do JIRA.
Os serviços de e-mail externos são muito similares aos serviços POP ou IMAP acima, exceto que, em vez de as mensagens de e-mail serem lidas de uma conta de e-mail, são lidas de um diretório no disco. Os serviços de e-mail externos são úteis porque superam os potenciais riscos de segurança associados às contas de e-mail anônimas. Você pode simplesmente configurar o serviço de e-mail externo para despejar mensagens de e-mail recebidas dentro do subdiretório import/mail
do diretório inicial do JIRA, que é examinado periodicamente.
Esteja ciente de que o JIRA espera receber apenas uma mensagem por arquivo; portanto, o serviço de e-mail externo deve ser configurado para gerar esse fluxo de saída.
Nota: veja como o JIRA lida com mensagens em um servidor/serviço de e-mail:
- Para contas de e-mail, o JIRA verifica as mensagens de e-mail recebidas na caixa de entrada da conta de e-mail. Porém, para servidores de e-mail IMAP, você pode especificar uma pasta diferente na conta de e-mail.
- Quando o JIRA processa uma mensagem com êxito, ele exclui a mensagem da conta de e-mail (em um servidor de e-mail POP ou IMAP) ou do sistema de arquivos (para mensagens de sistema de arquivos).
- Quando o JIRA não processar uma mensagem com êxito, a mensagem permanece na conta de e-mail ou no sistema de arquivos.
Segundo passo: configurar um manipulador de e-mail
Depois de configurar o JIRA para receber mensagens de um servidor/serviço de e-mail, é necessário configurar o JIRA para lidar com essas mensagens por meio de um manipulador de e-mail.
- Escolha > Sistema.
- Selecione Correio > E-mail de entrada para abrir a página E-mail de entrada.
- Clique no botão Adicionar manipulador de e-mail de entrada (ou no link Editar próximo a um manipulador de e-mail existente) na seção Manipuladores de e-mail para abrir a caixa de diálogo Manipulador de e-mail.
- Especifique um Nome que descreva o que o seu manipulador de e-mail fará; por exemplo, "Criar pendências ou comentários do servidor de e-mail IMAP da empresa Exemplo".
- Selecione o Servidor de e-mail configurado no passo (acima). Trata-se de um servidor de e-mail POP ou IMAP ou da opção Arquivos locais para um serviço de e-mail externo que grava mensagens no sistema de arquivos.
- Especifique o Atraso (em minutos) entre os tempos de execução do manipulador de e-mail. Isso efetivamente define a frequência com que o JIRA verifica o Servidor especificado no passo anterior.
- Escolha o tipo de Manipulador de e-mail na lista suspensa. Para obter mais informações, consulte a seção Manipuladores de e-mail abaixo.
- Se você escolher a opção servidor de e-mail IMAP ou Arquivos locais no campo Servidor, o campo Nome da pasta aparecerá abaixo da lista suspensa do campo Manipulador :
- Em um servidor de e-mail IMAP, se você deseja que o manipulador de e-mail verifique novas mensagens de uma pasta além da Caixa de entrada em sua conta de e-mail, especifique o nome dessa pasta aqui.
- Na opção Arquivos locais, se as suas mensagens de arquivo estiverem sendo salvas a um subdiretório dentro do subdiretório
import/mail
do diretório inicial do JIRA, especifique a estrutura do subdiretório aqui (dentro doimport/mail
).
- Clique em Próximo para continuar a especificar as opções restantes específicas do Manipulador de e-mail selecionado acima. Para obter mais informações, consulte a seção Manipuladores de e-mail abaixo.
- (Opcional) Clique no botão Teste para testar o manipulador de e-mail. Se você estiver usando Arquivos locais como servidor, copie um e-mail salvo que contenha uma linha "Assunto: " para o diretório configurado. O JIRA removerá este arquivo depois de analisá-lo ou registrará uma mensagem sobre por que uma pendência não pôde ser criada. Talvez seja preciso especificar as propriedades do projeto, o tipo de dependência e o nome do usuário relator como configuração mínima.
Este é um exemplo de um arquivo de e-mail:Para: jira@example.com
De: some-jira-user@example.com
Subject: (TEST-123) issue summary title here
Body of the email goes here
- Clique no botão Adicionar/Salvar para salvar o manipulador de e-mail.
Notas sobre a relação entre manipuladores de e-mail do JIRA e serviços:
- Um manipulador de e-mail do JIRA é parte de um serviço JIRA . Portanto, ao criar um manipulador de e-mail, o serviço aparecerá como uma entrada na página Serviços.
- Esteja ciente de que a edição de manipuladores de e-mail só pode ser realizada na página Manipuladores de e-mail (descrita acima).
- Na página Manipuladores de e-mail, ao clicar no link Excluir associado a um manipulador de e-mail, esse manipulador será removido. Como um manipulador de e-mail faz parte de um serviço, se você excluir o serviço de um manipulador de e-mail na página Serviços, o manipulador associado também será removido da página Manipuladores de e-mail.
Manipuladores de e-mail
O JIRA fornece os seguintes manipuladores de e-mail padrão:
- Criar uma nova pendência ou adicionar um comentário a uma pendência existente
- Adicionar um comentário a partir da parte não citada do corpo do e-mail
- Adicionar um comentário com o corpo inteiro do e-mail
- Criar uma nova pendência de cada mensagem de e-mail
- Adicione um comentário antes de um marcador ou separador especificado no corpo do e-mail
Para obter mais informações sobre como esses manipuladores de e-mail criam pendências e comentários no JIRA, consulteCriar pendências e comentários (abaixo).
Consulte também Dicas práticas com manipuladores de e-mail (abaixo) para obter dicas sobre como ajustar manipuladores de e-mail para permitir que o JIRA manipule os seguintes tipos de mensagens de e-mail:
- E-mail enviado por pessoas sem uma conta de usuário do JIRA.
Criar uma nova pendência ou adicionar um comentário a uma pendência existente
Esse manipulador de mensagem cria uma nova pendência ou adiciona um comentário a uma pendência existente. Se o assunto contiver uma chave de pendência, a mensagem será adicionada como um comentário a essa pendência. Se nenhuma chave de pendência for encontrada, uma nova pendência será criada no projeto padrão.
Para configurar um manipulador de e-mail "Criar uma nova pendência ou adicionar um comentário a uma pendência existente":
- Se você ainda não tiver feito isso, comece a configurar seu manipulador de e-mail (acima).
Na caixa de diálogo Criar uma nova pendência ou adicionar um comentário a uma pendência existente, preencha os seguintes campos/opções:
Projeto Especifique a chave de projeto do projeto padrão para o qual esse manipulador criou novas pendências, por exemplo,
JRA
.Nota:
- Esse campo é relevante apenas para a criação de pendências, não para a inserção de comentários em pendências.
- Se uma mensagem de e-mail contiver uma chave de pendência na linha de assunto e essa chave de pendência existir na sua instalação do JIRA, o manipulador adicionará o conteúdo da mensagem de e-mail como um comentário na pendência, sem importar o projeto no qual a pendência está.
Tipo de pendência Escolha o tipo de pendência padrão para novas pendências. Remover citações Marque esta caixa de seleção para remover o texto citado do corpo de uma mensagem de e-mail (por exemplo, as respostas de e-mail anteriores) antes que o conteúdo do corpo seja adicionado ao comentário da pendência do JIRA. Endereço de e-mail de captura
Se especificado, somente mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham o destinatário especificado nesse campo serão processadas, por exemplo,
issues@mycompany.com
Ao especificar um endereço aqui, todas as mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham endereços diferentes do Endereço de e-mail de captura serão ignoradas. Isso será útil se você tiver vários aliases para a mesma conta de e-mail (por exemplo, aliases
foo-support@example-co.com
ebar-support@example-co.com
parasupport@example-co.com
) para vários serviços de e-mail (por exemplo, cada alias para criar pendências em um projeto diferente do JIRA).Nota: na prática, essa opção raramente é útil e não deve ser confundida com a opção Relator padrão, que é mais comum. Você pode especificar somente um endereço de e-mail de captura e um tipo de pendência por manipulador de e-mail.
Além disso, há um bug no JIRA 7.0.0 e no JIRA 7.0.1, que faz com que diversos manipuladores de e-mail usados para criar pendências em diferentes projetos quando um e-mail é enviado a múltiplos aliases não processem corretamente os e-mails. Isso foi corrigido no JIRA 7.0.2. Para obter mais informações, consulte JRA-41831 - Getting issue details... STATUS .
Em massa Essa opção afeta somente mensagens de e-mail "em massa" cujo cabeçalho tenha o campo Precedência: definido como em massa ou o campo Enviado automaticamente definido como não. Essas mensagens normalmente seriam enviadas por um serviço automatizado. Quando uma mensagem de e-mail assim é recebida, a ação a seguir é realizada, dependendo da opção que você escolher:
- Ignorar o e-mail e não executar ação alguma.
- Encaminhar o e-mail (para o endereço definido no campo de texto Encaminhar e-mail).
- Excluir o e-mail em caráter permanente.
Geralmente é uma boa ideia configurar em massa=encaminhar e definir um endereço de e-mail direto para evitar loops de e-mail entre o JIRA e outro serviço automatizado (por exemplo, outra instalação do JIRA).
Encaminhar o e-mail Se essa opção for especificada, caso o serviço de e-mail não consiga manipular uma mensagem de e-mail recebida, uma mensagem de e-mail indicando esse problema será encaminhada ao endereço de e-mail especificado nesse campo.Nota: Um servidor de e-mail SMTP deve ser configurado para que essa opção funcione corretamente.
Criar usuários Marque essa caixa de seleção se desejar que o JIRA crie novas contas de usuário de quaisquer mensagens de e-mail recebidas cujo campo De: contenha um endereço que não foi registrado em nenhuma conta existente do JIRA. Isso permite ao criador da mensagem de e-mail ser notificado de atualizações subsequentes à pendência, o que pode ser feito configurando o esquema de notificação relevante do projeto para notificar o Relator sobre as atualizações.
O nome de usuário e o endereço de e-mail dessas contas de usuário do JIRA recém-criadas serão os endereços de e-mail especificados no campo De: das mensagens recebidas. A senha desses novos usuários do JIRA é gerada aleatoriamente, e uma mensagem de e-mail é enviada aos seus endereços informando sobre a nova conta de usuário do JIRA.
Os usuários criados dessa forma são adicionados aos grupos padrão da aplicação JIRA padrão (e, portanto, começam a utilizar uma licença para essa aplicação). Consulte a Gerenciar grupos documentação.Nota: essa opção não é compatível com a opção do campo Relator padrão abaixo e, assim, escolher a opção Criar usuários ocultará a opção Relator padrão.
Relator padrão Especifique o nome de usuário de um relator padrão, que será usado se o endereço de e-mail no campo De: de qualquer mensagem recebida não corresponder ao endereço associado àquele de um usuário atual do JIRA (por exemplo, um nome de usuário do JIRA como
emailed-reporter
)Nota:
- Essa opção não estará disponível se a caixa de seleção Criar usuários estiver marcada.
- O usuário especificado neste campo deve ter a permissão de projeto Criar pendências para o Projeto relevante (especificado acima), bem como a permissão de projeto Criar comentários para os outros projetos relevantes aos quais esse manipulador de e-mail deve adicionar comentários.
- Quando uma pendência é criada e essa opção é especificada, o endereço do campo De: da mensagem de e-mail é anexado em uma breve mensagem no final do campo Descrição da pendência, de modo que o remetente possa ser identificado.
Notificar usuários Desmarque essa caixa de seleção se não desejar que o JIRA envie uma mensagem de e-mail notificando os usuários cujas contas foram criadas pela opção Criar usuários acima.
Nota: essa opção funcionará somente se a caixa de seleção Criar usuários tiver sido selecionada.
Responsável baseado em Cc Marque essa caixa de seleção se desejar que o JIRA atribua automaticamente a pendência criada a um usuário do JIRA:
- Cujo endereço de e-mail (registrado na conta do JIRA) seja igual ao primeiro endereço correspondente encontrado no campo Para:, Cc: e Cco: da mensagem de e-mail recebida.
- Que também tenha a permissão de projeto Usuário atribuível para o Projeto relevante (especificado acima).
Seguidores baseados em Cc Marque essa caixa de seleção se desejar que o JIRA adicione automaticamente usuários do JIRA à pendência criada quando os endereços de e-mail desses usuários (registrados com suas contas do JIRA) forem iguais aos endereços encontrados nos campos Para:, Cc: ou Cco: da mensagem de e-mail recebida.
Observe que, quando uma pendência é criada, novos usuários do JIRA criados pela opção Criar usuários (acima) não podem ser adicionados também à lista de seguidores da pendência por essa opção Seguidores baseados em Cc. Os usuários do JIRA já devem existir na base de usuários do JIRA e devem ter um endereço de e-mail.
- Teste e salve o manipulador de e-mail (acima).
Adicionar um comentário a partir da parte não citada do corpo do e-mail
Este manipulador de mensagens cria um comentário, mas usa somente as linhas não citadas do corpo da mensagem de e-mail. As linhas citadas são aquelas que começam com o símbolo ">" ou "|". Essas linhas de texto não serão adicionadas ao comentário. A pendência à qual o comentário é adicionado é escolhida a partir da primeira chave de pendência encontrada no assunto do e-mail. O autor do comentário é tirado do endereço do campo De: da mensagem de e-mail.
Para configurar um manipulador de e-mail "Adicionar um comentário a partir da parte não citada do corpo do e-mail":
- Se você ainda não tiver feito isso, comece a configurar seu manipulador de e-mail (acima).
Na caixa de diálogoAdicionar um comentário a partir da parte não citada do corpo do e-mail, preencha os seguintes campos/opções:
Endereço de e-mail de captura Se especificado, somente mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham o destinatário especificado nesse campo serão processadas, por exemplo, issues@mycompany.com
Ao especificar um endereço aqui, todas as mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham endereços diferentes do Endereço de e-mail de captura serão ignoradas. Isso será útil se você tiver vários aliases para a mesma conta de e-mail (por exemplo, aliases
foo-support@example-co.com
ebar-support@example-co.com
parasupport@example-co.com
) para vários serviços de e-mail (por exemplo, cada alias para criar pendências em um projeto diferente do JIRA).Nota: na prática, essa opção raramente é útil e não deve ser confundida com a opção Relator padrão, que é mais comum. Você pode especificar somente um endereço de e-mail de captura e um tipo de pendência por manipulador de e-mail.
Em massa Essa opção afeta somente mensagens de e-mail "em massa" cujo cabeçalho tenha o campo Precedência: definido como em massa ou o campo Enviado automaticamente definido como não. Essas mensagens normalmente seriam enviadas por um serviço automatizado. Quando uma mensagem de e-mail assim é recebida, a ação a seguir é realizada, dependendo da opção que você escolher:
- Ignorar o e-mail e não executar ação alguma.
- Encaminhar o e-mail (para o endereço definido no campo de texto Encaminhar e-mail).
- Excluir o e-mail em caráter permanente.
Encaminhar o e-mail Se essa opção for especificada, caso o serviço de e-mail não consiga manipular uma mensagem de e-mail recebida, uma mensagem de e-mail indicando esse problema será encaminhada ao endereço de e-mail especificado nesse campo. Nota: Um servidor de e-mail SMTP deve ser configurado para que essa opção funcione corretamente.
Criar usuários Marque essa caixa de seleção se desejar que o JIRA crie novas contas de usuário a partir de quaisquer mensagens de e-mail recebidas cujo campo De: contenha um endereço que não foi registrado em nenhuma conta existente do JIRA. Isso permite ao criador da mensagem de e-mail ser notificado de atualizações subsequentes à pendência, o que pode ser feito configurando o esquema de notificação relevante do projeto para notificar o Relator sobre as atualizações.
O nome de usuário e o endereço de e-mail dessas contas de usuário do JIRA recém-criadas serão o endereço de e-mail especificado no campo De: da mensagem. A senha do novo usuário é gerada aleatoriamente, e um e-mail é enviado ao novo usuário informando-o sobre a nova conta no JIRA.
Os usuários criados dessa forma são adicionados aos grupos padrão da aplicação JIRA padrão (e, portanto, começam a utilizar uma licença para essa aplicação). Consulte a Gerenciar grupos documentação.Nota: essa opção não é compatível com a opção do campo Relator padrão abaixo e, assim, escolher a opção Criar usuários ocultará a opção Relator padrão.
Relator padrão Especifique o nome de usuário de um relator padrão, que será usado se o endereço de e-mail no campo De: de qualquer mensagem recebida não corresponder ao endereço associado àquele de um usuário atual do JIRA (por exemplo, um nome de usuário do JIRA como
emailed-reporter
)Nota:
- Essa opção não estará disponível se a caixa de seleção Criar usuários estiver marcada.
- O usuário especificado neste campo deve ter a permissão de projeto Criar pendências para o Projeto relevante (especificado acima), bem como a permissão de projeto Criar comentários para os outros projetos relevantes aos quais esse manipulador de e-mail deve adicionar comentários.
Notificar usuários Desmarque essa caixa de seleção se não desejar que o JIRA envie uma mensagem de e-mail notificando os usuários cujas contas foram criadas pela opção Criar usuários acima.
Nota: essa opção funcionará somente se a caixa de seleção Criar usuários tiver sido selecionada.
Teste e salve o manipulador de e-mail (acima).
Adicionar um comentário com o corpo inteiro do e-mail
Este manipulador de mensagens cria um comentário com base no corpo inteiro da mensagem de e-mail recebida. A pendência à qual o comentário é adicionado é escolhida a partir da primeira chave de pendência encontrada no assunto do e-mail. O autor do comentário é tirado do endereço do campo De: da mensagem de e-mail.
Para configurar um manipulador de e-mail "Adicionar um comentário com o corpo inteiro do e-mail":
- Se você ainda não tiver feito isso, comece a configurar seu manipulador de e-mail (acima).
Na caixa de diálogo Adicionar um comentário com o corpo inteiro do e-mail, preencha os seguintes campos/opções:
Endereço de e-mail de captura Se especificado, somente mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham o destinatário especificado nesse campo serão processadas, por exemplo, issues@mycompany.com
Ao especificar um endereço aqui, todas as mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham endereços diferentes do Endereço de e-mail de captura serão ignoradas. Isso será útil se você tiver vários aliases para a mesma conta de e-mail (por exemplo, aliases
foo-support@example-co.com
ebar-support@example-co.com
parasupport@example-co.com
) para vários serviços de e-mail (por exemplo, cada alias para criar pendências em um projeto diferente do JIRA).Nota: na prática, essa opção raramente é útil e não deve ser confundida com a opção Relator padrão, que é mais comum. Você pode especificar somente um endereço de e-mail de captura e um tipo de pendência por manipulador de e-mail.
Em massa Essa opção afeta somente mensagens de e-mail "em massa" cujo cabeçalho tenha o campo Precedência: definido como em massa ou o campo Enviado automaticamente definido como não. Essas mensagens normalmente seriam enviadas por um serviço automatizado. Quando uma mensagem de e-mail assim é recebida, a ação a seguir é realizada, dependendo da opção que você escolher:
- Ignorar o e-mail e não executar ação alguma.
- Encaminhar o e-mail (para o endereço definido no campo de texto Encaminhar e-mail).
- Excluir o e-mail em caráter permanente.
Encaminhar o e-mail Se essa opção for especificada, caso o serviço de e-mail não consiga manipular uma mensagem de e-mail recebida, uma mensagem de e-mail indicando esse problema será encaminhada ao endereço de e-mail especificado nesse campo. Nota: Um servidor de e-mail SMTP deve ser configurado para que essa opção funcione corretamente.
Criar usuários Marque essa caixa de seleção se desejar que o JIRA crie novas contas de usuário a partir de quaisquer mensagens de e-mail recebidas cujo campo De: contenha um endereço que não foi registrado em nenhuma conta existente do JIRA. Isso permite ao criador da mensagem de e-mail ser notificado de atualizações subsequentes à pendência, o que pode ser feito configurando o esquema de notificação relevante do projeto para notificar o Relator sobre as atualizações.
O nome de usuário e o endereço de e-mail dessas contas de usuário do JIRA recém-criadas serão o endereço de e-mail especificado no campo De: da mensagem. A senha do novo usuário é gerada aleatoriamente, e um e-mail é enviado ao novo usuário informando-o sobre a nova conta no JIRA.
Os usuários criados assim serão adicionados aos grupos padrão da aplicação JIRA padrão (e, portanto, utilizarão uma licença para essa aplicação).Consulte a documentação Gerenciar grupos. Nota: essa opção não é compatível com a opção do campo Relator padrão abaixo e, assim, escolher a opção Criar usuários ocultará a opção Relator padrão.
Relator padrão Especifique o nome de usuário de um relator padrão, que será usado se o endereço de e-mail no campo De: de qualquer mensagem recebida não corresponder ao endereço associado àquele de um usuário atual do JIRA (por exemplo, um nome de usuário do JIRA como
emailed-reporter
)Nota:
- Essa opção não estará disponível se a caixa de seleção Criar usuários estiver marcada.
- O usuário especificado neste campo deve ter a permissão do projeto para Criar pendências para o Projeto relevante (especificado acima), bem como a permissão do projeto Criar comentários para os outros projetos relevantes aos quais esse manipulador de e-mail deve adicionar comentários.
Notificar usuários Desmarque essa caixa de seleção se não desejar que o JIRA envie uma mensagem de e-mail notificando os usuários cujas contas foram criadas pela opção Criar usuários acima.
Nota: essa opção funcionará somente se a caixa de seleção Criar usuários tiver sido selecionada.
- Teste e salve o manipulador de e-mail (acima).
Criar uma nova pendência de cada mensagem de e-mail
Esse manipulador de e-mail cria uma nova pendência para cada mensagem recebida.
Para configurar o manipulador de e-mail "Criar uma nova pendência de cada mensagem de e-mail":
- Se você ainda não tiver feito isso, comece a configurar seu manipulador de e-mail (acima).
Na caixa de diálogo Criar uma nova pendência de cada mensagem de e-mail, preencha os seguintes campos/opções:
Projeto Especifique a chave de projeto do projeto padrão para o qual esse manipulador criou novas pendências, por exemplo,
JRA
.Nota:
- Esse campo é relevante apenas para a criação de pendências, não para a inserção de comentários em pendências.
- Se uma mensagem de e-mail contiver uma chave de pendência na linha de assunto e essa chave de pendência existir na sua instalação do JIRA, o manipulador adicionará o conteúdo da mensagem de e-mail como um comentário na pendência, sem importar o projeto no qual a pendência está.
Tipo de pendência Escolha o tipo de pendência padrão para novas pendências. Endereço de e-mail de captura
Se especificado, somente mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham o destinatário especificado nesse campo serão processadas, por exemplo,
issues@mycompany.com
Ao especificar um endereço aqui, todas as mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham endereços diferentes do Endereço de e-mail de captura serão ignoradas. Isso será útil se você tiver vários aliases para a mesma conta de e-mail (por exemplo, aliases
foo-support@example-co.com
ebar-support@example-co.com
parasupport@example-co.com
) para vários serviços de e-mail (por exemplo, cada alias para criar pendências em um projeto diferente do JIRA).Nota: na prática, essa opção raramente é útil e não deve ser confundida com a opção Relator padrão, que é mais comum. Você pode especificar somente um endereço de e-mail de captura e um tipo de pendência por manipulador de e-mail.
Em massa Essa opção afeta somente mensagens de e-mail "em massa" cujo cabeçalho tenha o campo Precedência: definido como em massa ou o campo Enviado automaticamente definido como não. Essas mensagens normalmente seriam enviadas por um serviço automatizado. Quando uma mensagem de e-mail assim é recebida, a ação a seguir é realizada, dependendo da opção que você escolher:
- Ignorar o e-mail e não executar ação alguma.
- Encaminhar o e-mail (para o endereço definido no campo de texto Encaminhar e-mail).
- Excluir o e-mail em caráter permanente.
Encaminhar o e-mail Se essa opção for especificada, caso o serviço de e-mail não consiga manipular uma mensagem de e-mail recebida, uma mensagem de e-mail indicando esse problema será encaminhada ao endereço de e-mail especificado nesse campo. Nota: Um servidor de e-mail SMTP deve ser configurado para que essa opção funcione corretamente.
Criar usuários Marque essa caixa de seleção se desejar que o JIRA crie novas contas de usuário a partir de quaisquer mensagens de e-mail recebidas cujo campo De: contenha um endereço que não foi registrado em nenhuma conta existente do JIRA. Isso permite ao criador da mensagem de e-mail ser notificado de atualizações subsequentes à pendência, o que pode ser feito configurando o esquema de notificação relevante do projeto para notificar o Relator sobre as atualizações.
O nome de usuário e o endereço de e-mail dessas contas de usuário do JIRA recém-criadas serão o endereço de e-mail especificado no campo De: da mensagem. A senha do novo usuário é gerada aleatoriamente, e um e-mail é enviado ao novo usuário informando-o sobre a nova conta no JIRA.
Os usuários criados assim serão adicionados aos grupos padrão da aplicação JIRA padrão (e, portanto, utilizarão uma licença para essa aplicação).Consulte a documentação Gerenciar grupos. Nota: essa opção não é compatível com a opção do campo Relator padrão abaixo e, assim, escolher a opção Criar usuários ocultará a opção Relator padrão.
Relator padrão Especifique o nome de usuário de um relator padrão, que será usado se o endereço de e-mail no campo De: de qualquer mensagem recebida não corresponder ao endereço associado àquele de um usuário atual do JIRA (por exemplo, um nome de usuário do JIRA como
emailed-reporter
)Nota:
- Essa opção não estará disponível se a caixa de seleção Criar usuários estiver marcada.
- O usuário especificado neste campo deve ter a permissão do projeto para Criar pendências para o Projeto relevante (especificado acima), bem como a permissão do projeto Criar comentários para os outros projetos relevantes aos quais esse manipulador de e-mail deve adicionar comentários.
- Quando uma pendência é criada e essa opção é especificada, o endereço do campo De: da mensagem de e-mail é anexado em uma breve mensagem no final do campo Descrição da pendência, de modo que o remetente possa ser identificado.
Notificar usuários Desmarque essa caixa de seleção se não desejar que o JIRA envie uma mensagem de e-mail notificando os usuários cujas contas foram criadas pela opção Criar usuários acima.
Nota: essa opção funcionará somente se a caixa de seleção Criar usuários tiver sido selecionada.
Responsável baseado em Cc Marque essa caixa de seleção se desejar que o JIRA atribua automaticamente a pendência criada a um usuário do JIRA:
- Cujo endereço de e-mail (registrado na conta do JIRA) seja igual ao primeiro endereço correspondente encontrado no campo Para: , então Cc: e então Cco: da mensagem de e-mail recebida.
- Que também tem a permissão de projeto Usuário atribuível Gerenciar permissões de projeto para o Projeto relevante (especificado acima).
Seguidores baseados em Cc Marque essa caixa de seleção se desejar que o JIRA adicione automaticamente usuários do JIRA à pendência criada quando os endereços de e-mail desses usuários (registrados com suas contas do JIRA) forem iguais aos endereços encontrados nos campos Para:, Cc: ou Cco: da mensagem de e-mail recebida.
Observe que, quando uma pendência é criada, novos usuários do JIRA criados pela opção Criar usuários (acima) não podem ser adicionados também à lista de seguidores da pendência por essa opção Seguidores baseados em Cc. Os usuários do JIRA já devem existir na base de usuários do JIRA e devem ter um endereço de e-mail.
- Teste e salve o manipulador de e-mail (acima).
Adicione um comentário antes de um marcador ou separador especificado no corpo do e-mail
Esse manipulador de e-mail cria um comentário usando o corpo da mensagem de e-mail, mas ignora qualquer parte do corpo além de um marcador ou separador que corresponda a uma expressão regular (regex) especificada.
Para sistemas de e-mail como o Lotus Notes e o Outlook, o conteúdo principal de uma mensagem de e-mail é separado de outro conteúdo (por exemplo, respondido ou encaminhado) no corpo por alguma cadeia de caracteres de texto previsível como "---- Original Message ----
" ou "Extranet\n email.address/DOM/REG/CONT/CORP@CORPMAIL
". Assim, use esse manipulador de e-mail, que pode utilizar qualquer regex válida, para filtrar o núcleo de um conteúdo externo de vários sistemas de e-mail diferentes.
Observe também que a pendência à qual o comentário é adicionado é escolhida a partir da primeira chave de pendência encontrada no assunto do e-mail.
O manipulador de e-mail Adicionar um comentário antes de um marcador ou separador especificado no corpo do e-mail tem o seguinte comportamento com relação às mensagens de e-mail recebidas:
- Se o padrão regex (especificado no manipulador de e-mail) for encontrado, o texto no corpo da mensagem de e-mail antes da primeira correspondência do padrão regex será usado para o comentário e o restante do corpo será descartado.
- Se o padrão regex (especificado no manipulador de e-mail) não for encontrado, todo o texto no corpo da mensagem de e-mail será usado para o comentário.
- Se nenhum padrão regex for especificado no manipulador de e-mail, todo o texto no corpo da mensagem de e-mail será usado para o comentário.
- Se a expressão regex especificada no manipulador de e-mail estiver incorreta, todo o texto no corpo da mensagem de e-mail será usado para o comentário.
Para configurar um manipulador de e-mail "Adicionar um comentário antes de um marcador ou separador especificado no corpo do e-mail":
- Se você ainda não tiver feito isso, comece a configurar seu manipulador de e-mail (acima).
Na caixa de diálogo Adicionar um comentário antes de um marcador ou separador especificado no corpo do e-mail, preencha os seguintes campos/opções:
Dividir regex Especifique uma expressão regular que corresponda ao texto que separa o conteúdo do corpo da mensagem de e-mail de outro conteúdo (respondido ou encaminhado) no corpo.
Nota:
- A regex deve começar e terminar com um caractere delimitador, em geral, "
/
". - Não são permitidas vírgulas em uma regex, uma vez que elas são usadas para separar cada campo/opção de manipulador de e-mail quando são integradas a um serviço JIRA e não há (ainda) uma sintaxe de escape.
Por exemplo:
/----\s*Original Message\s*----/
ou
/_____________*/
Endereço de e-mail de captura Se especificado, somente mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham o destinatário especificado nesse campo serão processadas, por exemplo, issues@mycompany.com
Ao especificar um endereço aqui, todas as mensagens de e-mail cujas linhas Para:, Cc: e Cco: contenham endereços diferentes do Endereço de e-mail de captura serão ignoradas. Isso será útil se você tiver vários aliases para a mesma conta de e-mail (por exemplo, aliases
foo-support@example-co.com
ebar-support@example-co.com
parasupport@example-co.com
) para vários serviços de e-mail (por exemplo, cada alias para criar pendências em um projeto diferente do JIRA).Nota: na prática, essa opção raramente é útil e não deve ser confundida com a opção Relator padrão, que é mais comum. Você pode especificar somente um endereço de e-mail de captura e um tipo de pendência por manipulador de e-mail.
Em massa Essa opção afeta somente mensagens de e-mail "em massa" cujo cabeçalho tenha o campo Precedência: definido como em massa ou o campo Enviado automaticamente definido como não. Essas mensagens normalmente seriam enviadas por um serviço automatizado. Quando uma mensagem de e-mail assim é recebida, a ação a seguir é realizada, dependendo da opção que você escolher:
- Ignorar o e-mail e não executar ação alguma.
- Encaminhar o e-mail (para o endereço definido no campo de texto Encaminhar e-mail).
- Excluir o e-mail em caráter permanente.
Encaminhar o e-mail Se essa opção for especificada, caso o serviço de e-mail não consiga manipular uma mensagem de e-mail recebida, uma mensagem de e-mail indicando esse problema será encaminhada ao endereço de e-mail especificado nesse campo. Nota: Um servidor de e-mail SMTP deve ser configurado para que essa opção funcione corretamente.
Criar usuários Marque essa caixa de seleção se desejar que o JIRA crie novas contas de usuário a partir de quaisquer mensagens de e-mail recebidas cujo campo De: contenha um endereço que não foi registrado em nenhuma conta existente do JIRA. Isso permite ao criador da mensagem de e-mail ser notificado de atualizações subsequentes à pendência, o que pode ser feito configurando o esquema de notificação relevante do projeto para notificar o Relator sobre as atualizações.
O nome de usuário e o endereço de e-mail dessas contas de usuário do JIRA recém-criadas serão o endereço de e-mail especificado no campo De: da mensagem. A senha do novo usuário é gerada aleatoriamente, e um e-mail é enviado ao novo usuário informando-o sobre a nova conta no JIRA.
Os usuários criados assim serão adicionados aos grupos padrão da aplicação JIRA padrão (e, portanto, utilizarão uma licença para essa aplicação).Consulte a documentação Gerenciar grupos. Nota: essa opção não é compatível com a opção do campo Relator padrão abaixo e, assim, escolher a opção Criar usuários ocultará a opção Relator padrão.
Relator padrão Especifique o nome de usuário de um relator padrão, que será usado se o endereço de e-mail no campo De: de qualquer mensagem recebida não corresponder ao endereço associado àquele de um usuário atual do JIRA (por exemplo, um nome de usuário do JIRA como
emailed-reporter
)Nota:
- Essa opção não estará disponível se a caixa de seleção Criar usuários estiver marcada.
- O usuário especificado neste campo deve ter a permissão do projeto para Criar pendências Gerenciar permissões de projeto para o Projeto relevante (especificado acima), bem como a permissão do projeto Criar comentários para os outros projetos relevantes aos quais esse manipulador de e-mail deve adicionar comentários.
Notificar usuários Desmarque essa caixa de seleção se não desejar que o JIRA envie uma mensagem de e-mail notificando usuários cujas contas foram criadas pela opção Criar usuários acima.
Nota: essa opção funcionará somente se a caixa de seleção Criar usuários tiver sido selecionada.
- A regex deve começar e terminar com um caractere delimitador, em geral, "
- Teste e salve o manipulador de e-mail (acima).
Manipuladores de e-mail personalizados
É possível desenvolver seus próprios manipuladores de e-mail para integrar melhor seus próprios processos no JIRA. Esses manipuladores de e-mail personalizados são configurados usando o procedimento padrão acima.
Para obter informações sobre como criar manipuladores de e-mail personalizados, consulte a documentação Message Handler Plugin Module (Módulo de plugin do manipulador de e-mail).
Criação de pendência/comentário
Os pontos a seguir descrevem como o JIRA processa cada mensagem de e-mail recebida e determina como seu conteúdo é adicionado como um comentário a uma pendência existente ou como uma pendência totalmente nova.
- O assunto de uma mensagem de e-mail é examinado para uma chave de pendência existente:
- Se uma chave de pendência for encontrada no assunto, o conteúdo do corpo da mensagem será processado e adicionado como um comentário à pendência com essa chave de pendência.
- Se uma chave de pendência NÃO for encontrada no assunto, o cabeçalho "em resposta a" será examinado:
- Se for determinado que a mensagem de e-mail é uma resposta a outra mensagem de e-mail da qual uma pendência foi criada anteriormente, o corpo será processado e adicionado como um comentário à pendência.
- Se NÃO for determinado que a mensagem de e-mail é uma resposta, será criada uma nova pendência.
Por exemplo, uma mensagem de e-mail a uma conta de e-mail foo@example-co.com
em um servidor de e-mail POP ou IMAP configurado para um servidor JIRA será processada da seguinte maneira:
- Criação da pendência:
- O assunto da mensagem de e-mail passará a ser o resumo da pendência.
Uma vez que todas as pendências exigem um resumo, cada mensagem de e-mail destinada à criação da pendência: deverá incluir um assunto. - O corpo da mensagem de e-mail será a descrição da pendência.
- Um erro será criado para o projeto "JRA" com as informações acima. (Isso é, essencialmente, baseado na configuração do manipulador de e-mail acima).
- Quaisquer anexos à mensagem de e-mail passarão a ser anexos da pendência (presumindo que anexos tenham sido habilitados no JIRA).
Para garantir a compatibilidade com vários sistemas operacionais, qualquer um dos seguintes caracteres no nome de arquivo será substituído por um caractere de sublinhado: \, /, ", %, :, $, ?, *, <, |, >. - Se o e-mail recebido for definido para uma alta prioridade, a pendência correspondente será criada com uma prioridade mais alta que a prioridade padrão definida no sistema JIRA.
- O assunto da mensagem de e-mail passará a ser o resumo da pendência.
- Criação de comentário:
- O corpo do e-mail passará a ser um comentário sobre a pendência.
Quaisquer anexos ao e-mail passarão a ser anexos da pendência (presumindo que anexos tenham sido habilitados no JIRA).
Dicas práticas com manipuladores de e-mail
Para permitir que o JIRA manipule mensagens de e-mail enviadas de pessoas que não tenham uma conta de usuário do JIRA:
- Crie uma conta de e-mail "anônima"/"fictícia" no seu servidor/serviço de e-mail (acima).
- Crie uma conta de usuário "anônima/fictícia" do JIRA equivalente, cujo campo de e-mail corresponda à conta de e-mail criada na etapa anterior.
- Ao configurar seus manipuladores de e-mail (acima) para manipular mensagens dessa conta de e-mail, defina o Relator padrão para essa conta de usuário "anônima/fictícia" do JIRA.
Práticas recomendadas (pré-processamento de mensagens de e-mail do JIRA)
Para servidores de produção JIRA, recomendamos configurar o seguinte pré-processamento de mensagem de e-mail:
- Uma vez que os manipuladores de e-mail do JIRA removem mensagens de e-mail processadas com sucesso do seu servidor de e-mail, envie seu e-mail a uma pasta de backup para ter disponível um registro dos e-mails processados pelo JIRA.
Se sua pasta de e-mail contiver respostas a notificações de e-mail do JIRA, configure as regras que filtrarão as respostas automáticas e devoluções.
Se você não fizer isso, há uma grande possibilidade de loops de e-mail entre o JIRA e os respondentes automáticos, como notificações de "ausência". O JIRA define um cabeçalho "Precedência:em massa" (a menos que você tenha desabilitado essa opção) e um cabeçalho "Enviado automaticamente" no e-mail de saída, mas alguns respondentes o ignoram.
Não há maneira garantida de detectar se um e-mail é uma devolução ou uma resposta automática. As regras a seguir (no formato procmail) detectarão a maioria das respostas automáticas:^From:.*mailer-daemon@ ^Auto-Submitted:.auto- ^Content-Type:\ multipart/report;\ report-type=delivery-status ^Subject:\ Delivery\ Status\ Notification ^Subject:\ Undeliverable ^Subject: Returned Mail: ^From:\ System\ Administrator ^Precedence:\ auto_reply ^Subject:.*autoreply ^Subject:.*Account\ signup
Mesmo com essas regras, você poderá encontrar respostas automáticas sem nada nos cabeçalhos para distingui-las de um e-mail normal. Nesses casos, você simplesmente precisará atualizar manualmente os filtros para excluir o remetente.
- Configure um filtro para capturar e-mails com anexos muito grandes. O JIRA usa a biblioteca JavaMail padrão para analisar e-mails, e rapidamente fica sem memória em anexos grandes (por exemplo, > 50 MB, dado um heap de 512 MB). Uma vez que o e-mail não manipulado não é excluído, ele será reprocessado (provocando outro OutOfMemoryError) sempre que o serviço de e-mail for executado.
Na prática, esse problema raramente é visto, pois a maioria dos servidores de e-mail é configurada para não aceitar e-mails com anexos muito grandes. A menos que você tenha certeza de que seu servidor de e-mail não enviará um anexo muito grande ao JIRA, é melhor configurar um filtro para evitar que o JIRA encontre algum anexo muito grande. - Configure regras de filtragem de spam para que o JIRA não precise processar (e, possivelmente, criar pendências relacionadas a) spam.
Solucionar problemas
A página Registrar e criar perfil do JIRA tem opções de configuração para envio e recebimento de e-mail. Sempre que você cria um novo manipulador de e-mail (ou edita um existente), conforme acima, um botão de teste fica disponível para que você possa testar a configuração do seu manipulador de e-mail a fim de garantir que ele funcione da maneira esperada. Uma dica útil para depurar problemas relacionados a e-mail no JIRA é definir a propriedade -Dmail.debug=true
na inicialização. Isso fará os detalhes no nível de protocolo das interações de e-mail do JIRA serem registrados no catalina.out
(ou saída padrão).
Problemas comuns
- Se parecer que o JIRA não está criando/enviando e-mails nem criando pendências e comentários de um e-mail, pode ser que sua instância do JIRA esteja sofrendo erros de OutOfMemory. Verifique se há erros de OutOfMemory nos seus arquivos de registro. Se houver erros de OutOfMemory, reinicie o JIRA e investigue os erros.
- Se você perceber que alguns e-mails recebidos simplesmente desaparecem, verifique se você não iniciou uma segunda cópia do JIRA por engano (por exemplo, em um ambiente de preparação) que esteja baixando e excluindo e-mails. Consulte Desabilitar envio/recebimento de e-mail para ver os sinalizadores que você pode definir para evitar o processamento de e-mails.
- Se responder pelo e-mail do servidor SMTP do JIRA da lista de notificações do JIRA, em vez de pela conta POP do manipulador configurado (ou seja, na funcionalidade "Responder a" do Outlook), o projeto precisará ser configurado para adicionar um cabeçalho "responder a" em notificações enviadas. Isso pode ser configurado na visualização do projeto para o projeto em particular na Administração do JIRA.
- Se formatação HTML/Rich Text não estiver sendo processada corretamente pelo JIRA, esse será um comportamento esperado. O manipulador de comentário de e-mail foi desenvolvido para realizar conversão de texto simples.