【PHP8.x】iconv_mime_decode_headers()関数の使い方

Copy
1<?php
2
3/**
4 * MIMEヘッダをデコードするサンプル
5 *
6 * iconv_mime_decode_headers関数は、MIMEヘッダ文字列（RFC 2047形式のエンコードされた単語を含む）を
7 * デコードし、キーと値のペアの連想配列として返します。
8 *
9 * 主にメールのヘッダやHTTPヘッダなどの処理に使用されます。
10 */
11
12/**
13 * MIMEエンコードされたヘッダ文字列をデコードし、結果を表示します。
14 */
15function decodeMimeHeadersExample(): void
16{
17    // MIMEエンコードされた様々なヘッダの例
18    // "=?UTF-8?B?..." はBase64エンコードされたUTF-8文字列
19    // "=?ISO-2022-JP?B?..." はBase64エンコードされたISO-2022-JP文字列
20    $headers = "Subject: =?UTF-8?B?44K44Oa44O844K/44Op44Oz44K/44Oq44O8?= (Test Subject)\r\n"
21             . "From: =?ISO-2022-JP?B?GyRCJDMkcyRGIyROJF4kTyRLJEckSyReJEwkbCMhGyhCSlBBLTE=?= <sender@example.com>\r\n"
22             . "To: recipient@example.com\r\n"
23             . "X-Custom-Header: This is a custom header with =?UTF-8?Q?=E3=83=86=E3=82=B9=E3=83=88?= text\r\n";
24
25    echo "--- オリジナルヘッダ ---" . PHP_EOL;
26    echo $headers . PHP_EOL . PHP_EOL;
27
28    // iconv_mime_decode_headers関数を使ってヘッダをデコードします。
29    // 第1引数: デコードするヘッダ文字列
30    // 第2引数: デコードモード (ICONV_MIME_DECODE_CONTINUE_ON_ERROR など)
31    //         0 はデフォルトのモードで、エラー時に false を返します。
32    // 第3引数: デコード後の文字エンコーディング (null の場合は detect_order に従うか、UTF-8 を試します)
33    $decodedHeaders = iconv_mime_decode_headers($headers, 0, 'UTF-8');
34
35    echo "--- デコード結果 ---" . PHP_EOL;
36
37    if ($decodedHeaders === false) {
38        echo "ヘッダのデコードに失敗しました。" . PHP_EOL;
39        return;
40    }
41
42    // デコードされたヘッダを連想配列として表示
43    foreach ($decodedHeaders as $key => $value) {
44        // 同じヘッダ名が複数存在する場合、値は配列になります
45        if (is_array($value)) {
46            echo "{$key}:" . PHP_EOL;
47            foreach ($value as $item) {
48                echo "  - " . $item . PHP_EOL;
49            }
50        } else {
51            echo "{$key}: {$value}" . PHP_EOL;
52        }
53    }
54
55    echo PHP_EOL;
56
57    // 別のモードでの例: 同じヘッダを複数保持する場合
58    // Subjectが2つあるようなヘッダをデコードしてみます。
59    $multiValueHeaders = "Subject: =?UTF-8?B?5pel5pys?= (日本語)\r\n"
60                       . "Subject: =?UTF-8?B?5a6f5Lya?= (中国語)\r\n"
61                       . "From: test@example.com\r\n";
62
63    echo "--- 複数Subjectヘッダの例 ---" . PHP_EOL;
64    echo $multiValueHeaders . PHP_EOL . PHP_EOL;
65
66    // ICONV_MIME_DECODE_COLLECT_ALL は、同じ名前のヘッダを全て配列として収集します。
67    $decodedMultiHeaders = iconv_mime_decode_headers($multiValueHeaders, ICONV_MIME_DECODE_COLLECT_ALL, 'UTF-8');
68
69    echo "--- 複数Subjectヘッダのデコード結果 (ICONV_MIME_DECODE_COLLECT_ALL) ---" . PHP_EOL;
70
71    if ($decodedMultiHeaders === false) {
72        echo "ヘッダのデコードに失敗しました。" . PHP_EOL;
73        return;
74    }
75
76    foreach ($decodedMultiHeaders as $key => $value) {
77        if (is_array($value)) {
78            echo "{$key}:" . PHP_EOL;
79            foreach ($value as $item) {
80                echo "  - " . $item . PHP_EOL;
81            }
82        } else {
83            echo "{$key}: {$value}" . PHP_EOL;
84        }
85    }
86}
87
88// 関数の実行
89decodeMimeHeadersExample();

iconv_mime_decode_headers関数は、MIMEヘッダ文字列をデコードするために使用されます。特に、メールの件名や送信者名など、国際文字を含むために「=?UTF-8?B?...」のようなRFC 2047形式でエンコードされた部分を、人間が読める通常の文字列に変換する役割を持ちます。

この関数は、デコードしたいヘッダ文字列を第一引数として受け取ります。第二引数 $mode ではデコードの挙動を指定でき、例えばICONV_MIME_DECODE_COLLECT_ALLという定数を指定すると、同じヘッダ名が複数存在する場合でも、それらをすべて値の配列として取得できます。第三引数 $encoding を指定すると、デコード後の文字エンコーディングを明示的に設定することが可能です。

処理が成功すると、デコードされたヘッダがキーと値のペアを持つ連想配列として返されます。デコードされたヘッダの値が複数ある場合は配列として格納されます。もしデコードに失敗した場合はfalseが返されるため、戻り値の確認は必須です。この関数を使うことで、複雑なMIMEエンコードされたヘッダ情報をアプリケーションで扱いやすくなります。

Copy
1<?php
2
3/**
4 * MIMEエンコードされたヘッダー文字列をデコードするサンプルコードです。
5 *
6 * iconv_mime_decode_headers 関数は、電子メールのヘッダーなどで使われる
7 * RFC 2047 形式のエンコードされた文字列（例: =?UTF-8?B?...?=）をデコードし、
8 * 構造化された配列として返します。
9 * 日本語などの非ASCII文字がSubjectやFromヘッダーに含まれる場合に特に役立ちます。
10 */
11
12// デコード対象のMIMEヘッダー文字列を定義します。
13// SubjectとFromヘッダーには、UTF-8でBase64エンコードされた日本語が含まれています。
14$mimeHeaders = <<<EOD
15From: =?UTF-8?B?44CS44Gw44GN44Gv44GZ44Gg44GM44Gk44Gw44GS44KM?= <sender@example.com>
16Subject: =?UTF-8?B?44K444O844Kv44O844OV44Or44O844K/44OG44K444Oh44O844Oq?=
17Date: Thu, 1 Jan 1970 00:00:00 +0000
18To: recipient@example.com
19EOD;
20
21echo "--- 元のMIMEヘッダー ---\n";
22echo $mimeHeaders . "\n\n";
23
24// iconv_mime_decode_headers 関数を使ってヘッダーをデコードします。
25// 第2引数の `$mode` はデフォルトの `0` を使用します（一般的なデコード動作）。
26// 第3引数の `$encoding` は `null` （自動判別またはPHPの内部エンコーディングを使用）を使用します。
27$decodedHeaders = iconv_mime_decode_headers($mimeHeaders);
28
29// デコード結果をチェックし、出力します。
30if ($decodedHeaders === false) {
31    echo "--- デコード失敗 ---\n";
32    echo "ヘッダーのデコード中にエラーが発生しました。\n";
33} else {
34    echo "--- デコードされたヘッダー ---\n";
35    // デコードされた配列の内容を人間が読みやすい形式で表示します。
36    // 上記のMIMEヘッダーは、以下のようにデコードされるはずです:
37    // From: 「送信者テスト <sender@example.com>」
38    // Subject: 「これはテストメールです」
39    print_r($decodedHeaders);
40}

iconv_mime_decode_headers 関数は、PHPで電子メールのヘッダーなどで使われるMIMEエンコードされた文字列をデコードするために利用されます。特に、SubjectやFromヘッダーに日本語などの非ASCII文字がRFC 2047形式（例: =?UTF-8?B?...?=)でエンコードされている場合に非常に役立ちます。

この関数は、最初の引数 $headers にデコードしたいMIMEヘッダー文字列を指定します。2番目の引数 $mode と3番目の引数 $encoding はオプションで、通常はデフォルト値のままで問題なく動作しますが、詳細なデコード動作の制御や、元のエンコーディングの明示的な指定が必要な場合に使用します。

関数が正常に処理されると、デコードされたヘッダー情報を連想配列として返します。この配列には、ヘッダー名がキーとなり、デコードされた値が格納されます。例えば、サンプルコードのように日本語がエンコードされたSubjectやFromヘッダーは、人間が読める形式に変換されて配列要素として取得できます。もしデコードに失敗した場合は、false を返しますので、戻り値が false でないかを確認するエラーハンドリングが重要です。これにより、受信したメールの情報を正確に解析し、表示するシステムを構築できます。