OPAL 操作マニュアル

First setup

初回にやること

最初だけ、Windows側のアーカイブアプリ、Box保存先、Webアプリの認証・SMTP設定を整えます。

1. 事前確認

  • Windows PCでクラシックOutlookが使える
  • 対象メールアカウントが同じOutlookプロファイルに追加されている
  • Box DriveまたはBox同期フォルダが使える
  • Pythonをインストールできる
  • XserverなどのPHP実行環境がある
  • SMTP送信用のホスト、ポート、ユーザー名、パスワードが分かる

2. Windows側セットアップ

  1. セットアップを実行します。
    setup.bat
  2. Outlook Store名を確認します。
    list_accounts.bat
  3. `config/config.yaml` を編集します。
    box_root: 'C:\Users\ny\Box\OPAL'
    
    accounts:
      - key: "main"
        store_display_name: "Outlookに表示されたStore名"
        enabled: true
    
    database:
      output_path: 'C:\Users\ny\Box\OPAL\archive_latest.sqlite'
      enable_fts: false
Windowsパスの注意

バックスラッシュを使う場合は、YAMLの値をシングルクォートで囲みます。

3. Box保存先を確認

`box_root` 配下に、アカウント別の保存フォルダと検索用DBが作成されます。

C:\Users\ny\Box\OPAL\
  accounts\
    main\
      messages\
      bodies\
      attachments\
  archive_latest.sqlite

Boxの同期が止まっていると、他端末から原本や添付ファイルを確認できません。初回は同期状態も確認します。

4. Webアプリ側設定

  1. `App/mailsearch/includes/config.php` を本番環境に合わせます。
    'app' => [
        'base_url' => 'https://example.com/mailsearch',
    ],
    
    'smtp' => [
        'host' => 'SMTPホスト',
        'port' => 587,
        'secure' => 'tls',
        'username' => 'SMTPユーザー',
        'password' => 'SMTPパスワード',
    ],
  2. ログインを許可するメールアドレスを設定します。
    'auth' => [
        'magic_link_expires_minutes' => 15,
        'allowed_users' => [
            'user@example.ac.jp',
        ],
    ],
  3. `App/mailsearch` をWebサーバーへ配置します。

    配置後、ブラウザで `login.php` を開きます。

5. 初回DB作成とアップロード

  1. 検索用DBを初期化します。
    build_db.bat
  2. Webアプリへログインします。

    `login.php` でメールアドレスを入力し、届いたマジックリンクを開きます。

  3. `upload.php` から `archive_latest.sqlite` をアップロードします。

    初回時点でメール件数が0件でも、DB差し替えの確認として利用できます。

6. 初回確認チェックリスト

  • Webアプリへマジックリンクでログインできる
  • `upload.php` でSQLite DBをアップロードできる
  • `index.php` の検索画面が開く
  • アカウント一覧が表示される
  • Box側に `archive_latest.sqlite` が作成されている
  • 今後使う対象日数を決めている。例: 90日