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

Class: NewMailboxCommand

Source Location: /commands/mail/NewMailboxCommand.php

Class Overview


Creates a new UniteMail mailbox and associates it with an existing order.


Implements interfaces:

Methods



Class Details

[line 10]
Creates a new UniteMail mailbox and associates it with an existing order.

New mailboxes can be purchased via the FastVision Hosting front-end, or via the `Place Order` command. This command is very useful for e-mail services resellers or anybody who wishes to automate the process of creating new UniteMail mailboxes for themselves or their customers.




[ Top ]


Class Methods


constructor __construct [line 30]

NewMailboxCommand __construct( $emailAddress, $mailboxType, $password, $name, [ $orderId = 0], [ $orderReference = ""])



Tags:

access:  public


Parameters:

   $emailAddress  
   $mailboxType  
   $password  
   $name  
   $orderId  
   $orderReference  

[ Top ]

method commandName [line 40]

void commandName( )



Tags:

access:  public



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

method parseRequest [line 50]

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

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

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