【PHP8.x】getmxrr関数の使い方
getmxrr関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
getmxrr関数は、指定されたホスト名に対応するMXレコード（Mail Exchangerレコード）を取得する関数です。MXレコードとは、特定のドメイン宛の電子メールを処理するメールサーバーの情報をインターネットに公開するための記録を指します。
この関数は、最初の引数として検索対象のホスト名（ドメイン名）を受け取ります。もしMXレコードが見つかった場合、そのメールサーバーのホスト名が2番目の引数で指定された配列に格納されます。この配列は、関数が終了すると検索結果で埋められて利用できるようになります。さらに、3番目のオプション引数として別の配列を指定すると、各メールサーバーの優先度（重み）がその配列に格納されます。優先度の数値が小さいほど、そのメールサーバーが優先的に利用されることを示します。
getmxrr関数自体は、MXレコードが正常に見つかった場合にブール値trueを返し、見つからなかった場合やエラーが発生した場合はfalseを返します。この関数は、主に特定のドメインにメールを送信する際に、どのメールサーバーに接続すべきかをプログラムで動的に判断する必要がある場合などに利用されます。これにより、メールのルーティングを適切に行う手助けとなります。
構文(syntax)
1<?php 2$hostname = "example.com"; 3$mxhosts = []; 4$weight = []; 5 6$success = getmxrr($hostname, $mxhosts, $weight); 7?>
引数(parameters)
string $hostname, array &$hosts, array &$weight = null
- string $hostname: MXレコードの検索対象となるホスト名
- array &$hosts: 取得したMXレコードのホスト名を格納する配列（参照渡し）
- array &$weight = null: 取得したMXレコードの優先度（weight）を格納する配列（参照渡し、省略可能）
戻り値(return)
bool
getmxrr 関数は、指定されたドメインの MX (Mail Exchanger) レコードの検索に成功したかどうかを示す真偽値 (bool) を返します。検索が成功した場合は true、失敗した場合は false を返します。
サンプルコード
PHP getmxrrでMXレコードを取得する
1<?php 2 3declare(strict_types=1); 4 5/** 6 * 指定されたドメインのMX（Mail Exchanger）レコードを取得し、表示します。 7 * 8 * getmxrr()は、ドメイン名に関連付けられたメールサーバーの情報をDNSから検索する関数です。 9 * これにより、特定のドメイン宛のメールがどのサーバーに配送されるべきかを知ることができます。 10 * 11 * @param string $domain MXレコードを検索するドメイン名。 12 * @return void 13 */ 14function showMxRecords(string $domain): void 15{ 16 // MXレコードのホスト名と重み（優先度）を格納するための配列を初期化 17 $mxHosts = []; 18 $mxWeights = []; 19 20 echo "ドメイン '{$domain}' のMXレコードを検索します...\n"; 21 22 // getmxrr() を実行してMXレコードを取得します。 23 // 成功すると true を返し、$mxHosts と $mxWeights 配列に結果が格納されます。 24 // 失敗した場合は false を返します。 25 $result = getmxrr($domain, $mxHosts, $mxWeights); 26 27 if ($result) { 28 // ホスト名と重みを結合した連想配列を作成 29 $records = array_combine($mxHosts, $mxWeights); 30 31 // 重み（優先度）が小さい順にソート（値が小さいほど優先度が高い） 32 asort($records); 33 34 echo "MXレコードが見つかりました:\n\n"; 35 echo "優先度\tメールサーバー\n"; 36 echo "------\t--------------\n"; 37 38 // 結果をループして表示 39 foreach ($records as $host => $weight) { 40 echo "{$weight}\t{$host}\n"; 41 } 42 } else { 43 echo "MXレコードが見つかりませんでした。\n"; 44 } 45} 46 47// 検索したいドメイン名を指定 48$targetDomain = 'gmail.com'; 49 50// 関数を呼び出して実行 51showMxRecords($targetDomain); 52 53?>
このPHPサンプルコードは、getmxrr関数を使用して、指定したドメインのMXレコードを取得し表示するものです。MXレコードとは、特定のドメイン宛のメールをどのメールサーバーが受け取るかを定義する情報です。
getmxrr関数は、第1引数に調査したいドメイン名（例: 'gmail.com'）を文字列で渡します。関数が成功すると、第2引数として渡した配列（サンプルコードの$mxHosts）にメールサーバーのホスト名が、第3引数の配列（$mxWeights）にそれぞれの優先度（重み）を示す数値が格納されます。これらの引数は参照渡しのため、関数内で値が直接書き換えられます。関数の戻り値は真偽値（bool型）で、MXレコードが見つかればtrue、見つからなければfalseを返します。
このコードでは、getmxrrの戻り値を使って処理の成否をif文で判定しています。成功した場合、取得したホスト名と重みをarray_combine関数で一つの連想配列にまとめ、asort関数で優先度順（数値が小さいほど優先度が高い）に並べ替えます。最後に、foreachループを使って、見つかったメールサーバーの一覧を分かりやすく表示します。MXレコードが見つからなかった場合は、その旨を伝えるメッセージが出力されます。
getmxrr関数の第2、第3引数は「参照渡し」という仕組みです。これは、事前に用意した空の配列 $mxHosts と $mxWeights に、関数が直接結果を書き込むためのものです。この関数はインターネット上のDNSサーバーに問い合わせるため、ネットワーク接続が必須です。また、関数の戻り値が true かどうかを必ず if 文で確認してください。false が返された場合はMXレコードが見つからなかったことを意味し、配列は空のままです。この状態で配列を使おうとするとエラーの原因になります。取得できる「重み」の値は、小さいほど優先度が高いメールサーバーを示します。存在しないドメインやMXレコードがないドメインを指定した場合も、関数は false を返します。