AEM as a Cloud Service: problema di consegna e-mail dell’API SendGrid quando si utilizza il servizio OSGi personalizzato

Questo articolo descrive come risolvere i problemi relativi all’invio di e-mail tramite l’API SendGrid da un servizio OSGi personalizzato in Adobe Experience Manager as a Cloud Service.

Descrizione description

Ambiente

Adobe Experience Manager (AEM) as a Cloud Service (tutte le versioni)
Problema/Sintomi

I tentativi di invio di e-mail tramite un servizio OSGi personalizzato integrato con l’API REST SendGrid (https://api.sendgrid.com/v3/mail/send) non riescono a recapitare i messaggi. Il problema si verifica dopo la distribuzione del codice tramite Cloud Manager e l’esecuzione di un processo del flusso di lavoro che richiama il servizio e-mail SendGrid.

  • Interfaccia di configurazione OSGi personalizzata creata con @ObjectClassDefinition.
  • File di configurazione aggiunto in /apps/csuf-cloud/osgiconfig/config (ad esempio: com.csuf.cloud.core.config.SendGridConfiguration.cfg.json).
  • Chiave API configurata utilizzando un segreto Cloud Manager (SENDGRID_API_KEY).
  • from_email impostato su un indirizzo mittente valido.
  • Il processo di flusso di lavoro personalizzato attiva il servizio e-mail SendGrid.
  • Non è stato fornito alcun messaggio di errore esplicito, ma le e-mail non vengono consegnate come previsto.

Risoluzione resolution

  1. Verifica utilizzo chiave API SendGrid

    • Assicurati che il valore della chiave API nella configurazione OSGi sia impostato sul segreto Cloud Manager contenente la chiave API SendGrid.

    • Durante l’autenticazione con l’API SendGrid, utilizza sempre la stringa letterale apikey come nome utente, indipendentemente dal valore effettivo della chiave API creato in SendGrid.

    • Esempio di configurazione:

      code language-none
      "smtp.user": "apikey",
      "api_key": "<Cloud Manager secret reference>"
      
  2. Verifica distribuzione configurazione OSGi

    • Verificare che il file di configurazione OSGi sia correttamente distribuito in /apps/<project>/osgiconfig/config e sia selezionato da AEM.
    • Verifica che i valori di configurazione (chiave API, e-mail del mittente) siano corretti e non vuoti.
  3. Convalida riferimento segreto Cloud Manager

    • Verificare che nella configurazione sia presente un riferimento corretto al segreto di Cloud Manager (SENDGRID_API_KEY) e che sia disponibile in fase di esecuzione.
  4. Verifica consegna e-mail

    • Attiva il processo di flusso di lavoro dall’ambiente di authoring di AEM e monitora la corretta consegna delle e-mail.
    • Controlla i registri di AEM e SendGrid per individuare eventuali errori o richieste rifiutate.

Causa

L’API SendGrid richiede che il nome utente sia impostato come apikey per l’autenticazione, indipendentemente dal valore effettivo della chiave API. Una configurazione errata del nome utente o della chiave API può impedire il corretto recapito delle e-mail.

recommendation-more-help
experience-cloud-kcs-help-kbarticles