Richard York

Web Developer, Author, and Artist

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.

Method summary:

param int &$mid message id
param str $pid part id
param bool $rtn (optional) See above.
param bool $pid_check (optional) See above.
return str|bool
access public
see imap_fetchheader()
imap_fetchbody()
$option
Mail_IMAP::getHeaders()
Mail_IMAP::setOptions()
Mail_IMAP::_checkIfParsed()
Mail_IMAP::_defaultHeaderPid()

Comments

There are no comments posted at this time.

Leave a Comment

Simple HTML is allowed: <code>, <b>, <i>, <u>, <var>, <strong>, <em>, <blockquote>, <ul>, <ol>, <li>, <p> (no attributes). All spacing and line breaks in your comment will be preserved.

* All comments are moderated and are subject to approval.
Your comment will appear once it has been approved.
Posting multiple times will not expedite the approval process.

Comments are closed at this time.

© Copyright 2014 Hot Toddy, All Rights Reserved.