mn8 Language Reference | Index    

POP3Handler

SUMMARY: NO ATTRIBUTES  NO ELEMENTS  CONSTRUCTORS SUMMARY  NO OPERATORS  METHODS SUMMARYDETAIL: NO ATTRIBUTES  NO ELEMENTS  CONSTRUCTOR DETAILS  NO OPERATORS  METHOD DETAILS

Description

POP3Handler concept working with Internet POP3 Protocol defined in RFC 1939. This concept is able to receive, delete and list messages form POP3 server.

URL format is : pop3://<hostName>/<POP3Command>

Possible POP3 commands :

if command missing you get lists of messages ID form POP3 server.

Possible options :

Usage

Connect to 'hostName' named POP3 server with 'userName' and 'password' and get message with specified 'ID', and shows it.

            $x from "pop3://hostName/retrieve?id=ID" options "user"="userName","pwd"="passowrd"
            print $x
        

Connect to 'hostName' named POP3 server with 'userName' and 'passwd' and get all messages form the mailbox and show message IDs.

            $x from "pop3://hostName/" options "user"="userName","pwd"="passwd"
            print $x
        

Connect to 'hostName' named POP3 server with 'userName' and 'passwd' and delete specified message (ID).

            $x from "pop3://hostName/delete?id=ID" options "user"="userName","pwd"="passwd"
        

Version: 0.1
Authors:Szabo Csaba
Inherits: Concept, URIHandler

Constructor List

create (String $url)
top

Method List

static LogicalacceptsURI (String $uri)
LogicalcloseConnection
ConceptgetContent
Logicalinitialize (Map $options)
LogicalopenConnection
LogicalsetContent (Concept $value)
top
Methods inherited from: Concept
cloneConcept, extendsConcept, fromXML, getAllInheritedConcepts, getConceptAttribute, getConceptAttributeField, getConceptAttributeFields, getConceptAttributes, getConceptConstructors, getConceptElement, getConceptElementField, getConceptElementFields, getConceptElements, getConceptLabel, getConceptMethod, getConceptMethods, getConceptOperators, getConceptType, getConceptsAtPath, getErrorHandler, getInheritedConcepts, hasConceptAttribute, hasConceptElement, hasConceptMethod, hasPath, isHidden, loadContent, setConceptLabel, setErrorHandler, setHidden, setShowEmpty, showEmpty, toTXT, toXML
Methods inherited from: URIHandler
acceptsURI, closeConnection, getContent, initialize, openConnection, setContent

Detailed Constructor Info

create (String $url)
Parameters:
$url :The url with which this POP3Handler will be created.

Creates a new POP3Handler concept with the given $url.

top

Detailed Method Info

static acceptsURI (String $uri)
Parameters:
$uri :The uri which will be tested if it is acceptable by this handler.
Returns: Logical

Returns true if the given $uri is acceptable by this handler, false otherwise.

top
closeConnection
Returns: Logical

Returns true if the closing of this connection was successfull, false otherwise.

top
getContent
Returns: Concept
Exceptions:
unknownCommand :
(Error)
If the command is unknown.
badURL :
(Error)
If the URL is not valid.

Returns the content of this handler.

top
initialize (Map $options)
Parameters:
$options :Contains a filter with which the returned content will be filtered.
Returns: Logical
Exceptions:
badURL :
(Error)
If the URL is not valid.

Returns true if the POP3Handler was initilized successfully, false otherwise.

top
openConnection
Returns: Logical
Exceptions:
userInfoMissing :
(Error)
If the username and password to login to POP3 server is missing.
badURL :
(Error)
If the URL is not valid.

Returns true if the connection can be establised with the remote server from this concept's url, false otherwise.

top
setContent (Concept $value)
Parameters:
$value :The value to be set.
Returns: Logical

Return false.

top