PHP: Hypertext Preprocessor (original) (raw)

imap_fetchstructure

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

imap_fetchstructure — Read the structure of a particular message

Description

Parameters

imap

An IMAP\Connection instance.

message_num

The message number

flags

This optional parameter only has a single option, [FT_UID](imap.constants.php#constant.ft-uid), which tells the function to treat themessage_num argument as a UID.

Return Values

Returns an object with properties listed in the table below, or [false](reserved.constants.php#constant.false) on failure.

Returned Object for imap_fetchstructure()

Primary body type (value may vary with used library, use of constants is recommended)

Transfer encodings (value may vary with used library, use of constants is recommended)

Changelog

See Also

• imap_fetchbody() - Fetch a particular section of the body of the message
• imap_bodystruct() - Read the structure of a specified body section of a specific message

Found A Problem?

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.

`

mkknapp at quadrapod dot com ¶

24 years ago

`Assuming struct=imapfetchstructure(struct = imap_fetchstructure(struct=imapf​etchstructure(x,$y);

It is important to note that if a message has NO attachements, struct−>partsisanemptyarray,andstruct->parts is an empty array, and struct−>partsisanemptyarray,andstruct->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...

`

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=imapfetchstructure(struct = imap_fetchstructure(struct=imapf​etchstructure(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 :/.

`

sirber at detritus dot qc dot ca ¶

19 years ago

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

masterbassist ¶

20 years ago

`I think the following line (when building attachment information)

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

needs to be

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

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

`

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.

`

hello at ivanbogomolov dot ru ¶

6 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
}
?>`

alchrystal88 at web dot de ¶

6 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

`

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

`

jcastro at elnuevodia dot com ¶

22 years ago

I think the above note about attachments is wrong. I tested sending files with and without attachments and I get the following<br> with attachment: type=3 bytes=343648 no attachment: type=0 bytes=2 so checking for $struct->bytes == " " means nothing. At least in my test running windows 2000, php4.2.1 using outlook and exchange. It seems that cheking the type will be more reliable

hholzgra at media-engineering dot de ¶

25 years ago

`the parts objects are identical in
structure to those returned by imap_fetchstructure, describing one subfolder each

parameters and dparameters are MIME-specific, theese contain the
extra parameters provided in the Content-Type and Content-Disposion Header lines such as Charset or Filename

`