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

Class: ListMailboxesCommand

Source Location: /commands/mail/ListMailboxesCommand.php

Class Overview


Displays all the accessible UniteMail mailbox for the specified user.


Implements interfaces:

Methods



Class Details

[line 9]
Displays all the accessible UniteMail mailbox for the specified user.

If no user is given, this command defaults to displaying all your accesible UniteMail mailboxes.




[ Top ]


Class Methods


constructor __construct [line 17]

ListMailboxesCommand __construct( [ $fid = 0])



Tags:

access:  public


Parameters:

   $fid  

[ Top ]

method commandName [line 22]

void commandName( )



Tags:

access:  public



Implementation of:
Command::commandName()
Name of the command
[ Top ]

method getFID [line 46]

void getFID( )



Tags:

access:  public


[ Top ]

method getMailboxes [line 51]

void getMailboxes( )



Tags:

access:  public


[ Top ]

method parseRequest [line 32]

void parseRequest( RequestGenerator $req)



Tags:

access:  public



Implementation of:
Command::parseRequest()
Used to convert the command into a request we can issue to the FastVision API reseller servers.

Parameters:

RequestGenerator   $req  

[ Top ]

method parseResponse [line 37]

void parseResponse( $xml)



Tags:

access:  public



Implementation of:
Command::parseResponse()
Used to convert the response command into a request we can issue to the FastVision API reseller servers.

Parameters:

SimpleXMLElement   $xml  

[ Top ]

method requiresAuthentication [line 27]

void requiresAuthentication( )



Tags:

access:  public



Implementation of:
Command::requiresAuthentication()
Does the connection need to be authenticated prior to issuing this command? (Boolean)
[ Top ]


Documentation generated on Mon, 30 Mar 2009 16:34:36 +0100 by phpDocumentor 1.4.1