Smiling Souls

Steeped in the delicious tea like leaves of anthroposophy for the evolving soul.

Mail_IMAP::_defaultHeaderPid()

str|FALSE _defaultHeaderPid(int &$mid, str $pid)

The header part id is determined based on which part of the message is being viewed. Attached messages, for instance have headers of their own, like the message body, these headers are retrieved using a part id. The Mail_IMAP::_defaultHeaderPid() determines which is the proper part id for headers, whereas Mail_IMAP::getRawHeaders() and Mail_IMAP::getHeaders() selects the right headers to return or parse for the current message part.

Warning: As a method used internally by Mail_IMAP, Mail_IMAP::_defaultHeaderPid() should not be used directly. Its API has the potential of being changed in future releases, should I find a more efficient approach.

Method summary:

param int &$mid The message id.
param str $pid The part id.
return void
access private
see Mail_IMAP::getHeaders()

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.