{"id":16430956,"url":"https://github.com/estruyf/playwright-mail-reporter","last_synced_at":"2025-10-26T23:31:47.100Z","repository":{"id":246757883,"uuid":"822612875","full_name":"estruyf/playwright-mail-reporter","owner":"estruyf","description":"Mail reporter for Playwright powered by Resend","archived":false,"fork":false,"pushed_at":"2024-07-18T11:27:06.000Z","size":52,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-19T00:13:37.983Z","etag":null,"topics":["e2e","mail","playwright","reporter","testing"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/playwright-mail-reporter","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/estruyf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-01T13:21:27.000Z","updated_at":"2024-07-24T12:19:53.000Z","dependencies_parsed_at":"2024-07-18T13:15:59.262Z","dependency_job_id":null,"html_url":"https://github.com/estruyf/playwright-mail-reporter","commit_stats":null,"previous_names":["estruyf/playwright-mail-reporter"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fplaywright-mail-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fplaywright-mail-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fplaywright-mail-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/estruyf%2Fplaywright-mail-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/estruyf","download_url":"https://codeload.github.com/estruyf/playwright-mail-reporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219862083,"owners_count":16555980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["e2e","mail","playwright","reporter","testing"],"created_at":"2024-10-11T08:28:49.893Z","updated_at":"2025-10-26T23:31:47.092Z","avatar_url":"https://github.com/estruyf.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mail Reporter for Playwright\n\n[![npm version](https://badge.fury.io/js/playwright-mail-reporter.svg)](https://badge.fury.io/js/playwright-mail-reporter)\n[![Downloads](https://img.shields.io/npm/dt/playwright-mail-reporter)](https://www.npmjs.com/package/playwright-mail-reporter)\n![License](https://img.shields.io/github/license/estruyf/playwright-mail-reporter)\n\nThis reporter allows you to send an email with the test results after the test run is finished.\n\n## Prerequisites\n\nTo use this reporter, you will need to have the SMTP server details to send out the emails. Make sure you have the following details:\n\n- Host\n- Port\n- Username\n- Password\n\n## Installation\n\nInstall from npm:\n\n```bash\nnpm install playwright-mail-reporter\n```\n\n## Usage\n\nYou can configure the reporter by adding it to the `playwright.config.js` file:\n\n```javascript\nimport { defineConfig } from \"@playwright/test\";\n\nexport default defineConfig({\n  reporter: [\n    [\n      \"playwright-mail-reporter\",\n      {\n        host: \"\u003chost\u003e\",\n        port: \"\u003cport\u003e\",\n        secure: \"\u003cboolean\u003e\", // Optional, defaults to true\n        username: \"\u003cusername\u003e\",\n        password: \"\u003cpassword\u003e\",\n        from: \"\u003cfrom\u003e\",\n        to: \"\u003cto\u003e\", // Comma separated list of email addresses\n        subject: \"\u003csubject\u003e\",\n        apiKey: \"\u003capi\u003e\",\n      },\n    ],\n  ],\n});\n```\n\nHere is an example of how you can configure the reporter with Resend:\n\n```javascript\nimport { defineConfig } from \"@playwright/test\";\n\nexport default defineConfig({\n  reporter: [\n    [\n      \"playwright-mail-reporter\",\n      {\n        host: \"smtp.resend.com\",\n        port: 465,\n        username: \"resend\",\n        password: `\u003cYOUR_API_KEY\u003e`,\n        from: \"Elio \u003cno-reply@elio.dev\u003e\",\n        to: \"Elio \u003celio@struyfconsulting.be\u003e\",\n      },\n    ],\n  ],\n});\n```\n\n\u003e More information on how to use reporters can be found in the [Playwright documentation](https://playwright.dev/docs/test-reporters).\n\n## Configuration\n\nThe reporter supports the following configuration options:\n\n| Option          | Description                                                           | Required | Default                   |\n| --------------- | --------------------------------------------------------------------- | -------- | ------------------------- |\n| `host`          | The SMTP server host                                                  | `true`   | `undefined`               |\n| `port`          | The SMTP server port                                                  | `true`   | `undefined`               |\n| `username`      | The SMTP server username                                              | `true`   | `undefined`               |\n| `password`      | The SMTP server password                                              | `true`   | `undefined`               |\n| `from`          | The email address from which the email will be sent                   | `true`   | `undefined`               |\n| `to`            | The email addresses to which the email will be sent (comma separated) | `true`   | `undefined`               |\n| `subject`       | The subject of the email                                              | `false`  | `Playwright Test Results` |\n| `linkToResults` | Link to the test results                                              | `false`  | `undefined`               |\n| `mailOnSuccess` | Send the email on success                                             | `false`  | `true`                    |\n| `showError`     | Show the error details in the email                                   | `false`  | `false`                   |\n| `quiet`         | Do not show any output in the console                                 | `false`  | `false`                   |\n\n\u003cbr /\u003e\n\n[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-mail-reporter\u0026countColor=%23263759)](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-mail-reporter)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Festruyf%2Fplaywright-mail-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Festruyf%2Fplaywright-mail-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Festruyf%2Fplaywright-mail-reporter/lists"}