タイムアウトだけでは作成が失敗したと判断できません。顧客の申請と作成結果を結び付ける記録が必要です。作成、転送設定、利用可能の確認を別の段階にすれば、切断後に結果がわからないまま作成ボタンを押し直さずに済みます。
TrekMail API を使えば、プログラムにメールボックス作成や転送設定を任せられます。担当者が毎回画面で操作する代わりに、自社システムから所定の命令を送る方法です。変更には Pro または Agency、適切な権限、対象ドメインへのアクセスが必要です。
何を作るのか明確にする
普通の言葉で目的を書きます。「従業員の個人メールが必要」と「共通アドレスのメールを別の箱へ届けたい」では、必要な設定が違います。
通常のメールボックスは独自の履歴を保存し、転送とローカルコピーの有無を設定できます。メールボックスなしの転送アドレスは、その宛先に独立した履歴を残さず、別の受信者へ渡すためのものです。条件と上限も異なります。
メール基盤の管理と内容の利用も分けます。アドレスを作るだけなら、従業員の通信を読む必要はありません。メッセージ操作は別の API 能力なので、作成だけのプログラムへ渡さないでください。
開発前に違いを記録すれば、作るリソースと管理画面に期待する結果を伝えられます。
プランと限定したアクセスを用意する
画面で手動設定できても、API で変更できるとは限りません。メールボックス作成と転送変更には Pro または Agency が必要です。Starter は利用できる基盤設定の読み取りができますが、この自動化には足りません。
プログラム専用のアクセスを作り、操作とドメインを絞ります。複数企業を扱う代理店なら、一顧客用プログラムが扱うのはその顧客のリソースだけです。
許可を出す従業員も、自分を超える権限は渡せません。範囲とプラン条件は API 権限ガイドにあります。
キーは連携のサーバー側設定へ保存します。顧客の登録フォームや歓迎メールへ表示しないでください。利用者には、作成したアドレスと利用開始方法が分かれば十分です。
作成の順序を組み立てる
操作できるドメインは自社の顧客情報から判断します。ブラウザーが送ったドメインIDだけでは権限の証明になりません。
次にアドレスの存在と残り上限を確認します。すでにあれば、同じ申請で作られたものか調べます。ボタンの再押下で、結果が分からなくなる状態を作らないようにします。
作成後、必要なら転送を設定します。通常メールボックスからの転送でコピーを残すかは、先に決めます。履歴を残す予定なら、偶然の既定値に任せないでください。
作成済みで転送だけ失敗したなら、部分完了を記録してその工程を修正します。配信とローカルコピーを確認してから利用可能と表示します。
メソッドと形式は TrekMail API 概要を開発者の仕様として使い、利用者向けの手順は簡単に保ちます。
再試行とエラーを考える
冪等と文書化された操作では、同じ申請と内容に同じIdempotency-Keyを使います。返されたメールボックスIDを保存し、他の操作の再試行規則は別に確認します。
それ以外では、対象リソースができたか先に調べます。不明な応答のたびに無条件でアドレスを作り直さず、申請と結果の関連を残して正しい段階から続けます。
容量不足、上限到達、アクセス拒否は別々に扱います。同じ要求の繰り返しでは解消しません。「作成中」を延々と出すより、理由と修正担当者を伝えるほうが役立ちます。
一括処理では全件同じ時間で終わると約束せず、各状態と対応が必要な一覧を示します。
一つのドメインで試す
テストドメインと少数のアドレスで、通常作成、同じ申請の再実行、許可外ドメインへの操作を確認します。
作成アドレスへメールも送ります。転送なら最終受信者と、設定どおりのコピー保存を確認します。API の成功応答だけでは、メールの業務動作まで確認したことになりません。
開始前に、誰がエラーを見て手動修正できるか決めます。キーやパスワードを含まない申請ログを残し、小さな流れが安定したら、従業員や顧客の利用開始へ組み込みます。
実装はAPIの概要を参照してください。環境の作成に新しい利用者のメール閲覧権限は不要です。必要な管理権限だけを与えます。