Send emails with GitHub Actions

Published: November 2, 2020 , Updated: January 6, 2023

Talks about: <a class="post-tag post-tag-email" href="/tags/email">email</a>, <a class="post-tag post-tag-github" href="/tags/github">github</a>, and <a class="post-tag post-tag-github-actions" href="/tags/github-actions">github actions</a>

The dawidd6/action-send-mail action allows to send an email in your GitHub Action.

name: <PIPELINE>
jobs:
  build:
    runs-on: <RUN_ON>
    steps:
      - name: Send mail
        uses: dawidd6/action-send-mail@v3
        with:
          server_address: ${{ secrets.MAIL_SERVER }}
          server_port: ${{ secrets.MAIL_PORT }}
          username: ${{ secrets.MAIL_USERNAME }}
          password: ${{ secrets.MAIL_PASSWORD }}
          subject: <SUBJECT>
          body: <BODY>
          to: ${{ secrets.MAIL_RECIPIENT }}
          from: ${{ secrets.MAIL_SENDER }}

<PIPELINE>: The name of your pipeline.
<RUN_ON>: The runner to use, see GitHub’s own documentation for possible values.
<SUBJECT>: Subject for the email.
<BODY>: Body for the email.

Create appropriate secrets in your organization or project. In case you are using an organization, but different mailing lists, define MAIL_RECIPIENT for each project.