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

Class: SetMailboxPasswordCommand

Source Location: /commands/mail/SetMailboxPasswordCommand.php

Class Overview


Resets the password for a UniteMail mailbox.


Implements interfaces:

Methods



Class Details

[line 10]
Resets the password for a UniteMail mailbox.

This command can be used if you have forgotten the password to your mailbox, or wish to change your mailbox password. This command can also be used by e-mail services resellers who wish to reset the password to their customers UniteMail mailboxes.




[ Top ]


Class Methods


constructor __construct [line 18]

SetMailboxPasswordCommand __construct( $mailbox, $newPassword)



Tags:

access:  public


Parameters:

   $mailbox  
   $newPassword  

[ Top ]

method commandName [line 24]

void commandName( )



Tags:

access:  public



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

method getMailbox [line 45]

void getMailbox( )



Tags:

access:  public


[ Top ]

method parseRequest [line 34]

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 40]

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 29]

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:38 +0100 by phpDocumentor 1.4.1