Ho pensato di condividere la configurazione che ho trovato per utilizzare AWS SES per le email in uscita, i bounce e quelle in entrata. Ci sono sicuramente delle sfumature nel servizio SES, e ci è voluto un bel po’ di tentativi ed errori per capire esattamente come funziona. Questo è più uno sfogo che una guida passo passo. Dovrebbe essere superfluo, ma usalo a tuo rischio e pericolo. E, per carità, leggi e comprendi sempre qualsiasi codice scritto da altri che implementi.
Contesto:
Sto lavorando per distribuire Discourse in AWS e utilizzare tutti i servizi possibili per garantire affidabilità e ridondanza. Come sviluppatore, sono più a mio agio con la riga di comando e il codice, e volevo usare IaC automation. Tutto il mio ambiente viene distribuito con Terraform, ma ho cercato di fare clic attraverso la console web e allineare le cose al meglio delle mie capacità. IAM e i documenti delle policy sono al di fuori dello scopo di questo, ma credo di aver indicato dove sono necessarie le cose.
Gestire un’istanza Postfix sembra eccessivo per una singola applicazione. Usare una casella di posta POP3 è così anni '90. Quindi mi sono tuffato nel buco del coniglio di AWS.
Ho trovato alcuni post estremamente utili che hanno aiutato la mia ricerca:
- AWS SES / AWS Lambda mail receiver endpoint code?
- How to use Amazon SES for sending emails to users?
- Configure VERP to handle bouncing e-mails
Il container mail-receiver mi ha anche aiutato a capire come Discourse elabora i messaggi:
- Configure direct-delivery incoming email for self-hosted sites with Mail-Receiver
- Update mail-receiver to the release version
Inizialmente mi aspettavo che l’endpoint webhook di AWS gestisse i messaggi in arrivo, ma dopo aver esaminato il codice ho capito che non lo avrebbe fatto. Ho basato il mio codice di ricezione lambda sull’eccellente esempio di @dltj. Ho scelto di utilizzare SNS per la consegna dei messaggi invece di S3.
Prerequisiti
- Account AWS
- Conoscenza pratica del DNS e dei tipi di record relativi alle email
- Un dominio (o sottodominio) in cui è possibile apportare modifiche
Note
- Tutto ciò che è documentato deve essere creato nella stessa regione AWS
- Il testo in grassetto corsivo come questo sono i tuoi valori specifici di implementazione
- Il testo in corsivo sono nomi di variabili, valori fissi o elementi dell’interfaccia utente
Passaggi
-
Crea un’identità di dominio Simple Email Service (SES), tuo.dominio, in una delle regioni AWS che supportano la ricezione di email
-
Verifica l’identità del dominio
-
Crea un argomento Simple Notification Service (SNS), feedback-sns-topic, per le notifiche di feedback
-
Configura l’identità del dominio tuo.dominio
a. Abilita l’inoltro del feedback email
b. Configura le notifiche di feedback di bounce e reclamo (non di consegna) per utilizzare l’argomento SNS feedback-sns-topic -
Crea una sottoscrizione sull’argomento SNS feedback-sns-topic
a. Il protocollo è HTTPS (non stai ancora usando HTTP, vero?)
b. Imposta l’endpoint su https://tuo.dominio/webhooks/aws (vedi post VERP)
c. Seleziona abilita la consegna del messaggio grezzo -
Crea un altro argomento SNS, incoming-sns-topic, per le email in arrivo
-
Crea un set di regole di ricezione email SES, inbound-mail-set, se non ne esiste già uno attivo. In caso affermativo, usalo poiché può esserci un solo set di regole attivo
-
Crea una regola di ricezione nel set di regole di ricezione inbound-mail-set
a. Imposta la condizione del destinatario su tuo.dominio
b. Aggiungi l’azione per pubblicare sull’argomento SNS incoming-sns-topic, codificando Base64 -
Crea una chiave API nella tua istanza Discourse per l’utente system, concedendo l’azione receive email sulla risorsa email
-
Crea un segreto in Secret Manager, email-handler-secret, con le seguenti chiavi e i rispettivi valori:
- api_endpoint - https://tuo.dominio/admin/email/handle_mail
- api_key - dal passaggio 9
- api_username - system, a meno che tu non ne abbia usato uno diverso nel passaggio 9
-
Crea un layer Lambda, lambda-receiver-layer, per il runtime python3.10 contenente le librerie requests e aws-lambda-powertools
-
Crea una funzione lambda, email-receiver-lambda, per il runtime python3.10 con il codice del ricevitore:
# Copyright (c) 2023 Derek J. Lambert
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import json
import os
from typing import TypedDict
import requests
from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities import parameters
from aws_lambda_powertools.utilities.data_classes import event_source
from aws_lambda_powertools.utilities.data_classes.sns_event import SNSEvent, SNSEventRecord
from aws_lambda_powertools.utilities.typing import LambdaContext
class Secret(TypedDict):
api_endpoint: str
api_username: str
api_key: str
service = os.getenv('AWS_LAMBDA_FUNCTION_NAME')
logger = Logger(log_uncaught_exceptions=True, service=service)
try:
SECRET_NAME = os.environ['SECRET_NAME']
except KeyError as e:
raise RuntimeError(f'Missing {e} environment variable')
AWS_EXTENSION_PORT = os.getenv('PARAMETERS_SECRETS_EXTENSION_HTTP_PORT', 2773)
EXTENSION_ENDPOINT = f'http://localhost:{AWS_EXTENSION_PORT}/secretsmanager/get?secretId={SECRET_NAME}'
def get_secret() -> Secret:
return parameters.get_secret(SECRET_NAME, transform='json')
def handle_record(record: SNSEventRecord):
sns = record.sns
sns_message = json.loads(sns.message)
try:
message_type = sns_message['notificationType']
message_mail = sns_message['mail']
message_content = sns_message['content']
message_receipt = sns_message['receipt']
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from message')
try:
receipt_action = message_receipt['action']
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from receipt')
try:
action_encoding = receipt_action['encoding']
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from action')
try:
mail_source = message_mail['source']
mail_destination = ','.join(message_mail['destination'])
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from mail')
logger.info(f'Processing SNS {message_type} {sns.get_type} record with MessageId {sns.message_id} from {mail_source} to {mail_destination}')
# 'email' is deprecated, but just in case something is configured incorrectly
body_key = 'email_encoded' if action_encoding == 'BASE64' else 'email'
request_body = {
body_key: message_content
}
secret = get_secret()
headers = {
'Api-Username': secret['api_username'],
'Api-Key': secret['api_key'],
}
response = requests.post(url=secret['api_endpoint'], headers=headers, json=request_body)
logger.info(response.text)
response.raise_for_status()
@event_source(data_class=SNSEvent)
@logger.inject_lambda_context
def lambda_handler(event: SNSEvent, context: LambdaContext):
for record in event.records:
handle_record(record)
-
Configura la funzione lambda email-receiver-lambda:
a. Aggiungi il layer lambda-receiver-layer
b. Aggiungi il layer specifico della regione per AWS Parameter Store
c. Aggiungi la variabile d’ambiente SECRET_NAME con il valore email-handler-secret
d. Se desideri dettagli aggiuntivi registrati, aggiungi la variabile d’ambiente POWERTOOLS_LOGGER_LOG_EVENT con valore true -
Concedi alla funzione lambda email-receiver-lambda il permesso IAM secretsmanager:GetSecretValue per il segreto email-handler-secret
-
Crea una sottoscrizione sull’argomento SNS incoming-sns-topic
a. Il protocollo è AWS Lambda
b. Imposta l’endpoint sull’ARN di email-receiver-lambda -
Saranno necessari permessi IAM per la sottoscrizione SNS sull’argomento incoming-sns-topic per invocare email-receiver-lambda, ma credo che questo verrà fatto automaticamente quando configurato tramite la console
A scopo di debug, o per auto-fastidio generale, puoi aggiungere una sottoscrizione email a uno dei due argomenti SNS per monitorare le notifiche.
Ho messo giù questo in un paio di sessioni, ma credo sia tutto. Posso provare a rispondere a domande generali quando il tempo lo permette.
