Added support for sending transactional messages to external email addresses #2454
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…to external recipients
feat: add /api/tx/external endpoint for sending transactional emails to external recipients
…either subscriber_emails or subscriber_email, and convert subscriber_email to subscriber_emails if provided
…alidation and update documentation
…cessing logic into SendExternalTxMessage function
…xMessage function, with validation for Messenger
Facecube
reviewed
May 10, 2025
| | recipient_email | string | | Email of the recipient. Can substitute with `recipient_emails`. | | ||
| | recipient_emails | string\[\] | | Multiple recipient emails as alternative to `recipient_email`. | | ||
| | template_id | number | Yes | ID of the transactional template to be used for the message. | | ||
| | subject | string | Yes | Subject of the email. | |
There was a problem hiding this comment.
Just had a quick look to see how the API has changed, compared to my old reference implementation #1754.
I am a bit sceptical on the mandatory subject, because this diverges from the existing ecosystem quite a bit.
I have not fully checked out the code changes, but I assume you made that decision to guarantee a smoother integration of the new API?
Lets see what @knadh thinks.
There was a problem hiding this comment.
I’ve updated the documentation to reflect the recent changes. Apologies for the earlier oversight.
|
Please unsubscribe me. Thx--____________________________Joe Saladino ***@***.*** (From my iPhone)+1(208) 971-7570“You never realize Jesus is all you needuntil Jesus is all you have.”--Timothy Keller (The Prodigal Prophet)Joe's ProfileOn May 10, 2025, at 12:45 PM, Facecube ***@***.***> wrote:
@Facecube commented on this pull request.
In docs/docs/content/apis/transactional.md:
-```json
-{
- "data": true
-}
+| Name | Type | Required | Description |
+|:------------------|:----------|:---------|:---------------------------------------------------------------------------|
+| recipient_email | string | | Email of the recipient. Can substitute with `recipient_emails`. |
+| recipient_emails | string\[\] | | Multiple recipient emails as alternative to `recipient_email`. |
+| template_id | number | Yes | ID of the transactional template to be used for the message. |
+| subject | string | Yes | Subject of the email. |
Just had a quick look to see how the API has changed, compared to my old reference implementation #1754.
I am a bit sceptical on the mandatory subject, because this diverges from the existing ecosystem quite a bit.
I have not fully checked out the code changes, but I assume you made that decision to guarantee a smoother integration of the new API?
Lets see what @knadh thinks.
—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>
[
{
***@***.***": "http://schema.org",
***@***.***": "EmailMessage",
"potentialAction": {
***@***.***": "ViewAction",
"target": "#2454 (review)",
"url": "#2454 (review)",
"name": "View Pull Request"
},
"description": "View this Pull Request on GitHub",
"publisher": {
***@***.***": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
}
]
|
|
This PR has been marked 'stale' after 90 days of inactivity. If there is no further activity, it will be closed in 7 days. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces functionality for sending transactional messages to external email addresses, along with corresponding API documentation updates. The most significant changes include adding a new endpoint, implementing the handler logic, and updating the Swagger documentation to reflect the new functionality.
New feature: Sending transactional messages to external email addresses
/api/tx/externalto handle sending transactional messages to external email addresses. This endpoint uses theSendExternalTxMessagehandler. (cmd/handlers.go, cmd/handlers.goR183)SendExternalTxMessageincmd/tx.go. This handler processes multipart form data for file attachments, validates the message fields, renders the message using a template, and sends it via the configured messenger. (cmd/tx.go, cmd/tx.goR205-R346)API documentation updates
/tx/externalendpoint in the Swagger file, including its description, request body schema, and expected responses. (docs/swagger/collections.yaml, docs/swagger/collections.yamlR1936-R1958)ExternalTransactionalMessageschema to the Swagger file, defining the required fields and optional properties for the new endpoint. (docs/swagger/collections.yaml, docs/swagger/collections.yamlR4105-R4137)/txendpoint in the Swagger file to better align with its purpose. (docs/swagger/collections.yaml, docs/swagger/collections.yamlR1915-L1918)