{"id":22351890,"url":"https://github.com/screwdriver-cd/notifications-email","last_synced_at":"2025-07-14T17:13:35.569Z","repository":{"id":45742739,"uuid":"82986244","full_name":"screwdriver-cd/notifications-email","owner":"screwdriver-cd","description":"Sends email notifications on certain build events.","archived":false,"fork":false,"pushed_at":"2025-02-20T17:44:19.000Z","size":57,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-07-06T13:50:24.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cd.screwdriver.cd/pipelines/787","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/screwdriver-cd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-24T00:53:08.000Z","updated_at":"2025-02-20T17:42:45.000Z","dependencies_parsed_at":"2023-01-22T07:01:25.246Z","dependency_job_id":null,"html_url":"https://github.com/screwdriver-cd/notifications-email","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/screwdriver-cd/notifications-email","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/screwdriver-cd","download_url":"https://codeload.github.com/screwdriver-cd/notifications-email/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-email/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265322978,"owners_count":23746745,"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":[],"created_at":"2024-12-04T12:16:17.383Z","updated_at":"2025-07-14T17:13:35.548Z","avatar_url":"https://github.com/screwdriver-cd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notifications (Email)\n[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]\n\n\u003e Sends email notifications on certain build events.\n\n## Usage\n\n```bash\nnpm install screwdriver-notifications-email\n```\n### Initialization\n\nThe class has a variety of knobs to tweak when interacting with Email Notifications.\n\n| Parameter        | Type  |  Description |\n| :-------------   | :---- | :-------------|\n| config        | Object | Configuration Object |\n| config.host | String | SMTP Host URL |\n| config.port | Number | Port to use when connecting to SMTP |\n| config.from | String | Sender email address |\n| config.username | String | Optional username for SMTP |\n| config.password | String | Optional password for SMTP |\n\nThe interface looks for email-specific build data:\n\n| Parameter        | Type  |  Description |\n| :-------------   | :---- | :-------------|\n| buildData        | Object | Build Data Object |\n| buildData.status | String | Build status update for notification |\n| buildData.settings | Object | Pluggable settings for each build |\n| buildData.settings.email | Object | Email-specific settings |\n| buildData.pipelineName | String | Name of your pipeline |\n| buildData.jobName | String | Job this email is being sent for |\n| buildData.buildId | Number | Build number this email is being sent for |\n| buildData.buildLink | String | Link to build |\n\nbuildData.settings.email can take either:\n\n#### Simple Configuration\n\n```js\nbuildData.settings.email = 'notify.me@email.com'\n```\n\n#### Advanced Configuration\n\n```js\nbuildData.settings.email = {\n    addresses: ['notify.me@email.com', 'notify.you@email.com'], // Multiple recipient addresses\n    statuses: ['SUCCESS', 'FAILURE'] // Build statuses to notify addresses about\n}\n```\n\n## Testing\n\n```bash\nnpm test\n```\n\n## License\n\nCode licensed under the BSD 3-Clause license. See LICENSE file for terms.\n\n[npm-image]: https://img.shields.io/npm/v/screwdriver-notifications-email.svg\n[npm-url]: https://npmjs.org/package/screwdriver-notifications-email\n[downloads-image]: https://img.shields.io/npm/dt/screwdriver-notifications-email.svg\n[license-image]: https://img.shields.io/npm/l/screwdriver-notifications-email.svg\n[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/notifications-email.svg\n[issues-url]: https://github.com/screwdriver-cd/notifications-email/issues\n[status-image]: https://cd.screwdriver.cd/pipelines/787/badge\n[status-url]: https://cd.screwdriver.cd/pipelines/787\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Fnotifications-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrewdriver-cd%2Fnotifications-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Fnotifications-email/lists"}