【サーバ代0円】GitHub ActionsとPythonで、自動メール通知システムを実装してみた
こんにちは!株式会社 HIBARI の中野と申します。
「タスクリストを毎朝メールに届いたらいいな」
「とあるサイトのスクレイピング結果を毎週メールに届いたらいいな」
このように感じることが増えてきました。
そこで今回は、無料利用枠の範囲で使えるGitHub Actions
と Python を用いて、自分専用の自動メール通知システムを実装してみました。
サーバ契約も不要で、運用コストはゼロ。
この記事は、その実装過程をまとめた備忘録です。同じような課題を持つ方の参考になれば嬉しいです。
今回作ったもの
今回作ったシステムの構成は、とてもシンプルです。
-
GitHub Actions
がタイマーのように、決まった時間に処理を開始します。 - リポジトリに置いたPython スクリプトが実行され、メールの内容を作成します。
- Gmail アカウントなどを使って、指定したアドレスにメールを自動送信します。
これだけでできました。
実装の手順
ここからは、私が実際に手を動かした手順をまとめていきます。
1.リポジトリの準備
リポジトリを作りました。
ファイル構成は以下のようになりました。
.
├── .github/
│ └── workflows/
│ └── main.yml
├── main.py
└── requirements.txt
また、今回作成したコードは公開しています。
2.メールの送信処理(main.py)を書く
次にシステムの核となるメール送信部分を Python で実装しました。
このコードは「決められた固定のメッセージを送る」だけのコードにしています。
内容を変更したい場合はcreate_email_content()
関数内を変更してください。
import os
import smtplib
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
import datetime
def create_email_content():
"""
メールの件名と本文(HTML)を生成する関数。
★★この関数の中身を、あなたの送りたい内容に合わせて書き換えてください★★
"""
print("メール内容の作成を開始します...")
# --- ▼▼▼ ここを自由にカスタマイズ ▼▼▼ ---
# メール件名
today_str = datetime.date.today().strftime("%Y/%m/%d")
subject = f"{today_str}の定例通知"
# メール本文 (HTML形式で自由に記述できます)
html_content = """
<html>
<body>
<h1>おはようございます!</h1>
<p>今日のタスクリストです。</p>
<ul>
<li>タスクA:資料作成</li>
<li>タスクB:メール返信</li>
<li>タスクC:会議準備</li>
</ul>
<p>今日も一日頑張りましょう!</p>
</body>
</html>
"""
# --- ▲▲▲ ここまでカスタマイズ ▲▲▲ ---
print("メール内容の作成が完了しました。")
return subject, html_content
def send_email(subject, html_content):
"""メールを送信する関数 (この関数は変更不要です)"""
smtp_server = os.environ.get('SMTP_SERVER')
smtp_port = os.environ.get('SMTP_PORT')
smtp_username = os.environ.get('SMTP_USERNAME')
smtp_password = os.environ.get('SMTP_PASSWORD')
recipient_email = os.environ.get('RECIPIENT_EMAIL')
if not all([smtp_server, smtp_port, smtp_username, smtp_password, recipient_email]):
print("エラー: メール送信に必要な環境変数が設定されていません。")
return
msg = MIMEMultipart('alternative')
msg['Subject'] = subject
msg['From'] = smtp_username
msg['To'] = recipient_email
msg.attach(MIMEText(html_content, 'html', 'utf-8'))
try:
with smtplib.SMTP(smtp_server, int(smtp_port)) as server:
server.starttls()
server.login(smtp_username, smtp_password)
server.send_message(msg)
print("メールを正常に送信しました。")
except Exception as e:
print(f"メールの送信に失敗しました: {e}")
if __name__ == '__main__':
mail_subject, mail_body = create_email_content()
send_email(mail_subject, mail_body)
3.依存関係のファイル (requirements.txt)
一般的に、インポートすべきライブラリをこのファイル内に書きます。しかし、今回は標準ライブラリ内で完結したので何も書きません。やったね。
4.GitHub Actions の設定
今回、GitHub の機能の 1 つである GitHub Actions を使ってメールを送ります。この GitHub Actions の設定をするファイルを書きます。
.github/workflows/main.yml
というパスに YAML ファイルを作るのがお作法のよう(?)です。
# ワークフローの名前
name: 定期メール自動送信
on:
# スケジュール実行のトリガー
schedule:
# cron形式でスケジュールを指定 (時刻はUTC)
# 以下の例は、毎日午前8時 (JST) に実行 (UTCでは前日の23:00)
- cron: "0 23 * * *"
# 手動で実行するためのトリガー (テストに便利)
workflow_dispatch:
jobs:
send-scheduled-email:
runs-on: ubuntu-latest
steps:
# 1. リポジトリのコードをチェックアウト
- name: Checkout repository
uses: actions/checkout@v4
# 2. Pythonの環境をセットアップ
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
# 3. (今回は不要だが) 依存ライブラリをインストール
- name: Install dependencies
run: pip install -r requirements.txt
# 4. Pythonスクリプトを実行してメールを送信
- name: Run script and send email
env:
SMTP_SERVER: ${{ secrets.SMTP_SERVER }}
SMTP_PORT: ${{ secrets.SMTP_PORT }}
SMTP_USERNAME: ${{ secrets.SMTP_USERNAME }}
SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
RECIPIENT_EMAIL: ${{ secrets.RECIPIENT_EMAIL }}
# スクリプトを実行(ファイル名を main.py と仮定)
run: python main.py
時間の指定(9行目のcron
)が UTC なのが戸惑いました。UTC = 日本時間(JST) - 9 時間なので、実行したい時間から 9 時間引いた時間を指定すればいいです。
補足 : cron の書式について
cron
の書式は 5 つのフィールドで構成されており、それぞれが以下の時間を表しています。
┌───────────── 分 (0 - 59)
│ ┌───────────── 時 (0 - 23)
│ │ ┌───────────── 日 (1 - 31)
│ │ │ ┌───────────── 月 (1 - 12)
│ │ │ │ ┌───────────── 曜日 (0 - 6, 日曜日から土曜日)
│ │ │ │ │
* * * * *
*
(アスタリスク)は「毎(まい)」を意味し、そのフィールドが取りうる全ての値を表します。
したがって、0 23 * * *
は以下のようになります。
- 分:
0
→ 0 分 - 時:
23
→ 23 時(UTC) - 日:
*
→ 毎日 - 月:
*
→ 毎月 - 曜日:
*
→ 毎日
これを組み合わせると、「毎日 23:00(UTC)に実行する」つまり、日本時間(JST)を用いると「毎日 8:00(JST)に実行する」という風になります。
5.パスワード管理
メールのパスワードなどをコードに直書きするのは絶対に NG❌。なので今回はGitHub Secrets
を使用してパスワード等の環境変数の設定をしました。
以下の手順で行いました。
STEP 1: パスワードの取得(Gmail の場合)
今回は Gmail に送信しました。Gmail はセキュリティのため、通常の Google アカウントのログインパスワードは使えないっぽいです。代わりに、このシステム専用の「アプリパスワード」を生成して対応しました。
以下はアプリパスワードの生成手順です。
- Google アカウントの管理ページにアクセスします。
- 左のメニューからセキュリティをクリックします。
- 「Google へのログイン」セクションにある「2 段階認証プロセス」がオンになっていることを確認します。もしオフの場合は、画面の指示に従って有効にしてください。(アプリパスワードの利用には 2 段階認証が必須っぽいです。)
- 2 段階認証を有効にした後、セキュリティページに戻り、「アプリパスワード」を探してクリックします。(見つからない場合は検索窓で「アプリパスワード」と検索してください。)
- アプリパスワードの作成画面が表示されます。ここで、アプリ名にわかりやすい文字を入れて作成を押してください。
- 16 文字のパスワードが表示されます。このパスワードは1 度しか表示されないため確実にメモして下さい。
STEP 2: GitHub Secrets の設定ページへ移動
GitHub リポジトリの Settings > Secrets and variables > Actions
へ移動します。
STEP 3: 5 つの Secret を登録
New repository secret
ボタンを押して以下の情報を1つずつ登録します。
Secret 名 | 値(設定する内容) |
---|---|
SMTP_SERVER |
smtp.gmail.com (Gmail の場合) |
SMTP_PORT |
587 (通常はこの値で OK) |
SMTP_USERNAME |
あなたの Gmail アドレス (例: your_email@gmail.com ) |
SMTP_PASSWORD |
【最重要】 STEP 1 で取得した 16 文字のアプリパスワード |
RECIPIENT_EMAIL |
通知メールを受け取りたいメールアドレス(SMTP_USERNAME と同じで OK) |
すべて完了するとRepository secrets
のセクションに 5 つの名前がリストアップされるはずです。
これでセキュリティにも配慮しつつ環境変数を設定できました。やったね。
動作確認
時間まで待つのが面倒だったので、Actions
内のRun workflow
を押して動作確認を行いました。
無事にメールが届きました!
まとめ
というわけで、サーバを使わず無料利用枠の範囲内で自動通知システムを実装することができました!
固定のメッセージを送るだけでも十分便利ですが、Python スクリプトを改良すれば、自動でタスクリストを取得して報告したり、API を叩いて取得したデータをレポートしたりと、アイデア次第で色々なことに応用できそうです。
メールを送るシステムを作りたいけどサーバを契約するのはちょっと…と思っていましたが、無料で十分なものを作れて満足です。
同じようなことをしたい人の参考になれば幸いです!
免責事項
本記事に掲載された内容によって生じた損害等の一切の責任を負いかねますので、ご了承ください。特に、パスワード等の機密情報の管理については、ご自身の責任において厳重に行ってください。また、悪用することはしないでください。
Discussion