You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "joserocha (via GitHub)" <gi...@apache.org> on 2025/10/10 02:23:45 UTC
[D] Ability to send HTML-formatted reports by email [superset]
GitHub user joserocha created a discussion: Ability to send HTML-formatted reports by email
I'm migrating all my reports from Microsoft Reporting Services to Superset, and one of the features I'm missing is the ability to send reports by email in HTML format. Is there any way to accomplish that?
GitHub link: https://github.com/apache/superset/discussions/35593
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
GitHub user dosubot[bot] edited a comment on the discussion: Ability to send HTML-formatted reports by email
<!-- Greeting -->
Hi @joserocha! I'm [Dosu](https://go.dosu.dev/dosubot) and I’m helping the superset team.
<!-- Answer -->
Superset supports sending scheduled reports and alerts by email in HTML format using its built-in Alerts & Reports feature. You can configure reports to be sent with rich HTML content, including formatted tables, links, and embedded images. To use this, enable the `ALERT_REPORTS` feature flag in your configuration, set up SMTP email settings, and ensure a headless browser (like Chrome with Playwright or Firefox) is installed in your worker container for screenshot capture. The report scheduling UI lets you choose the report format (text embedded in email, PNG image, or CSV attachment), customize recipients, and set the email subject and body. No extra plugins are needed—this is all supported natively. For more details, see the implementation in the [email notification system](https://github.com/apache/superset/blob/master/superset/reports/notifications/email.py) and [report modal UI](https://github.com/apache/superset/blob/master/superset-frontend/src/features/reports/ReportModal/i
ndex.tsx).
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=reply-with-mention&utm_term=apache%2Fsuperset).*
---
Docs are dead. Just use [Dosu](https://dosu.dev?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-tagline&utm_term=apache%2Fsuperset).
[](https://app.dosu.dev/response-feedback?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-feedback&utm_term=apache%2Fsuperset&message_id=e20952fa-106a-4b09-adca-58ab3d50d6eb) [](https://github.dosu.com/apache/superset?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-ask-repo&utm_term=apache%2Fsuperset) [](https://app.dosu.dev/signup?referrer=openSource&source=github-footer&utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-share-team&utm_term=apache%2Fsuperset)
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14642593
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
GitHub user dosubot[bot] edited a comment on the discussion: Ability to send HTML-formatted reports by email
<!-- Answer -->
Superset can send HTML-formatted emails with rich content like tables, links, and inline images, and you can configure reports to be delivered "inline" (embedded in the email body) rather than as attachments. However, for dashboards, Superset does not embed the full interactive dashboard as HTML in the email body. Instead, it sends a screenshot of the dashboard (as an inline image) or a table of data, not the actual dashboard layout or widgets as HTML. This is due to how Superset's Alerts & Reports feature is implemented, relying on a headless browser to capture and send static images of dashboards rather than rendering the dashboard's HTML structure in the email body [reference](https://github.com/apache/superset/pull/34908).
If you want to include formatted tables or descriptions, those will appear as HTML in the email body, but the dashboard itself will not be interactive or fully rendered as HTML. There is currently no built-in support for sending the actual dashboard HTML structure directly in the email body [reference](https://github.com/apache/superset/blob/master/superset/reports/notifications/email.py).
If you need more technical details or want to explore custom solutions, let me know!
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=reply-with-mention&utm_term=apache%2Fsuperset).*
---
Docs are dead. Just use [Dosu](https://dosu.dev?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-tagline&utm_term=apache%2Fsuperset).
[](https://app.dosu.dev/response-feedback?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-feedback&utm_term=apache%2Fsuperset&message_id=bb68aebd-9b05-4e79-ac29-32d908ffa575) [](https://github.dosu.com/apache/superset?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-ask-repo&utm_term=apache%2Fsuperset) [](https://app.dosu.dev/signup?referrer=openSource&source=github-footer&utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=static-docs-share-team&utm_term=apache%2Fsuperset)
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14642948
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
GitHub user dosubot[bot] added a comment to the discussion: Ability to send HTML-formatted reports by email
<!-- Greeting -->
Hi @joserocha! I'm [Dosu](https://go.dosu.dev/dosubot) and I’m helping the superset team.
<!-- Answer -->
Superset supports sending scheduled reports and alerts by email in HTML format using its built-in Alerts & Reports feature. You can configure reports to be sent with rich HTML content, including formatted tables, links, and embedded images. To use this, enable the `ALERT_REPORTS` feature flag in your configuration, set up SMTP email settings, and ensure a headless browser (like Chrome with Playwright or Firefox) is installed in your worker container for screenshot capture. The report scheduling UI lets you choose the report format (text embedded in email, PNG image, or CSV attachment), customize recipients, and set the email subject and body. No extra plugins are needed—this is all supported natively. For more details, see the implementation in the [email notification system](https://github.com/apache/superset/blob/master/superset/reports/notifications/email.py) and [report modal UI](https://github.com/apache/superset/blob/master/superset-frontend/src/features/reports/ReportModal/i
ndex.tsx).
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot).*
---
<sup>How did I do? [Good](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/e20952fa-106a-4b09-adca-58ab3d50d6eb?feedback_type=other)</sup> [](https://app.dosu.dev/a28d3c7e-a9d3-459e-9fb6-3a6f9ff4f357/ask?utm_source=github)&
nbsp;[](https://go.dosu.dev/discord-bot) [](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/superset/discussions/35593)
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14642593
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "joserocha (via GitHub)" <gi...@apache.org>.
GitHub user joserocha added a comment to the discussion: Ability to send HTML-formatted reports by email
@dosu
I don’t want any attachments. I’d like to see the dashboard content displayed directly in the email, built in HTML.
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14642941
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
GitHub user dosubot[bot] edited a comment on the discussion: Ability to send HTML-formatted reports by email
<!-- Answer -->
Superset's ability to send HTML-formatted emails with rich content (tables, links, inline images) is implemented in the codebase, not documented officially. The main logic lives in [`superset/reports/notifications/email.py`](https://github.com/apache/superset/blob/master/superset/reports/notifications/email.py), where the `EmailNotification` class builds the HTML email body, sanitizes and embeds tables, and references inline images by content ID. The actual sending is handled by [`send_email_smtp`](https://github.com/apache/superset/blob/master/superset/utils/core.py), which attaches the HTML content as the email body and supports inline images.
Unit tests in [`tests/unit_tests/reports/notifications/email_tests.py`](https://github.com/apache/superset/blob/master/tests/unit_tests/reports/notifications/email_tests.py) confirm that HTML tags in report descriptions and embedded tables are preserved and rendered in the email body.
The feature was enhanced in [PR #30576](https://github.com/apache/superset/pull/30576), which improved HTML formatting, including embedding links and formatting in error emails and report bodies.
There is no official documentation page for this feature, but the code and tests above show how Superset sends HTML emails with rich content.
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=reply-with-mention&utm_term=apache%2Fsuperset).*
---
Share context across your team and agents. Try [Dosu](https://dosu.dev?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=knowledge-infrastructure-tagline&utm_term=apache%2Fsuperset).
[](https://app.dosu.dev/response-feedback?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=knowledge-infrastructure-feedback&utm_term=apache%2Fsuperset&message_id=01ac5df0-cb37-40bb-b4b0-0862fafbfb64) [](https://github.dosu.com/apache/superset?utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=knowledge-infrastructure-learn-repo&utm_term=apache%2Fsuperset) [](https://app.dosu.dev/signup?referrer=openSource&source=github-footer&utm_source=github&utm_medium=bot-comment&utm_campaign=github-comment-footer-20260415&utm_content=knowledge-infrastructure-add-team&utm_term=apache%2Fsuperset)
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14677894
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
GitHub user sfirke added a comment to the discussion: Ability to send HTML-formatted reports by email
I think this is an interesting idea. I have users who would migrate from SQL Server Reporting Services with related needs. Apache Airflow makes it possible to customize the HTML in emails without having to modify the codebase ... then again, users interact with it by writing code.
Can you say more - would this be admins or users creating HTML templates so that instead of a barebones email from Superset with an Alert or Report, it would be a nicely-formatted email with the same content? Or is this something more expansive?
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14649587
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "joserocha (via GitHub)" <gi...@apache.org>.
GitHub user joserocha added a comment to the discussion: Ability to send HTML-formatted reports by email
I have exactly this need. I’m migrating reports from Microsoft Reporting Services, and some of them include data directly in the body of the email. I have a static template, and within this template, I have, for example, a table showing what I want the user to see.
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14668044
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
GitHub user dosubot[bot] added a comment to the discussion: Ability to send HTML-formatted reports by email
<!-- Answer -->
Superset can send HTML-formatted emails with rich content like tables, links, and inline images, and you can configure reports to be delivered "inline" (embedded in the email body) rather than as attachments. However, for dashboards, Superset does not embed the full interactive dashboard as HTML in the email body. Instead, it sends a screenshot of the dashboard (as an inline image) or a table of data, not the actual dashboard layout or widgets as HTML. This is due to how Superset's Alerts & Reports feature is implemented, relying on a headless browser to capture and send static images of dashboards rather than rendering the dashboard's HTML structure in the email body [reference](https://github.com/apache/superset/pull/34908).
If you want to include formatted tables or descriptions, those will appear as HTML in the email body, but the dashboard itself will not be interactive or fully rendered as HTML. There is currently no built-in support for sending the actual dashboard HTML structure directly in the email body [reference](https://github.com/apache/superset/blob/master/superset/reports/notifications/email.py).
If you need more technical details or want to explore custom solutions, let me know!
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot).*
---
<sup>How did I do? [Good](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/bb68aebd-9b05-4e79-ac29-32d908ffa575?feedback_type=other)</sup> [](https://app.dosu.dev/a28d3c7e-a9d3-459e-9fb6-3a6f9ff4f357/ask?utm_source=github)&
nbsp;[](https://go.dosu.dev/discord-bot) [](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/superset/discussions/35593)
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14642948
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
GitHub user dosubot[bot] added a comment to the discussion: Ability to send HTML-formatted reports by email
<!-- Answer -->
Superset's ability to send HTML-formatted emails with rich content (tables, links, inline images) is implemented in the codebase, not documented officially. The main logic lives in [`superset/reports/notifications/email.py`](https://github.com/apache/superset/blob/master/superset/reports/notifications/email.py), where the `EmailNotification` class builds the HTML email body, sanitizes and embeds tables, and references inline images by content ID. The actual sending is handled by [`send_email_smtp`](https://github.com/apache/superset/blob/master/superset/utils/core.py), which attaches the HTML content as the email body and supports inline images.
Unit tests in [`tests/unit_tests/reports/notifications/email_tests.py`](https://github.com/apache/superset/blob/master/tests/unit_tests/reports/notifications/email_tests.py) confirm that HTML tags in report descriptions and embedded tables are preserved and rendered in the email body.
The feature was enhanced in [PR #30576](https://github.com/apache/superset/pull/30576), which improved HTML formatting, including embedding links and formatting in error emails and report bodies.
There is no official documentation page for this feature, but the code and tests above show how Superset sends HTML emails with rich content.
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot).*
---
<sup>How did I do? [Good](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/01ac5df0-cb37-40bb-b4b0-0862fafbfb64?feedback_type=other)</sup> [](https://app.dosu.dev/a28d3c7e-a9d3-459e-9fb6-3a6f9ff4f357/ask?utm_source=github)&
nbsp;[](https://go.dosu.dev/discord-bot) [](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/superset/discussions/35593)
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14677894
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [D] Ability to send HTML-formatted reports by email [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
GitHub user sfirke added a comment to the discussion: Ability to send HTML-formatted reports by email
@dosu when you say "Superset can send HTML-formatted emails with rich content like tables, links, and inline images," can you please provide a reference to documentation, a pull request that introduced this functionality, or where in the codebase I would find this?
GitHub link: https://github.com/apache/superset/discussions/35593#discussioncomment-14677836
----
This is an automatically sent email for notifications@superset.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@superset.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org