PEAR Manual
Prev |  | Next

# Net_NNTP::prepareConnection()

Net_NNTP::prepareConnection() -- connects to a newsgroup on a newsserver

## Synopsis

    require_once 'Net/NNTP.php';

``boolean Net_NNTP::prepareConnection` (string $nntpserver [, integer $port = 119, integer $newsgroup [, integer $user = `NULL` [, integer $pass = `NULL`, integer [$authmode = PEAR_NNTP_ORIGINAL]]]])`

## Description

Connect to a specific newsserver and access the given newsgroup

Warning
This function is deprecated. That means that future versions of this package may not support it anymore.

Consider this method deprecated - use Net_NNTP::connectAuthenticated() instead.

## Parameter

- `$nntpserver` - Name of the newsserver to connect

- `$port` - Port, where the newsserver listens

- `$newsgroup` - Newsgroup to access

- `$user` - Username to authenticate

- `$user` - Username to authenticate

- `$pass` - Password to authenticate

- `$authmode` - Type of authentication, at the moment only `PEAR_NNTP_AUTHORIGINAL`

## Return value

`boolean` - `TRUE` if successful

## Throws

Table 48-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | `"Could not connect to NNTP-server $nntpserver"` or `"Not connected"` | The connection couldn't be established because wrong server name or adress the host itself isn't link to a network a firewall doesn't allow an access | Check for server name, the connection to the net and possible firewalls on client or server side
`NULL` | Every other message | This message is directly passed from the news server, in the most cases caused by calling a non existing newsgroup | Check the given newsgroup name

## Note

This function can not be called statically.

Warning
This function is deprecated. That means that future versions of this package may not support it anymore.

Fetching data with a connection created with prepareConnection() is faster then a created connection with connect()

## See

Net_NNTP::quit(), Net_NNTP::connect()

## Example

Example 48-1. Using prepareConnection()
    require_once "Net/NNTP.php";

    $nntp = new Net_NNTP;
    $ret = $nntp->connect("news.php.net", 119, "php.pear.dev");
    if( PEAR::isError($ret)) {
     // handle error
    } else {
     // success
    }

Prev | Home | Next
Net_NNTP::post() | Up | Net_NNTP::quit()