13.2.1.2.4. Email Token¶
-
class
privacyidea.lib.tokens.emailtoken.
EmailTokenClass
(aToken)[source]¶ Implementation of the EMail Token Class, that sends OTP values via SMTP. (Similar to SMSTokenClass)
-
EMAIL_ADDRESS_KEY
= 'email'¶
-
check_otp
(*args, **kwds)[source]¶ check the otpval of a token against a given counter and the window
Parameters: passw (string) – the to be verified passw/pin Returns: counter if found, -1 if not found Return type: int
-
create_challenge
(*args, **kwds)[source]¶ create a challenge, which is submitted to the user
Parameters: - transactionid – the id of this challenge
- options – the request context parameters / data
Returns: tuple of (bool, message and data) bool, if submit was successful message is submitted to the user data is preserved in the challenge attributes - additional attributes, which are displayed in the
output
-
classmethod
get_class_info
(key=None, ret='all')[source]¶ returns all or a subtree of the token definition
Parameters: - key (string) – subsection identifier
- ret (user defined) – default return value, if nothing is found
Returns: subsection if key exists or user defined
:rtype : s.o.
-
is_challenge_request
(*args, **kwds)[source]¶ check, if the request would start a challenge
We need to define the function again, to get rid of the is_challenge_request-decorator of the HOTP-Token
Parameters: - passw – password, which might be pin or pin+otp
- options – dictionary of additional request parameters
Returns: returns true or false
-