AEM as a Cloud Service: problema de entrega de email da API SendGrid ao usar o serviço OSGi personalizado
Este artigo fornece etapas para resolver problemas de envio de email por meio da API SendGrid de um serviço OSGi personalizado no Adobe Experience Manager as a Cloud Service.
Descrição description
Ambiente
Adobe Experience Manager (AEM) as a Cloud Service (todas as versões)
Problema/Sintomas
Tentativas de enviar email usando um serviço OSGi personalizado que se integra à API REST SendGrid (https://api.sendgrid.com/v3/mail/send) não entregam mensagens. O problema ocorre após a implantação do código por meio do Cloud Manager e a execução de um processo de fluxo de trabalho que chama o serviço de email SendGrid.
- Interface de configuração OSGi personalizada criada usando
@ObjectClassDefinition. - Arquivo de configuração adicionado em
/apps/csuf-cloud/osgiconfig/config(Por exemplo:com.csuf.cloud.core.config.SendGridConfiguration.cfg.json). - Chave de API configurada usando um segredo do Cloud Manager (
SENDGRID_API_KEY). from_emaildefinido como um endereço de remetente válido.- O processo de fluxo de trabalho personalizado aciona o serviço de email SendGrid.
- Nenhuma mensagem de erro explícita foi fornecida, mas os emails não são entregues conforme esperado.
Resolução resolution
-
Verificar Uso de Chave de API SendGrid
-
Verifique se o valor da chave de API na configuração do OSGi está definido como o segredo do Cloud Manager que contém a chave de API SendGrid.
-
Ao autenticar com a API SendGrid, sempre use a cadeia de caracteres literal
apikeycomo nome de usuário, independentemente do valor real da chave de API criada no SendGrid. -
Exemplo de configuração:
code language-none "smtp.user": "apikey", "api_key": "<Cloud Manager secret reference>"
-
-
Verificar Implantação da Configuração OSGi
- Confirme se o arquivo de configuração OSGi foi implantado corretamente em
/apps/<project>/osgiconfig/confige foi selecionado pela AEM. - Valide se os valores de configuração (chave de API, email do remetente) estão corretos e não estão vazios.
- Confirme se o arquivo de configuração OSGi foi implantado corretamente em
-
Validar Referência Secreta do Cloud Manager
- Verifique se o segredo do Cloud Manager (
SENDGRID_API_KEY) está referenciado corretamente em sua configuração e disponível no tempo de execução.
- Verifique se o segredo do Cloud Manager (
-
Testar Entrega de Email
- Acione o processo de fluxo de trabalho do ambiente do Autor do AEM e monitore para obter êxito na entrega de emails.
- Verifique nos logs do AEM e do SendGrid se há erros ou solicitações rejeitadas.
Causa
A API SendGrid requer que o nome de usuário seja definido como apikey para autenticação, independentemente do valor real da chave de API. Uma configuração incorreta do nome de usuário ou da chave de API pode impedir o êxito da entrega de emails.