Net_NNTP

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

Packages:
Net_NNTP

Classes:

Net_NNTP_Client
Net_NNTP_Header
Net_NNTP_Message
Net_NNTP_Protocol_Client

Files:

Client.php
Client.php
group.php
Header.php
index.php
Message.php
read.php

Class: Net_NNTP_Message

Source Location: /Net_NNTP-1.2.2/NNTP/Message.php

Class Overview

The Net_NNTP_Message class

Author(s):

Heino H. Gehlsen <heino at gehlsen.dk>

Version:

$Id: Message.php,v 1.8 2005年01月08日 20:03:29 heino Exp $

Inherited Variables

Inherited Methods

Class Details

[line 80]
The Net_NNTP_Message class

Author: Heino H. Gehlsen <heino@gehlsen.dk>
Version: $Id: Message.php,v 1.8 2005年01月08日 20:03:29 heino Exp $
See: Net_NNTP_Header
Since: Class available since Release 0.10.0
Access: public

[ Top ]

Class Variables

$body =

[line 98]

Contains the body part of the message

Access: public

Type: string

[ Top ]

$header =

[line 90]

Type: mixed

[ Top ]

Method Detail

Net_NNTP_Message (Constructor) [line 108]

Net_NNTP_Message Net_NNTP_Message(
)

Constructor.

Access: public

[ Top ]

create [line 145]

void &create(
[optional
$input = null], [optional
$input2 = null])

Create a new instance of Net_NNTP_Message

Since: 0.1
Access: public

Parameters:

optional $input — mixed $input Can be any of the following: (string) RFC2822 message lines (RCLF included) (array) RFC2822 message lines (RCLF not included) (object) Net_NNTP_Header object (object) Net_NNTP_Message object

optional $input2 — mixed $input2 If given, $input will only be use for the message's header, while $input2 will be used for the body. (Disallowed when $input is a Net_NNTP_Message)

[ Top ]

getBody [line 376]

string getBody(
)

Gets the body

Access: public

[ Top ]

getHeader [line 343]

object getHeader(
)

Gets the header object

Access: public

[ Top ]

getMessageArray [line 278]

string getMessageArray(
)

Get the complete transport-ready message as an array

Access: public

[ Top ]

getMessageString [line 264]

string getMessageString(
)

Get the complete transport-ready message as a string

Access: public

[ Top ]

reset [line 121]

void reset(
)

Resets the message object

Access: public

[ Top ]

setBody [line 358]

void setBody(
mixed
$body)

Sets the body

Access: public

Parameters:

mixed $body — Array or string

[ Top ]

setHeader [line 303]

void setHeader(
mixed
$input)

Sets the header's fields from the given $input

Access: public

Parameters:

mixed $input — Can be any of the following: (string) RFC2822 message lines (RCLF included) (array) RFC2822 message lines (RCLF not included) (object) Net_NNTP_Header object

[ Top ]

setMessage [line 221]

void setMessage(
mixed
$message)

Sets the header and body grom the given $message

Access: public

Parameters:

mixed $message — Can be any of the following: (string) RFC2822 message lines (RCLF included) (array) RFC2822 message lines (RCLF not included) (object) Net_NNTP_Message object

[ Top ]

splitMessage [line 393]

array splitMessage(
mixed
$input)

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.

Return: Contains separated header and body sections in same type as $input
Access: public

Parameters:

mixed $input — Message in form of eiter string or array

[ Top ]