send-mail/README.md

Send mail Github Action

An action that simply sends a mail to multiple recipients.

Usage

- name: Send mail
  uses: dawidd6/action-send-mail@v2
  with:
    server_address: smtp.gmail.com
    server_port: 465
    username: ${{secrets.MAIL_USERNAME}}
    password: ${{secrets.MAIL_PASSWORD}}
    subject: Github Actions job result
    # Literal body:
    body: Build job of ${{github.repository}} completed successfully!
    # Read file contents as body:
    body: file://README.md
    to: obiwan@example.com,yoda@example.com
    from: Luke Skywalker # <user@example.com>
    # Optional carbon copy recipients
    cc: kyloren@example.com,leia@example.com
    # Optional blind carbon copy recipients
    bcc: r2d2@example.com,hansolo@example.com
    # Optional recipient of the email response
    reply_to: luke@example.com
    # Optional unsigned/invalid certificates allowance:
    ignore_cert: true
    # Optional content type (defaults to text/plain):
    content_type: text/html
    # Optional converting Markdown to HTML (set content_type to text/html too):
    convert_markdown: true
    # Optional attachments:
    attachments: attachments.zip,git.diff,./dist/static/main.js

Troubleshooting

Gmail

Gmail security settings may cause this Action to fail. This failure may involve a message in the GitHub Actions details about access being denied and an email from Google to the email account being used about a sign-in being blocked and why.

Changes in Gmail settings may be necessary to get this action to work.

1. Google treats this method of using email as a "Less Secure App". However, "Less Secure Apps" can be enabled in Google profile settings. There doesn't appear to be a static link for this, but if you go to Google profile settings while signed-in and type "less secure apps" into the search bar, the appropriate instructions will come up.
2. IMAP needs to be enabled in Gmail settings as described here: https://support.google.com/mail/answer/7126229?hl=en
3. If the Gmail account you're trying to use in this Action is already 2FA (Two Factor Authentication) enabled, the 2FA password will need to be provided as well, which isn't included in the default template.

Users who have had problems have reported success by doing each of these three steps or by doing the first two steps and using a Gmail account that didn't have 2FA enabled.