PHP マニュアル: メッセージのヘッダを返す

stringfalse imap_fetchheader(IMAP\Connection $imap, int $message_num, int $flags = 0)

指定したメッセージについて、フィルタリングされていない完全な » RFC2822 フォーマットのヘッダをテキスト文字列として取得します。

imap

IMAP\Connection クラスのインスタンス。

message_num

メッセージ番号。

flags

オプション flags は次のようになります。

FT_UID - 引数 message_num は UID です。
FT_INTERNAL - 返される文字列は "internal" フォーマットです。CRLF に正規化しません。
FT_PREFETCHTEXT - RFC822.TEXT を、同時に事前に取得しておく必要があります。これは、メッセージテキスト全体を取得したい場合（例:「ローカルファイルに保存する」操作）に IMAP 接続で余分な RTT を回避します。

指定したメッセージのヘッダをテキスト文字列で返します。失敗した場合に false を返します

バージョン	説明
8.1.0	引数 `imap` は、IMAP\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、有効な `imap` リソースが期待されていました。