c.l.i.l.ILoginToken(IAuthToken) : interface documentation

Part of canonical.launchpad.interfaces.logintoken View In Hierarchy

Known implementations: canonical.launchpad.database.logintoken.LoginToken

The object that stores one time tokens used for validating email addresses and other tasks that require verifying if an email address is valid such as password recovery, account merging and registration of new accounts. All LoginTokens must be deleted once they are "consumed".
Text fingerprint Undocumented
Text validation_phrase Undocumented
Method destroySelf Remove this LoginToken from the database.
Method sendGPGValidationRequest Send an email message with a magic URL to confirm the OpenPGP key.
Method sendProfileCreatedEmail Notify the profile's email owner that a new profile was created.
Method sendMergeRequestEmail Send an email to self.email (the dupe account's email address)
Method sendTeamEmailAddressValidationEmail Send an email to self.email containing a URL to the page where it
Method sendClaimProfileEmail Send an email to self.email with instructions on how to finish
Method sendClaimTeamEmail E-mail instructions for claiming a team to self.email.
Method activateGPGKey Activate a GPG key.
Method createEmailAddresses Create EmailAddresses for the GPG UIDs that do not exist yet.

Inherited from IAuthToken:

Int id Undocumented
Datetime date_created Undocumented
Datetime date_consumed Undocumented
Choice tokentype Undocumented
Text token Undocumented
Int requester Undocumented
Int requester_account Undocumented
Text requesteremail Undocumented
TextLine email Undocumented
Text redirection_url Undocumented
Attribute title Title
PasswordField password Undocumented
Method consume Mark this token as consumed by setting date_consumed.
Method sendEmailValidationRequest Send an email message with a magic URL to validate self.email.
Method sendPasswordResetEmail Send an email message to the requester with a magic URL that allows
Method sendNewUserEmail Send an email message to the requester with a magic URL that allows
fingerprint =
Undocumented
validation_phrase =
Undocumented
def destroySelf():
Remove this LoginToken from the database.

We need this because once the token is used (either when registering a new user, validating an email address or reseting a password), we have to delete it so nobody can use that token again.

def sendGPGValidationRequest(key):
Send an email message with a magic URL to confirm the OpenPGP key. If fingerprint is set, send the message encrypted.
def sendProfileCreatedEmail(profile, comment):
Notify the profile's email owner that a new profile was created.

Send an email message to this token's email address explaining that another user has created a launchpad profile for him and providing a link where he can finish the registration process.

def sendMergeRequestEmail():
Send an email to self.email (the dupe account's email address) with the URL of a page to finish the merge of Launchpad accounts.
def sendTeamEmailAddressValidationEmail(user):
Send an email to self.email containing a URL to the page where it can be set as the requester's (the team) contact address.

The message also includes the team administrator who made this request on behalf of the team.

def sendClaimProfileEmail():
Send an email to self.email with instructions on how to finish claiming the profile that owns self.email.
def sendClaimTeamEmail():
E-mail instructions for claiming a team to self.email.
def activateGPGKey(key, can_encrypt):
Activate a GPG key.
ReturnsA Launchpad key, whether it's new, email addresses that were created, email addresses owned by someone else.
def createEmailAddresses(uids):
Create EmailAddresses for the GPG UIDs that do not exist yet.

For each of the given UIDs, check if it is already registered and, if not, register it.

Return a tuple containing the list of newly created emails (as strings) and the emails that exist and are already assigned to another person (also as strings).

API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.