net.sf.colossus.webcommon
Interface IColossusMail

All Known Implementing Classes:
ColossusMail

public interface IColossusMail

Describes the interface how the Game Server sends a mail. So far the only use case is to send a mail with confirmation code to complete a registration. The interface is needed because class User (which does send the registration mail) is also needed in WebClient, but the actual implementation exists only on Game Server side ( = webserver package).

Author:
Clemens Katzer

Method Summary
 java.lang.String sendConfirmationMail(java.lang.String username, java.lang.String email, java.lang.String confirmationCode)
          Request from the ColossusMail object to send the mail (with the confirmationCode) to the given email address, in order to complete the registration of user username
 

Method Detail

sendConfirmationMail

java.lang.String sendConfirmationMail(java.lang.String username,
                                      java.lang.String email,
                                      java.lang.String confirmationCode)
Request from the ColossusMail object to send the mail (with the confirmationCode) to the given email address, in order to complete the registration of user username

Parameters:
username - Name of user of which registration is ongoing
email - email address to where to send the mail
confirmationCode - the code user has to provide in the gui field in order to complete the registration
Returns:
The reason why it failed, or null if all is fine.