Send alerts to email - kunalnagarco/action-cve GitHub Wiki

Intro

This action uses the Nodemailer package to send emails. Two transports are supported:

• AWS SES — recommended for production use
• SMTP — for any SMTP-compatible mail server

SES is used when email_transport_ses_region, email_transport_ses_access_key_id, and email_transport_ses_secret_access_key are all provided. If only SMTP credentials are provided, SMTP is used instead.

Usage

Note: Please make sure to add these variables as Repository Secrets so as to not leak sensitive information in action logs.

AWS SES Transport

- uses: kunalnagarco/[email protected]
  with:
    token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
    email_from: [email protected]
    email_list: [email protected],[email protected]
    email_transport_ses_region: ${{ secrets.AWS_SES_REGION }}
    email_transport_ses_access_key_id: ${{ secrets.AWS_SES_ACCESS_KEY_ID }}
    email_transport_ses_secret_access_key: ${{ secrets.AWS_SES_SECRET_ACCESS_KEY }}

Input	Description
email_transport_ses_region	AWS SES region e.g. us-east-1
email_transport_ses_access_key_id	AWS SES Access Key ID
email_transport_ses_secret_access_key	AWS SES Secret Access Key

SMTP Transport

- uses: kunalnagarco/[email protected]
  with:
    token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
    email_from: [email protected]
    email_list: [email protected],[email protected]
    email_transport_smtp_host: smtp.gmail.com
    email_transport_smtp_port: 587
    email_transport_smtp_user: ${{ secrets.SMTP_USER }}
    email_transport_smtp_password: ${{ secrets.SMTP_PASSWORD }}

Input	Description	Default
email_transport_smtp_host	SMTP host	smtp.gmail.com
email_transport_smtp_port	SMTP port (587 for TLS, 465 for STARTTLS)	587
email_transport_smtp_user	SMTP Username	—
email_transport_smtp_password	SMTP Password	—

Email previews

Here are a few screenshots of the email in different clients.

Gmail

Outlook

Apple Mail