CakeFest 2024: The Official CakePHP Conference

iconv_mime_decode_headers

(PHP 5, PHP 7, PHP 8)

iconv_mime_decode_headers複数の MIME ヘッダフィールドを一度にデコードする

説明

iconv_mime_decode_headers(string $headers, int $mode = 0, ?string $encoding = null): array|false

複数の MIME ヘッダフィールドを一度にデコードします。

パラメータ

headers

エンコードされたヘッダを表す文字列。

mode

mode は、iconv_mime_decode_headers() が不正な形式の MIME ヘッダフィールドに遭遇した場合の 振る舞いを定義します。以下のビットマスクの組み合わせで指定が可能です。

iconv_mime_decode_headers() で指定できるビットマスク
定数名 説明
1 ICONV_MIME_DECODE_STRICT 指定すると、ヘッダは » RFC2047 で定義されている標準に完全準拠する形式でデコードされます。 このオプションはデフォルトでは無効になっています。なぜなら、世の中には おかしなメールソフトが多く存在し、それらは規格に従わずに間違った MIME ヘッダを生成するからです。
2 ICONV_MIME_DECODE_CONTINUE_ON_ERROR 指定すると、iconv_mime_decode_headers() は文法的なエラーを無視し、デコード作業を継続します。

encoding

オプションの encoding パラメータは、結果の 文字セットを指定します。指定されなかった場合、もしくは null の場合は iconv.internal_encoding が用いられます。

戻り値

成功した場合は連想配列を返します。その中身には headers で指定した MIME ヘッダフィールドがすべて含まれています。 デコード中にエラーが発生した場合は false を返します。

連想配列の個々のキーがフィールド名を表し、対応する要素がフィールドの 値を表します。同じ名前のフィールドが複数存在する場合は、 iconv_mime_decode_headers() が自動的に連番つきの 配列をつくり、出現順にその配列に入れられます。 フィールド名は、大文字小文字を区別しない ことに注意して下さい。

変更履歴

バージョン 説明
8.0.0 encoding は、nullable になりました。

例1 iconv_mime_decode_headers() の例

<?php
$headers_string
= <<<EOF
Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=
To: example@example.com
Date: Thu, 1 Jan 1970 00:00:00 +0000
Message-Id: <example@example.com>
Received: from localhost (localhost [127.0.0.1]) by localhost
with SMTP id example for <example@example.com>;
Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
(envelope-from example-return-0000-example=example.com@example.com)
Received: (qmail 0 invoked by uid 65534); 1 Thu 2003 00:00:00 +0000

EOF;

$headers = iconv_mime_decode_headers($headers_string, 0, "ISO-8859-1");
print_r($headers);
?>

上の例の出力は以下となります。

Array
(
    [Subject] => Pr?ung Pr?ung
    [To] => example@example.com
    [Date] => Thu, 1 Jan 1970 00:00:00 +0000
    [Message-Id] => <example@example.com>
    [Received] => Array
        (
            [0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <example@example.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) (envelope-from example-return-0000-example=example.com@example.com)
            [1] => (qmail 0 invoked by uid 65534); 1 Thu 2003 00:00:00 +0000
        )

)

参考

add a note

User Contributed Notes 1 note

up
0
TheConstructor
13 years ago
If you need lower-case header-names (as I read the documentation case is not guranteed) try something like

<?php

$headers_string
= <<<EOF
Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=
To: example@example.com
Date: Thu, 1 Jan 1970 00:00:00 +0000
Message-Id: <example@example.com>
Received: from localhost (localhost [127.0.0.1]) by localhost
with SMTP id example for <example@example.com>;
Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
(envelope-from example-return-0000-example=example.com@example.com)
Received: (qmail 0 invoked by uid 65534); 1 Thu 2003 00:00:00 +0000

EOF;

$headers = iconv_mime_decode_headers($headers_string, 0, "ISO-8859-1");

$headers = array_combine(array_map("strtolower", array_keys($headers)), array_values($headers));

print_r($headers);
?>
To Top