PHPのiconv_mime_decode()関数でMIMEヘッダーフィールドをデコードする方法

PHPでは、iconv_mime_decode()関数を使用することで、MIMEヘッダーフィールドをデコードできます。この関数はPHPに標準で組み込まれており、PHP 5以降のバージョンから利用可能です。

構文

String iconv_mime_decode(string $string, int $mode, string $encoding)

パラメータ

iconv_mime_decode()関数は、$string、$mode、$encodingという3つの引数を受け取ります。このうち$stringと$modeは必須パラメータですが、$encodingは省略可能です。

• $string − エンコードされたヘッダーを指定します。文字列型のパラメータです。

• $mode − 不正な形式のMIMEヘッダーフィールドに遭遇した際の動作を決定するパラメータです。以下に示すビットマスクを任意に組み合わせて指定できます。

  iconv_mime_decode_headers()が受け付けるビットマスクの一覧

  • ICONV_MIME_DECODE_STRICT

  • ICONV_MIME_DECODE_CONTINUE_ON_ERROR

  • ICONV_MIME_DECODE_STRICT − このオプションを設定すると、与えられたヘッダーは仕様に完全準拠した形でデコードされます。ただし、正しいMIMEヘッダーを生成しない不具合のあるメールユーザーエージェント（MUA）が多いため、このオプションはデフォルトでは無効になっています。

  • ICONV_MIME_DECODE_CONTINUE_ON_ERROR − このオプションを設定すると、文法上のエラーを無視しようとし、与えられたヘッダーの処理を続行します。

• $encoding − 結果を表現するための文字セットを指定するオプションパラメータです。省略した場合やnullを指定した場合は、iconv.internal_encodingの設定値が使用されます。

戻り値

iconv_mime_decode()関数は、デコードが成功した場合にはデコード済みのMIMEフィールドを返します。デコード中にエラーが発生した場合には、Falseを返します。

使用例

<?php
    // 「Sub: Preços Olà.txt」が出力される
    echo iconv_mime_decode("Sub: =?utf-8?B?UHJlw4PCp29zIE9sw4PCoA==?=.txt ",
    0, "ISO-8859-1");
?>

出力結果

Sub: Preços Olà.txt