* Ensures that only one IMP_Contents instance for any given message is
* available at any one time.
*
- * @param mixed $in Either a uid string (see IMP_Contents::singleton()
- * for the format) or a Horde_Mime_Part object.
+ * @param mixed $in Either a UID string (UID . IMP::IDX_SEP . Mailbox) or
+ * a Horde_Mime_Part object.
*
* @return IMP_Contents The IMP_Contents object.
* @throws Horde_Exception
/**
* Constructor.
*
- * @param mixed $in Either a uid string (see IMP_Contents::singleton()
- * for the format) or a Horde_Mime_Part object.
+ * @param mixed $in Either a UID string (UID . IMP::IDX_SEP . Mailbox) or
+ * a Horde_Mime_Part object.
* @throws Horde_Exception
*/
protected function __construct($in)
* @param integer $mbox The message mailbox (defaults to the current
* mailbox).
*
- * @return integer The array index of the location of the message UID in
- * the current mailbox.
+ * @return mixed The array index of the location of the message UID in
+ * the current mailbox. Returns null if not found.
*/
public function getArrayIndex($uid, $mbox = null)
{