https://github.com/estruyf/playwright-mail-reporter
Mail reporter for Playwright powered by Resend
https://github.com/estruyf/playwright-mail-reporter
e2e mail playwright reporter testing
Last synced: 8 months ago
JSON representation
Mail reporter for Playwright powered by Resend
- Host: GitHub
- URL: https://github.com/estruyf/playwright-mail-reporter
- Owner: estruyf
- License: mit
- Created: 2024-07-01T13:21:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T11:27:06.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T00:13:37.983Z (almost 2 years ago)
- Topics: e2e, mail, playwright, reporter, testing
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/playwright-mail-reporter
- Size: 50.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mail Reporter for Playwright
[](https://badge.fury.io/js/playwright-mail-reporter)
[](https://www.npmjs.com/package/playwright-mail-reporter)
This reporter allows you to send an email with the test results after the test run is finished.
## Prerequisites
To use this reporter, you will need to have the SMTP server details to send out the emails. Make sure you have the following details:
- Host
- Port
- Username
- Password
## Installation
Install from npm:
```bash
npm install playwright-mail-reporter
```
## Usage
You can configure the reporter by adding it to the `playwright.config.js` file:
```javascript
import { defineConfig } from "@playwright/test";
export default defineConfig({
reporter: [
[
"playwright-mail-reporter",
{
host: "",
port: "",
secure: "", // Optional, defaults to true
username: "",
password: "",
from: "",
to: "", // Comma separated list of email addresses
subject: "",
apiKey: "",
},
],
],
});
```
Here is an example of how you can configure the reporter with Resend:
```javascript
import { defineConfig } from "@playwright/test";
export default defineConfig({
reporter: [
[
"playwright-mail-reporter",
{
host: "smtp.resend.com",
port: 465,
username: "resend",
password: ``,
from: "Elio ",
to: "Elio ",
},
],
],
});
```
> More information on how to use reporters can be found in the [Playwright documentation](https://playwright.dev/docs/test-reporters).
## Configuration
The reporter supports the following configuration options:
| Option | Description | Required | Default |
| --------------- | --------------------------------------------------------------------- | -------- | ------------------------- |
| `host` | The SMTP server host | `true` | `undefined` |
| `port` | The SMTP server port | `true` | `undefined` |
| `username` | The SMTP server username | `true` | `undefined` |
| `password` | The SMTP server password | `true` | `undefined` |
| `from` | The email address from which the email will be sent | `true` | `undefined` |
| `to` | The email addresses to which the email will be sent (comma separated) | `true` | `undefined` |
| `subject` | The subject of the email | `false` | `Playwright Test Results` |
| `linkToResults` | Link to the test results | `false` | `undefined` |
| `mailOnSuccess` | Send the email on success | `false` | `true` |
| `showError` | Show the error details in the email | `false` | `false` |
| `quiet` | Do not show any output in the console | `false` | `false` |
[](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-mail-reporter)