Net_NNTP
[ class tree: Net_NNTP ] [ index: Net_NNTP ] [ all elements ]
Packages:
Net_NNTP


Classes:
Net_NNTP_Client
Net_NNTP_Header
Net_NNTP_Message
Files:
Client.php
Client.php
group.php
Header.php
index.php
Message.php
read.php
Responsecode.php

Element index for package Net_NNTP

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ]

a

add
in file Header.php, method Net_NNTP_Header::add()
    Add a new field
authenticate
in file Client.php, method Net_NNTP_Client::authenticate()
    Authenticate
top

b

$body
in file Message.php, variable Net_NNTP_Message::$body
    Contains the body part of the message
top

c

clean
in file Header.php, method Net_NNTP_Header::clean()
    Remove any header field that only contains whitespace.
cleanArray
in file Header.php, method Net_NNTP_Header::cleanArray()
    Removes CRLF and misplaced empty lines before and after actual headerlines.
cleanString
in file Header.php, method Net_NNTP_Header::cleanString()
    Removes CRLF and misplaced empty lines before and after actual headerlines.
connect
in file Client.php, method Net_NNTP_Client::connect()
    Connect to the NNTP-server.
connectAuthenticated
in file Client.php, method Net_NNTP_Client::connectAuthenticated()
    Connect to the NNTP-server, and authenticate using given username and password.
count
in file Client.php, method Net_NNTP_Client::count()
    Number of articles in currently selected group
count
in file Header.php, method Net_NNTP_Header::count()
    Returns the number of times the given field tag appears in the header.
create
in file Message.php, method Net_NNTP_Message::create()
    Create a new instance of Net_NNTP_Message
create
in file Header.php, method Net_NNTP_Header::create()
    Create a new instance of Net_NNTP_Header
Client.php
procedural page Client.php
Client.php
procedural page Client.php
top

d

decodeString
in file Header.php, method Net_NNTP_Header::decodeString()
    Given a header/string, this function will decode it according to RFC2047.
delete
in file Header.php, method Net_NNTP_Header::delete()
    Delete a field
top

e

encodeString
in file Header.php, method Net_NNTP_Header::encodeString()
    Encodes the string given in $string as per RFC2047
top

f

$fields
in file Header.php, variable Net_NNTP_Header::$fields
    Container for the header fields
first
in file Client.php, method Net_NNTP_Client::first()
    Minimum article number in currently selected group
foldArray
in file Header.php, method Net_NNTP_Header::foldArray()
    Folds an array of RFC2822 style header lines.
foldString
in file Header.php, method Net_NNTP_Header::foldString()
    Folds a string by inserting CRLF's and TAB's where allowed
top

g

get
in file Header.php, method Net_NNTP_Header::get()
    Gets the value of a header field
getAll
in file Header.php, method Net_NNTP_Header::getAll()
    Gets the values of a all occurences of a field
getArticle
in file Client.php, method Net_NNTP_Client::getArticle()
    Get an article
getArticleRaw
in file Client.php, method Net_NNTP_Client::getArticleRaw()
    Get a article (raw data)
getBody
in file Client.php, method Net_NNTP_Client::getBody()
    Get the body of an article
getBody
in file Message.php, method Net_NNTP_Message::getBody()
    Gets the body
getBodyRaw
in file Client.php, method Net_NNTP_Client::getBodyRaw()
    Get the body of an article (raw data)
getDate
in file Client.php, method Net_NNTP_Client::getDate()
    Get the NNTP-server's internal date
getDescriptions
in file Client.php, method Net_NNTP_Client::getDescriptions()
    Fetches a list of all avaible newsgroup descriptions.
getFields
in file Header.php, method Net_NNTP_Header::getFields()
    Get the array of header fields.
getFieldsArray
in file Header.php, method Net_NNTP_Header::getFieldsArray()
    Export an array of RFC2822 style header style lines from the object.
getFieldsString
in file Header.php, method Net_NNTP_Header::getFieldsString()
    Export a string of RFC2822 style header style lines from the object.
getGroupArticles
in file Client.php, method Net_NNTP_Client::getGroupArticles()
    Experimental
getGroups
in file Client.php, method Net_NNTP_Client::getGroups()
    Fetches a list of all avaible newsgroups
getHeader
in file Message.php, method Net_NNTP_Message::getHeader()
    Gets the header object
getHeader
in file Client.php, method Net_NNTP_Client::getHeader()
    Get the header of an article
getHeaderRaw
in file Client.php, method Net_NNTP_Client::getHeaderRaw()
    Get the header of an article (raw data)
getMessageArray
in file Message.php, method Net_NNTP_Message::getMessageArray()
    Get the complete transport-ready message as an array
getMessageString
in file Message.php, method Net_NNTP_Message::getMessageString()
    Get the complete transport-ready message as a string
getNewGroups
in file Client.php, method Net_NNTP_Client::getNewGroups()
    Experimental
getNewNews
in file Client.php, method Net_NNTP_Client::getNewNews()
    Experimental
getOverview
in file Client.php, method Net_NNTP_Client::getOverview()
    Fetch message header fields from message number $first to $last
getOverviewFormat
in file Client.php, method Net_NNTP_Client::getOverviewFormat()
    Returns a list of avaible headers which are send from NNTP-server to the client for every news message
getReferencesOverview
in file Client.php, method Net_NNTP_Client::getReferencesOverview()
    Fetch a list of each message's reference header.
group
in file Client.php, method Net_NNTP_Client::group()
    Currently selected group
group.php
procedural page group.php
top

h

$header
in file Message.php, variable Net_NNTP_Message::$header
Header.php
procedural page Header.php
top

i

isConnected
in file Client.php, method Net_NNTP_Client::isConnected()
    Test whether a connection is currently open.
index.php
procedural page index.php
top

l

last
in file Client.php, method Net_NNTP_Client::last()
    Maximum article number in currently selected group
top

m

Message.php
procedural page Message.php
top

n

Net_NNTP_Client
in file Client.php, class Net_NNTP_Client
    Implementation of the client side of NNTP (Network News Transfer Protocol)
Net_NNTP_Client
in file Client.php, method Net_NNTP_Client::Net_NNTP_Client()
    Constructor
NET_NNTP_CLIENT_AUTH_GENERIC
in file Client.php, constant NET_NNTP_CLIENT_AUTH_GENERIC
NET_NNTP_CLIENT_AUTH_ORIGINAL
in file Client.php, constant NET_NNTP_CLIENT_AUTH_ORIGINAL
NET_NNTP_CLIENT_AUTH_SIMPLE
in file Client.php, constant NET_NNTP_CLIENT_AUTH_SIMPLE
Net_NNTP_Header
in file Header.php, method Net_NNTP_Header::Net_NNTP_Header()
    Constructor
Net_NNTP_Header
in file Header.php, class Net_NNTP_Header
    The Net_NNTP_Header class
NET_NNTP_HEADER_GET_DEFAULT
in file Header.php, constant NET_NNTP_HEADER_GET_DEFAULT
NET_NNTP_HEADER_GET_ENCODE
in file Header.php, constant NET_NNTP_HEADER_GET_ENCODE
NET_NNTP_HEADER_GET_FOLD
in file Header.php, constant NET_NNTP_HEADER_GET_FOLD
NET_NNTP_HEADER_SET_CLEAN
in file Header.php, constant NET_NNTP_HEADER_SET_CLEAN
NET_NNTP_HEADER_SET_DECODE
in file Header.php, constant NET_NNTP_HEADER_SET_DECODE
NET_NNTP_HEADER_SET_DEFAULT
in file Header.php, constant NET_NNTP_HEADER_SET_DEFAULT
NET_NNTP_HEADER_SET_KEEPCASE
in file Header.php, constant NET_NNTP_HEADER_SET_KEEPCASE
NET_NNTP_HEADER_SET_UNFOLD
in file Header.php, constant NET_NNTP_HEADER_SET_UNFOLD
Net_NNTP_Message
in file Message.php, class Net_NNTP_Message
    The Net_NNTP_Message class
Net_NNTP_Message
in file Message.php, method Net_NNTP_Message::Net_NNTP_Message()
    Constructor.
NET_NNTP_PROTOCOL_CLIENT_DEFAULT_HOST
in file Client.php, constant NET_NNTP_PROTOCOL_CLIENT_DEFAULT_HOST
    Default host
NET_NNTP_PROTOCOL_CLIENT_DEFAULT_PORT
in file Client.php, constant NET_NNTP_PROTOCOL_CLIENT_DEFAULT_PORT
    Default port
NET_NNTP_PROTOCOL_RESPONSECODE_ARTICLE_FOLLOWS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_ARTICLE_FOLLOWS
    'Article retrieved - head and body follow' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_ARTICLE_SELECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_ARTICLE_SELECTED
    'Article retrieved - request text separately' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_ACCEPTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_ACCEPTED
    'Authentication accepted' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_CONTINUE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_CONTINUE
    'More authentication information required' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_REJECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_REJECTED
    'Authentication rejected' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_REQUIRED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_REQUIRED
    'Authentication required' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_ACCEPTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_ACCEPTED
    'Authorization accepted' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_CONTINUE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_CONTINUE
    'Continue with authorization sequence' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_REJECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_REJECTED
    'Authorization rejected' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_REQUIRED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_AUTHORIZATION_REQUIRED
    'Authorization required for this command' (RFC2980)
NET_NNTP_PROTOCOL_RESPONSECODE_BASE64_ENCODING_ERROR
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_BASE64_ENCODING_ERROR
    'Error in base64-encoding [RFC3548] of an argument' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_BODY_FOLLOWS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_BODY_FOLLOWS
    'Article retrieved - body follows' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_CAPABILITIES_FOLLWOS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_CAPABILITIES_FOLLWOS
    'Capabilities list follows' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_GROUPS_FOLLOW
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_GROUPS_FOLLOW
    'Information follows' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_GROUP_SELECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_GROUP_SELECTED
    'Group selected' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_HEADERS_FOLLOW
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_HEADERS_FOLLOW
    'Headers follow' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_HEAD_FOLLOWS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_HEAD_FOLLOWS
    'Article retrieved - head follows' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_HELP_FOLLOWS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_HELP_FOLLOWS
    'Help text follows' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_INTERNAL_FAULT
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_INTERNAL_FAULT
    'Internal fault or problem preventing action being taken' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_NEW_ARTICLES_FOLLOW
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NEW_ARTICLES_FOLLOW
    'List of new articles follows' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_NEW_GROUPS_FOLLOW
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NEW_GROUPS_FOLLOW
    'List of new newsgroups follows' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_NOT_PERMITTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NOT_PERMITTED
    'Access restriction or permission denied' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NOT_SUPPORTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NOT_SUPPORTED
    'Program fault - command not performed' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_ARTICLE_SELECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_ARTICLE_SELECTED
    'No current article has been selected' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_GROUP_SELECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_GROUP_SELECTED
    'No newsgroup has been selected' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_NEXT_ARTICLE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_NEXT_ARTICLE
    'No next article in this group' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_PREVIOUS_ARTICLE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_PREVIOUS_ARTICLE
    'No previous article in this group' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_ARTICLE_ID
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_ARTICLE_ID
    'No such article found' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_ARTICLE_NUMBER
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_ARTICLE_NUMBER
    'No such article number in this group' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_GROUP
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_GROUP
    'No such news group' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_OVERVIEW_FOLLOWS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_OVERVIEW_FOLLOWS
    'Overview information follows' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_FAILURE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_FAILURE
    'Posting failed' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_PROHIBITED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_PROHIBITED
    'Posting not allowed' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_SEND
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_SEND
    'Send article to be posted' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_SUCCESS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_SUCCESS
    'Article posted ok' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_READY_POSTING_ALLOWED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_READY_POSTING_ALLOWED
    'Server ready - posting allowed' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_READY_POSTING_PROHIBITED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_READY_POSTING_PROHIBITED
    'Server ready - no posting allowed' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_SERVER_DATE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_SERVER_DATE
    'Server date and time' (Draft)
NET_NNTP_PROTOCOL_RESPONSECODE_SLAVE_RECOGNIZED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_SLAVE_RECOGNIZED
    'Slave status noted' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_SYNTAX_ERROR
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_SYNTAX_ERROR
    'Command syntax error' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_FAILURE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_FAILURE
    'Transfer failed - try again later' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_REJECTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_REJECTED
    'Article rejected - do not try again' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_SEND
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_SEND
    'Send article to be transferred' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_SUCCESS
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_SUCCESS
    'Article transferred ok' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_UNWANTED
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_UNWANTED
    'Article not wanted - do not send it' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_UNKNOWN_COMMAND
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_UNKNOWN_COMMAND
    'Command not recognized' (RFC977)
NET_NNTP_PROTOCOL_RESPONSECODE_WRONG_MODE
in file Responsecode.php, constant NET_NNTP_PROTOCOL_RESPONSECODE_WRONG_MODE
    'The server is in the wrong mode; the indicated capability should be used to change the mode' (Draft)
top

p

post
in file Client.php, method Net_NNTP_Client::post()
    Post an article to a number of newsgroups.
top

q

quit
in file Client.php, method Net_NNTP_Client::quit()
    Close connection to the newsserver
top

r

read.php
procedural page read.php
Responsecode.php
procedural page Responsecode.php
replace
in file Header.php, method Net_NNTP_Header::replace()
    Replace a field's value
reset
in file Header.php, method Net_NNTP_Header::reset()
    Reset the field container
reset
in file Message.php, method Net_NNTP_Message::reset()
    Resets the message object
top

s

selectArticle
in file Client.php, method Net_NNTP_Client::selectArticle()
    Selects an article by article message-number
selectGroup
in file Client.php, method Net_NNTP_Client::selectGroup()
    Selects a newsgroup
selectNextArticle
in file Client.php, method Net_NNTP_Client::selectNextArticle()
    Select the next article in current group
selectPreviousArticle
in file Client.php, method Net_NNTP_Client::selectPreviousArticle()
    Select the previous article in current group
setBody
in file Message.php, method Net_NNTP_Message::setBody()
    Sets the body
setFields
in file Header.php, method Net_NNTP_Header::setFields()
    Import RFC2822 style header lines given in $input into the object
setHeader
in file Message.php, method Net_NNTP_Message::setHeader()
    Sets the header's fields from the given $input
setMessage
in file Message.php, method Net_NNTP_Message::setMessage()
    Sets the header and body grom the given $message
splitMessage
in file Message.php, method Net_NNTP_Message::splitMessage()
    Splits the header and body given in $input apart (at the first blank line) and return them (in an array) with the same type as $input.
top

t

tags
in file Header.php, method Net_NNTP_Header::tags()
    Returns an array of all the tags that exist in the header.
top

u

unfoldArray
in file Header.php, method Net_NNTP_Header::unfoldArray()
    Do the (RFC822 3.1.1) header unfolding to an array of RFC2822 header lines.
unfoldString
in file Header.php, method Net_NNTP_Header::unfoldString()
    Do the (RFC822 3.1.1) header unfolding to a string of RFC2822 header lines.
top
Documentation generated on Mon, 11 Mar 2019 14:12:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.