PHP TOP

imap_fetchtext »

« imap_fetchmime

imap_fetchstructure

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_fetchstructure — 特定のメッセージの構造を読み込む

説明

imap_fetchstructure(IMAP\Connection $imap, int $message_num, int $flags = 0): stdClass|false

この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。

パラメータ

imap: IMAP\Connection クラスのインスタンス。
message_num: メッセージ番号。
flags: オプションのパラメータで、FT_UID のみが指定可能です。これは、message_num を UID として処理することを関数に指定するためのものです。

戻り値

以下の表に示すプロパティを持つオブジェクトを返します。失敗した場合に false を返します

**imap_fetchstructure()** が返すオブジェクト
type	最初の body 部の型
encoding	body 部を転送する際のエンコード法
ifsubtype	subtype 文字列がある場合に `true`
subtype	MIME の subtype
ifdescription	description 文字列がある場合に `true`
description	内容を記述する文字列
ifid	identification 文字列がある場合に `true`
id	Identification 文字列
lines	行数
bytes	バイト数
ifdisposition	disposition 文字列がある場合に `true`
disposition	Disposition 文字列
ifdparameters	`dparameters` 配列が存在する場合に `true`
dparameters	オブジェクトの配列。各オブジェクトは `"attribute"` および `"value"` というプロパティを保持し、それぞれ `Content-disposition` MIME ヘッダの対応するパラメータを表す。
ifparameters	配列 parameters が存在する場合に `true`
parameters	オブジェクトの配列。各オブジェクトは `"attribute"` および `"value"` というプロパティを保持する。
parts	オブジェクトの配列であり、その構造はトップレベルオブジェクトと同じです。それぞれが MIME body 部に対応しています。

**最初の body 部の型 (使用するライブラリによって異なるため、定数を使うことを推奨します)**
値	型	定数
0	text	TYPETEXT
1	multipart	TYPEMULTIPART
2	message	TYPEMESSAGE
3	application	TYPEAPPLICATION
4	audio	TYPEAUDIO
5	image	TYPEIMAGE
6	video	TYPEVIDEO
7	model	TYPEMODEL
8	other	TYPEOTHER

**転送時のエンコーディング (使用するライブラリによって異なるため、定数を使うことを推奨します)**
値	型	定数
0	7bit	ENC7BIT
1	8bit	ENC8BIT
2	Binary	ENCBINARY
3	Base64	ENCBASE64
4	Quoted-Printable	ENCQUOTEDPRINTABLE
5	other	ENCOTHER

変更履歴

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

参考

imap_fetchbody() - メッセージ本文中の特定のセクションを取り出す
imap_bodystruct() - 指定したメッセージの指定した body セクションの構造を読み込む

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 12 notes

down

david at hundsness dot com ¶

16 years ago

Here is code to parse and decode all types of messages, including attachments. I've been using something like this for a while now, so it's pretty robust.



<?php

function getmsg($mbox,$mid) {

    // input $mbox = IMAP stream, $mid = message id

    // output all the following:

    global $charset,$htmlmsg,$plainmsg,$attachments;

    $htmlmsg = $plainmsg = $charset = '';

    $attachments = array();



    // HEADER

    $h = imap_header($mbox,$mid);

    // add code here to get date, from, to, cc, subject...



    // BODY

    $s = imap_fetchstructure($mbox,$mid);

    if (!$s->parts)  // simple

        getpart($mbox,$mid,$s,0);  // pass 0 as part-number

    else {  // multipart: cycle through each part

        foreach ($s->parts as $partno0=>$p)

            getpart($mbox,$mid,$p,$partno0+1);

    }

}



function getpart($mbox,$mid,$p,$partno) {

    // $partno = '1', '2', '2.1', '2.1.3', etc for multipart, 0 if simple

    global $htmlmsg,$plainmsg,$charset,$attachments;



    // DECODE DATA

    $data = ($partno)?

        imap_fetchbody($mbox,$mid,$partno):  // multipart

        imap_body($mbox,$mid);  // simple

    // Any part may be encoded, even plain text messages, so check everything.

    if ($p->encoding==4)

        $data = quoted_printable_decode($data);

    elseif ($p->encoding==3)

        $data = base64_decode($data);



    // PARAMETERS

    // get all parameters, like charset, filenames of attachments, etc.

    $params = array();

    if ($p->parameters)

        foreach ($p->parameters as $x)

            $params[strtolower($x->attribute)] = $x->value;

    if ($p->dparameters)

        foreach ($p->dparameters as $x)

            $params[strtolower($x->attribute)] = $x->value;



    // ATTACHMENT

    // Any part with a filename is an attachment,

    // so an attached text file (type 0) is not mistaken as the message.

    if ($params['filename'] || $params['name']) {

        // filename may be given as 'Filename' or 'Name' or both

        $filename = ($params['filename'])? $params['filename'] : $params['name'];

        // filename may be encoded, so see imap_mime_header_decode()

        $attachments[$filename] = $data;  // this is a problem if two files have same name

    }



    // TEXT

    if ($p->type==0 && $data) {

        // Messages may be split in different parts because of inline attachments,

        // so append parts together with blank row.

        if (strtolower($p->subtype)=='plain')

            $plainmsg. = trim($data) ."\n\n";

        else

            $htmlmsg. = $data ."<br><br>";

        $charset = $params['charset'];  // assume all parts are same charset

    }



    // EMBEDDED MESSAGE

    // Many bounce notifications embed the original message as type 2,

    // but AOL uses type 1 (multipart), which is not handled here.

    // There are no PHP functions to parse embedded messages,

    // so this just appends the raw source to the main message.

    elseif ($p->type==2 && $data) {

        $plainmsg. = $data."\n\n";

    }



    // SUBPART RECURSION

    if ($p->parts) {

        foreach ($p->parts as $partno0=>$p2)

            getpart($mbox,$mid,$p2,$partno.'.'.($partno0+1));  // 1.2, 1.2.1, etc.

    }

}

?>

down

mkknapp at quadrapod dot com ¶

23 years ago

Assuming $struct = imap_fetchstructure($x,$y);



It is important to note that if a message has NO attachements, $struct->parts is an empty array, and $struct->bytes has a value.  If a message as ANY attachements, $struct->bytes ALWAYS = 0. To get the size of the primary body, you have to call structure->part[0]->bytes.  To get the size of the whole message, either strlen(imap_body) or add up the ->bytes of all the parts.



Another interesting note: 

When there is body text and no attachements:

count($struct->parts) = 0

When there is body text and 1 attachement:

count($struct->parts) = 2



These imap functions could really use better documentation. Like giving the meathods for the dparameter and parameter classes...

down

php AT firstnetimpressions.com ¶

22 years ago

Point of clarification:

The seventh primary body type is not "Other" as documented, but actually "Model".  This encompasses IGES, VRML, MESH, DWF, etc.

http://www.isi.edu/in-notes/iana/assignments/media-types/media-types

"Other" is the eigth primary body type.

down

chrislhill at "O_o" hotmail dot com ¶

21 years ago

For people just beging this may help alot as I spent a couple hours just trying to relize how exact the array was stored. (at the time I did not know the print_r function :P)

$struct = imap_fetchstructure($mbox, $msgnumber);
print_r($struct);

Will give you a better example for your messages but they are called as $struct using the varible method above.

$struct->type; //would return the type
$struct->encoding //would return the encoding 

and etc..

This can be done many different ways but that is the basics on pulling the info out of the structure of fetchstructure itself, I hope it helps someone starting because it wouldve helped me :/.

down

sirber at detritus dot qc dot ca ¶

18 years ago

"Primary body type" of "unknown/unknown" will be int(9).

down

masterbassist ¶

19 years ago

I think the following line (when building attachment information)

>>> "filename" => $parts[$i]->parameters[0]->value

needs to be

>>> "filename" => $parts[$i]->dparameters[0]->value

The first version generated a PHP warning under PHP 5.0.3.  The second version actually gets the filename.

down

phpnet,a,emailaddress,cjb,net ¶

17 years ago

Another comment to inform people about something that should really be in the function description:

imap_fetchstructure() downloads the entire email, attachments and all, rather than just the structure.
I guess it's an undocumented feature, not a bug.

I had assumed that the script would have only downloaded the amount of data that was returned, but my script downloaded a cumulative 2.5gig before i noticed.  Hopefully no-one else will have this happen.

down

hello at ivanbogomolov dot ru ¶

5 years ago

If you logic based on compare structure strings, you must compare it case insensetive.
<?php

$p = imap_fetchstructure($this->_imap_resource, $mid);
//do not compare $p->disposition == 'INLINE' 
if(preg_match('/inline/i', $p->disposition)) 
{
 //this works
}
?>

down

alchrystal88 at web dot de ¶

5 years ago

If you have errors with wrong attachment names like this:

correct name:
String -> Prüfbericht Hersteller.pdf

fetchstructure object name:
 =?ISO-8859-1?Q?Pr=FCfbericht_Hersteller=2Epdf?=

Workaround to reconvert:

imap_mime_header_decode($fetchstructure->dparameters->value)[0]->text

imap_mime_header_decode($filename)[0]->text

down

es96 at hotmail dot com ¶

21 years ago

If you are getting CHARSET as US-ASCII even if the header has a Content-Type: field, make sure the header also has a MIME-Version: field.

For example, the following header will correcty report charset as KOI8-R

MIME-Version: 1.0
Content-Type: text/plain; charset="koi8-r"

Without the MIME-Version it will be reported as US-ASII

Atelier ”慶”

WEBクリエイター歴２０年、最先端技術と安心をお届けします。

PHPのお勉強！

imap_fetchstructure

説明

パラメータ

戻り値

変更履歴

参考

Found A Problem?

User Contributed Notes 12 notes