Mail_IMAP::getRawHeaders()

string|bool getRawHeaders(int &$mid[, str $pid = '0' [, bool $rtn = TRUE [, bool $pid_check = FALSE]]])

Returns the raw headers of a message.

If the $rtn argument is set to FALSE, the raw headers will be placed in the $header property as $this->header[$mid]['raw'].

getRawHeaders is also called automatically by Mail_IMAP::getHeaders, which uses information returned by getRawHeaders to determine the appropriate headers to retrieve for a multipart message. The $pid_check argument is used by Mail_IMAP::getHeaders for this purpose.

Use the $option property or the Mail_IMAP::setOptions method to set optional arguments for imap_fetchheader or imap_fetchbody, which are both called on in getRawHeaders.

getRawHeaders calls on Mail_IMAP::_checkIfParsed and Mail_IMAP::_defaultHeaderPid internally.