PEAR Manual
Prev |  | Next

# Net_NNTP::getOverview()

Net_NNTP::getOverview() -- fetch a number of message headers

## Synopsis

    require_once 'Net/NNTP.php';

``array Net_NNTP::getOverview` (string $first, string $last)`

## Description

Returns all message headers in a certain range of the current selected newsgroup

## Parameter

- `$first` - start message id, start of the range

- `$last` - last message id, end of the range

## Return value

`array` - a nested array indicated by the message id of the article, every entry contains the header as array

    $msgs[message_id][headername] = headercontent

## Note

This function can not be called statically.

Warning
Be careful with choosing the range. It could requires some time to get a huge number of message headers.

## See

Net_NNTP::getOverviewFmt()

## Example

Example 48-1. Using getOverview()
    ...
    $ret = $nntp->connect("news.php.net");
    if( PEAR::isError($ret)) {
     // handle error
    } else {
     // print the last 10 messages
     $data = $nntp->selectGroup("php.pear.dev");
     $msgs = $nntp->getOverview( $data['last'] - 10, $data[last]);

     foreach($msgs as $msg) {
        // print subjects
        echo $msg['Subject'].'<br>';
     }
    }

Prev | Home | Next
Net_NNTP::getHeaders() | Up | Net_NNTP::getOverviewFmt()