#include <request_email_validation.hpp>
Public Attributes | |
| std::string | clientSecret |
| A unique string generated by the client, and used to identify the validation attempt. More... | |
| std::string | |
| The email address to validate. More... | |
| int | sendAttempt |
The server will only send an email if the send_attempt is a number greater than the most recent one which it has seen, scoped to that email + client_secret pair. More... | |
| std::optional< std::string > | nextLink |
| Optional. More... | |
Member Data Documentation
◆ clientSecret
| std::string Kazv::Api::RequestEmailValidation::clientSecret |
A unique string generated by the client, and used to identify the validation attempt.
It must be a string consisting of the characters [0-9a-zA-Z.=_-]. Its length must not exceed 255 characters and it must not be empty.
| std::string Kazv::Api::RequestEmailValidation::email |
The email address to validate.
◆ nextLink
| std::optional<std::string> Kazv::Api::RequestEmailValidation::nextLink |
Optional.
When the validation is completed, the identity server will redirect the user to this URL. This option is ignored when submitting 3PID validation information through a POST request.
◆ sendAttempt
| int Kazv::Api::RequestEmailValidation::sendAttempt |
The server will only send an email if the send_attempt is a number greater than the most recent one which it has seen, scoped to that email + client_secret pair.
This is to avoid repeatedly sending the same email in the case of request retries between the POSTing user and the identity server. The client should increment this value if they desire a new email (e.g. a reminder) to be sent. If they do not, the server should respond with success but not resend the email.
The documentation for this struct was generated from the following file:
- src/api/identity/definitions/request_email_validation.hpp
