keinos / auto-reply-sakura Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 106 KB

✅ さくらインターネットのメールで定休日にメールを受け取った場合に、送信者に定型文を自動返信するだけの PHP スクリプトです。

License: MIT License

PHP 98.32% Dockerfile 1.19% Shell 0.49%

auto-reply-sakura's Introduction

auto-reply-sakura

このリポジトリおよび auto-reply.php のスクリプトは、「さくらインターネット」のメールの自動返信機能を拡張する PHP スクリプトです。指定された定休日および時間にメールが届いた場合に、定型文を自動返信します。

「さくらインターネット」のベーシック・プラン + PHP v5.6.40 でメールの自動返信をカスタム（任意のタイミングで返信）したい場合に利用ください。

自動返信の本体スクリプトについて

./auto-reply.php: 自動返信を実行する PHP スクリプトです。
- PHP 5.6 でのみ動作確認しています。
- 受信したメール本文を標準入力（STDIN）から受け取ると、送信者に適宜自動返信を行います。
- 自動返信の条件などは次項の設定ファイルで行います。

設定ファイルについて

./config/config.json: 自動返信の各種設定が記載されています。
- UTF-8, BOM なしのテキストで JSON 形式で記載する必要があります。
- 設定可能な内容
  - 自動返信を行う曜日（オプションで返信の開始および終了時間の指定も可能）
  - 返信メールのタイトル
  - 自動返信の送信者メールアドレス指定

自動返信の本文テンプレート・ファイルについて

./template/reply_body.utf8.txt: 自動返信時のメール本文が記載されています。
- UTF-8, BOM なしのテキストで記載する必要があります。
- 文頭・文末の空行（改行だけの行）は削除され、文頭に空行が自動で１行追加されます。

その他

スクリプトの設置の仕方

HOW-TO-SETUP.md をご覧ください。

コントリビューション（不具合報告、改善要望など）

CONTRIBUTE.md をご覧ください。

リポジトリ情報

auto-reply-sakura's People

Contributors

Watchers

auto-reply-sakura's Issues

Disable phpunit/php-invoker (which is suggested and not required)

現象と再現方法

サーバーに composer をインストール＆リポジトリを clone 後、依存パッケージをインストールすると the requested PHP extension pcntl is missing from your system エラーが出る。サーバーに pcntl エクステンションがインストールされていないためだがレンタルサーバーなので php.ini も触れない。

% composer install --no-dev
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - phpunit/php-invoker 1.1.4 requires ext-pcntl * -> the requested PHP extension pcntl is missing from your system.
    - phpunit/php-invoker 1.1.3 requires ext-pcntl * -> the requested PHP extension pcntl is missing from your system.
    - phpunit/php-invoker 1.1.2 requires ext-pcntl * -> the requested PHP extension pcntl is missing from your system.
    - phpunit/php-invoker 1.1.1 requires ext-pcntl * -> the requested PHP extension pcntl is missing from your system.
    - Installation request for phpunit/php-invoker ^1.1 -> satisfiable by phpunit/php-invoker[1.1.1, 1.1.2, 1.1.3, 1.1.4].

  To enable extensions, verify that they are enabled in your .ini files:
    - /usr/local/php/5.6/etc/php.ini
  You can also run `php --ini` inside terminal to see which files are used by PHP in CLI mode.
Running update with --no-dev does not mean require-dev is ignored, it just means the packages will not be installed. If dev requirements are blocking the update you have to resolve those problems.

対策案

composer.json の symfony/console と phpunit/php-invoker は suggest パッケージなので必須ではないため phpunit/php-invoker を削除。

feat: 曜日だけでなく祝日などの日付で指定できるようにする

現在 ./config/conf.json では定休日の自動返信は曜日でしか指定できない。

年末、祝日など、日付を指定すると自動返信が働くようにできないか。

{
    "mail_title_to_reply": "お問い合わせありがとうございます。",
    "from": {
        "email": "[email protected]"
    },
    "weekday_to_reply": [
        "Sunday",
        "Wednesday"
    ],
    "holiday_to_reply": [
        "2020/10/10",
        "2020/10/12"
    ]
}

".gitignore" the "composer.lock" file

composer.lock ファイルは composer.lock.debug とリネームして提供しておいて .gitignore で除外した方がいいと思います。

% cd ~/auto-reply-sakura
% composer update
...
% git status
On branch master
Your branch is up to date with 'origin/master'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	composer.lock

nothing added to commit but untracked files present (use "git add" to track)

feat: 送信者名を指定できるようにして欲しい（"送信者名<[email protected]>"）

conf.json が下記の場合、ユーザーには送信者名が「自動返信」として届いて欲しい。

つまり、"自動返信"<[email protected]> と送られて欲しい。

{
    "mail_title_to_reply": "お問い合わせありがとうございます。",
    "from": {
        "name": "自動返信",
        "email": "[email protected]"    
    },
    "weekday_to_reply": [
        "Sunday",
        "Wednesday"
    ]
}

feat: CI によるテスト実行

CI 対応

もともと PHPUnit のユニット・テストは実装済みなので、PR 時に Travis CI などで PHP 5 上でのテスト実行を行うべき。

feat: 自動返信開始の時間指定ができるようにして欲しい

例えば「日曜日の夜18時から火曜日夜11：59まで」という条件に対応できるようにして欲しい。

火曜日の 11:59 は config.json で Tuesday を指定すれば問題ないので、日曜の 18:00 からトリガーできるようにして欲しい。

TL; DR（2020/06/15 現在の決定事項）

従来スタイルから、開始および終了時間が設定できる記述スタイルに変更。
コメントの「提案２」を採用

{
    "weekday_to_reply": [
        {
            "weekday": "Sunday",
            "begin": "8:00",
            "end": "18:00"
        },
        {
            "weekday": "Monday"
        }
    ]
}

Weekday 要素: 必須
Begin 要素：オプション（< End）
End 要素: オプション（> Begin）

feat: 定型文のファイルの所在も Conf ファイルで設定できるように

Before

./template/ ディレクトリ内に設置

After

./config/config.json にパスとファイルの記載を必須とし、そのテキスト・ファイルをテンプレートとして使用する。

Reason

「自動返信メールの内容を更新する」際の疎結合を高めるため。

例えば、独自 CMS／Wordpress といった「外部アプリなどから定型文を出力する」「FTP などによるアプロード」といった場合に、当アプリのディレクトリ内に保存を必須としてしまうと、それら外部要因と密結合してしまう。

つまり、「ディレクトリ構成が変わった」「テンプレート名が変わった」といった当アプリの仕様変更に対し、外部のアプリおよびユーザーにも仕様変更が必要になる。

Conf ファイルの指示により該当テンプレートを当アプリから参照するようにすることで、外部アプリやユーザー操作といった外部要因は、当アプリの仕様変更を気にする必要がなくなるので、より疎結合に近付く。

feat: 自動転送設定を自動で行うスクリプト

~/MailBox/<ユーザー>/.mailfilter は、ユーザー側の GUI（Web の UI）操作が行われると上書きされるので、対象ユーザーの .mailfilter に追記するスクリプトが欲しい。

% cd ~/suto-reply-sakura
% cat ./conf/user_auto_reply.json
{
   "user1",
   "user2",
   "user3"
}

% ./auto-reply.php set user1 user2 user3
Adding auto-reply settings to:
  user1 ... done
  user2 ... done
  user3 ... done
All done

% ./auto-reply.php unset user1 user2
Removing auto-reply settings from:
  user1 ... done
  user2 ... done
All done

feat: 自動返信のメール本文下部にオリジナルのメール文を添付/引用して欲しい

自動返信メールの下部に、ユーザーのメール本文を付けて欲しい。

ユーザーから見ると、送り先とは違う（自動返信の）メールアドレスから返信が来るため、何に対してのメールか一瞬わかりづらいからです。（パソコンがウィルスに感染している印象を持たれるかもしれません）

feat: 自動返信の重複送信を防止して欲しい

「代表メアド」→（転送）→「担当メアド A」といった設定で、各々のメアドで自動返信の機能を有効にすると、２通の自動返信メールが相手に送られてしまう。（代表メアドと担当メアドAからの自動返信）

このパターンに限っては、「代表メアド」の自動返信を無効にすれば解決できる。（担当メアド A のみが反応するため）

しかし、「代表メアド」→（転送）→「担当メアド A」「担当メアド B」といった複数の転送先がある場合に問題が発生する。

「代表メアド」のみ自動返信を有効にすることで自動返信の重複は回避できるが、今度は各担当者に直接送られてきたメールは自動返信されなくなってしまう。