ユーザーガイド
このドキュメントは、Customers Mail Cloudが提供する管理コンソールについて説明します。
管理コンソールは、各種設定やレポート参照を行うためのウェブユーザーインターフェイスを提供します。
表記について
サービスプラン
- サービスプランによって仕様が異なる機能は以下のラベルを付与します。
-
Pro:このラベルがある機能および説明は、Pro プランのみに適用されます。
-
Standard:このラベルがある機能および説明は、Standard プランのみに適用されます。
重要なお知らせ
Standardプランは、2021年9月30日(木)をもちまして新規販売の終了いたしました。
現在ご利用中のお客様におかれましては、引き続きご利用頂けます。
ドメイン
Pro プランでは、サービス利用者ごとに smtps.jp のサブドメインを割り当てます。このドキュメントでは、サービス利用者ごとに割り当てたドメインを SUBDOMAIN.smtps.jp と表記します。
推奨ブラウザ
推奨ブラウザはChrome、Mozilla Firefox、Chromium版 Microsoft Edgeです。
API
Customers Mail Cloudは、メールを送信する、送信エラーとなったメールアドレスを参照するなどのアプリケーションに必要な機能をAPIで提供します。
管理コンソールでは、APIにアクセスするためのユーザー(これをAPIユーザーと呼びます)を作成・管理します。また、APIの動作設定を行います。
Email Sending API
一括メール、または、単一メールを送信することができるAPIを提供します。
Transaction Email API
SMTP や APIを使用してメールを送信した際に発生するイベントデータを操作することができます。
送信者認証
Customers Mail Cloudが提供する送信者認証の設定を行います。
DKIM
Customers Mail Cloudは、SMTPまたはAPIで送信するメールにDKIM署名を付与する機能を提供します。管理コンソールに送信ドメイン(ヘッダFromのドメイン)を登録してDKIMキーを作成します。
これをサービス利用者のDNSに公開することでDKIM署名付きメールを送信することができます。
SPF
Customers Mail Cloudが提供するSPFレコードをサービス利用者のDNSに公開することで、SPFの運用を開始することができます。
S/MIME
Customers Mail CloudはメールリレーまたはAPIで送信するメールにS/MIME署名を付与する機能を提供します。 管理コンソールにS/MIME証明書を登録することで、S/MIME署名付きメールを送信することができます。
DMARC
送信ドメイン認証(DKIMとSPF)を利用して、メール送信者にポリシーと、レポートの仕組みを提供します。
レポート
管理コンソールから各種レポートを参照することができます。
エラーログ
送信エラーとなったメールアドレスを検索・参照することができます。
Customers Mail CloudはSMTPエラーおよびバウンスメールを分析し、ユーザー不明、ホスト不明などのエラーステータスに分類します。これによりどのような理由で送信エラーとなっているのかを確認することができます。
エラーグラフ
エラーステータスを円グラフで表示します。
どのような理由で送信エラーが発生しているのかを視覚的に確認することができます。ドメインごとのエラー状況を参照できるため、特定のドメインで発生している送信エラーの原因を調査することができます。
配信ログ
メール1通ごとの送信ステータスを検索・参照することができます。
メールが届いていないなどの問い合わせがあった際に、迅速にそのメールの状況を調査することができます。Customers Mail Cloudは、4つの配信ステータスでメールの送信状態を管理しています。
配信グラフ
配信ステータスのメールトラフィックを折れ線グラフで表示します。
どのくらいのメールトラフィックが発生しており、その状況がどうなっているのかを視覚的に確認することができます。
配信ドメイン
どのドメイン(ISP)宛のメール送信が多いかを円グラフで表示します。
宛先ドメインを分析し、メールトラフィックの多いドメインは配信速度設定を調整するなど、メール送信制御の最適化を行うことができます。
配信統計
日単位のメール配信通数を表形式で参照することができます。
レポート保持期間
配信ログ、エラーログなど配信レポートで参照できるデータには保持期間を設けています。保持期間が過ぎたレポートデータは日単位で削除されます。レポートデータの保持期間は 40日 です。
設定
Customers Mail Cloudの各種動作の設定を行います。
リレーサーバー
メールリレー元サーバーとSMTP接続する際の各種設定を行います。同時接続数、受信間隔、受信サイズ、接続IPなどの設定を行うことができます。
受信サーバー
バウンスメールや、Inbound Webhook を使って受信するメールを受信するための設定を行います。
メール転送
フィルタに合致したメールのコピーを転送先メールアドレスに送信する、または、宛先アドレスを転送先メールアドレスに書き換えて送信することができます。
例えば商品購入の確認メールなどのシステムが送信したメールをコピーし、転送先メールアドレスで保存・参照することができます。
配信停止
ユーザー不明となったメールアドレスへのメール送信を自動的に抑止する機能を提供します。
携帯キャリアや大手ISPは、ユーザー不明となったメールアドレスに大量のメールを送信することを迷惑メール行為として禁止しています。この機能を有効にすることで、ユーザー不明となったメールアドレスが自動的にクリーニングされ、到達性の高いメール配信を実現することができます。
配信速度
宛先ドメインごとに同時接続数、送信間隔、送信IP数を定義し、最適な速度でメール送信を行うための設定を行います。
また、特定ドメインを別のメールサーバーに転送する転送設定が行えます。
配信優先度
任意のメールヘッダを指定し、どのメールを優先配送すべきかを設定することができます。
資料請求への確認メールなど即時性を必要とするメールが、キャンペーンメールの配信により遅延するといった問題を解決することができます。
配信禁止時間帯
任意のメールヘッダを指定し、メール配信を禁止する時間帯を設定することができます。
キャンペーンメールなど夜間帯での着信が好ましくないメールを指定時間以外に送信しないよう制御することができます。
高度な設定
アプリケーションやPostfixが付与したReceivedヘッダを削除する、一時エラーとなったメールの再送期間や再送間隔を制御する、エンベロープFromを書き換えてバウンスメールを指定したドメインへ送信するなどの制御が行えます。
ワンクリック購読解除
任意のメールヘッダを指定し、List-Unsubscribeヘッダを追加した上でメール配信を行うことができます。
管理
管理コンソールの各種管理を行います。
アカウント
管理コンソールにログインするためのアカウントを作成・管理します。
アカウントには、各種設定の変更が可能な「サービス管理者」、レポートのみ参照可能な「レポート閲覧者」などの権限を付与することができます。
接続IP
管理コンソール、および、APIにアクセス可能なIPアドレスを登録することにより、IPベースのアクセス制御を行うことができます。
操作ログ
管理コンソールの操作、および、ログインの記録を確認することができます。
マイアカウント
ログインしているアカウントのパスワード、言語、タイムゾーンが変更できます。
グループ管理者は、上記に加え二要素認証の設定とOTPキーの再発行が行えます。
共通仕様
このセクションでは、管理コンソールの各種機能に共通する仕様について説明します。
TLSバージョン
管理コンソールにアクセスするためのhttpsでのTLSはバージョン1.2です。
メールアドレス
メールアドレスは E-mail の仕様書である RFC 5321, RFC 5322 で定義されていますが、実際には定義に外れているメールアドレスも使われています。本サービスでは RFC で定義されているメールアドレスを拡張して、一般に使用されている形式を使用できます。
使用できるメールアドレスの形式は以下の通りです。
メールアドレスは「ローカルパート@ドメインパート」の形になっています。このローカルパート、ドメインパート別に説明します。
ローカルパート
- ローカルパートに使用できる文字は、英数字と一部記号「
!
#
$
%
&
'
*
+
-
/
=
?
^
\
_
`
{
|
}
~
」です。 - その他に、先頭以外で「
.
」も使用できます。(連続する「.
」は、仕様上は使用できませんが、後述のローカルパートの例外を適用して使用可能にしています)
ドメインパート
- ドメインパートに使用できる文字は、英数字と「
.
」「-
」「_
」です。 - ただし、「
.
」は先頭、最後には使用できません。 - また、連続する「
.
」も使用できません。 - 「
.
」で区切られた各文字列の先頭は英数字に限ります。
ローカルパートの例外
- ローカルパートに使用できない文字が含まれている場合は、us-ascii の範囲内であれば
" "
で括ることで使用できます。 " "
で括る場合には、「"
」は「\"
」に、「\
」は「\\
」に変換します。" "
で括られていなく使用できないローカルパートでも括れば使用できる場合には、内部的に" "
で括って受け入れます。(メール送信時に括ります。)
" " で括れば使用できる例
使用できない文字を含む | " " で括って使用できる | 説明 |
---|---|---|
irregular..pattern@example.com | "irregular..pattern"@example.com | . が連続している例 |
hello\(^^)@example.com | "hello\\(^^)"@example.com | \ をエスケープする例 |
ドメインパートの「_
」
「_
」は、仕様上、ドメイン名に使用できません。
しかし、DNS に設定できるため、「_
」を含むサブドメインやホスト名が運用されているケースがあります。そのために、本システムでは「_
」を使用できるようにしています。
メールアドレスの長さ
メールアドレスはSMTPのルール上256バイトまでです。
しかし、実際にはそれを超えるメールアドレスが使用されています。そのためにメールアドレスとしての長さチェックは行っていませんが、SMTPのルール上1行1000バイトまでであるため、RCPT TOコマンドがこの長さに収まる必要があります。
メールアドレスの比較
本システムでのメールアドレスの検索や登録を行うときのメールアドレスの比較では、大文字小文字は区別しません。
参考例
「who@example.com」は「Who@Exmple.Com」でも、同じメールアドレスとして扱います。
フィルタ
管理コンソールでは、メールヘッダと値の組み合わせで動作条件を設定することができます。この動作条件をフィルタと呼びます。
ヘッダ名
ヘッダ名に"To"を指定した場合、envelope-to の値を評価します。
ヘッダ名には、From, Subject, およびアプリケーションが付与した拡張メールヘッダ(X-priorityなど)を指定することができます。ヘッダ名は大文字小文字を無視してマッチします。
動作条件の注意点
Received など複数現れるメールヘッダは動作条件に指定できません。
ヘッダ値
ヘッダ値には値を評価するための正規表現を指定します。
例えば、To (envelope-to) のドメイン部分をマッチさせたい場合、.+@example\.com
と記述します。
ローカルパートを含めたメールアドレスのフルマッチを指定する場合、user-name@example\.com
と記述します。
From指定によるマッチングの注意点
ヘッダ名にFromを指定し、メールアドレスをマッチさせたい場合は、.*user-name@example\.com.*
と記述します。ヘッダ値は、「"氏名" <メールアドレス> 」とメールアドレス前後に文字列が付与されるケースがあります。
以下に代表的な正規表現の構文を説明します。使用可能な全ての構文については、Java Patternを参照ください。
構文 | 説明 |
---|---|
x | 文字 x |
\ | バックスラッシュ文字 |
. | 任意の1文字(ドットを表現したい場合、\でエスケープする必要があります) |
X? | X 1 または 0回 |
X* | X 0 回以上 |
X+ | X 1 回以上 |
X{n} | X n回 |
X{n,} | X n回以上 |
X{n,m} | X n回以上 m回以下 |
[abc] | a,b,または,c |
[^abc] | a,b,c 以外の文字 |
[a-zA-Z] | a~z, A~Z (範囲) |
配信ステータス
Customers Mail Cloudは、メール1通ごとの状態を4つのステータスで記録しています。このステータスを配信ステータスと呼びます。
配信ステータスは、配信グラフや配信ログに表示されます。また、APIで配信データを取得する際にリクエストパラメータとして指定します。
ステータス | 説明 |
---|---|
queued | メールリレー元サーバーからメールを受信した。 |
succeeded | SMTP通信が成功し、宛先サーバーにメールが送信できた。 |
failed | SMTP通信が失敗し、宛先サーバーにメールが送信できなかった。 |
deferred | 宛先サーバーから一時エラー応答があったため、メールを再送している。 |
配信完了後にエラーログが表示される場合は
配信のログの中で、succeededになった後、エラーログに表示されるメールがある場合があります。
これは、Customers Mail Cloud の配送は成功しましたが、その後宛先のメールサーバーから何らかのバウンスが返ったものを表示しているもので、結果的には送信失敗になります。
この場合はエラーログのエラー理由を確認し、宛先のメールサーバーの管理者にお問い合わせください。
エラーステータス
メール送信時にエラーが発生した場合、SMTP応答メッセージまたはバウンスメールを解析し、Customers Mail Cloudが定義したステータスを記録します。これをエラーステータスと呼びます。
エラーステータスは、エラーグラフやエラーログに表示されます。また、APIで送信エラーデータを取得する際にリクエストパラメータとして指定します。
ステータス | エラー理由 | 発生原因 |
---|---|---|
1 | ホスト不明 | DNSによるホスト解決ができなかった。 |
2 | ユーザ不明 | メールアドレスが存在しない。 |
3 | 再送タイムアウト | 宛先サーバーへ接続できないまたは一時エラー応答が返されたため、再送を行ったが時間内に再送が完了しなかった。 |
4 | 受信拒否 | 宛先サーバーのポリシーによりメール受信を拒否された。 |
5 | 容量オーバー | メールボックスの容量やメールサーバーのディスク領域の制限を超えたため、宛先サーバーがメールを受信できなかった。 |
6 | 転送エラー | 送信した宛先アドレスと異なるアドレスへのメール送信が失敗した。受信者側の設定で宛先アドレスにメールを保存した後、別アドレスに転送している場合、宛先アドレスにはメールが届いている可能性がある。 |
7 | 受信サーバエラー | 宛先サーバーの設定ミスによりメール送信が失敗した(25番ポートにSMTP認証を設定している、DNSによるホスト解決を行って接続したにもかかわらず宛先メールアドレスを管理していないなど)。 |
8 | サイズオーバー | メールサイズが大きすぎるため、宛先サーバーが受信を拒否した。 |
9 | アドレス形式エラー | 宛先メールアドレスがメールアドレスの形式に従っていない。 |
10 | 配信停止アドレス | 配信停止機能にてメールの送信を抑止した。 |
11 | 購読解除 | 購読解除リストに登録済みのメールアドレスのため、再度のメール送信を抑止した。 |
99 | その他エラー | 宛先サーバーが恒久エラーを応答したため、メール送信に失敗した。 |
関連文書
Customers Mail Cloudとは
Customers Mail Cloudのサービス概要について説明しています。
Getting Started
アカウントを取得してからサービスの利用を開始するまでに必要な設定をまとめています。まずはこのドキュメントからご覧ください。
APIリファレンス
APIの使用方法やインターフェイス仕様について説明しています。APIについて詳しく知りたい方はこのドキュメントをご覧ください。
システム連携
Postfix, Java, PHP, Python など既存アプリケーションをSMTPインターフェイスで接続する方法など、Customers Mail Cloudとシステム連携するための具体的なノウハウを説明しています。