3.0.2 • Published 2 months ago
screwdriver-notifications-email v3.0.2
Notifications (Email)
Sends email notifications on certain build events.
Usage
npm install screwdriver-notifications-email
Initialization
The class has a variety of knobs to tweak when interacting with Email Notifications.
Parameter | Type | Description |
---|---|---|
config | Object | Configuration Object |
config.host | String | SMTP Host URL |
config.port | Number | Port to use when connecting to SMTP |
config.from | String | Sender email address |
config.username | String | Optional username for SMTP |
config.password | String | Optional password for SMTP |
The interface looks for email-specific build data:
Parameter | Type | Description |
---|---|---|
buildData | Object | Build Data Object |
buildData.status | String | Build status update for notification |
buildData.settings | Object | Pluggable settings for each build |
buildData.settings.email | Object | Email-specific settings |
buildData.pipelineName | String | Name of your pipeline |
buildData.jobName | String | Job this email is being sent for |
buildData.buildId | Number | Build number this email is being sent for |
buildData.buildLink | String | Link to build |
buildData.settings.email can take either:
Simple Configuration
buildData.settings.email = 'notify.me@email.com'
Advanced Configuration
buildData.settings.email = {
addresses: ['notify.me@email.com', 'notify.you@email.com'], // Multiple recipient addresses
statuses: ['SUCCESS', 'FAILURE'] // Build statuses to notify addresses about
}
Testing
npm test
License
Code licensed under the BSD 3-Clause license. See LICENSE file for terms.
3.0.2
2 months ago
3.0.1
9 months ago
3.0.0
1 year ago
2.3.1
2 years ago
2.3.0
2 years ago
2.2.0
3 years ago
2.1.5
3 years ago
2.1.4
3 years ago
2.1.3
3 years ago
2.1.2
3 years ago
2.1.1
3 years ago
2.1.0
4 years ago
2.0.0
4 years ago
1.4.0
4 years ago
1.3.0
4 years ago
1.2.1
4 years ago
1.2.0
4 years ago
1.1.10
5 years ago
1.1.9
6 years ago
1.1.8
6 years ago
1.1.7
6 years ago
1.1.6
6 years ago
1.1.5
6 years ago
1.1.4
6 years ago
1.1.3
6 years ago
1.1.2
7 years ago
1.1.1
7 years ago
1.1.0
7 years ago
1.0.3
7 years ago
1.0.2
7 years ago
1.0.1
7 years ago
1.0.0
7 years ago
0.0.1
7 years ago