#include <request_email_validation.h>

Public Attributes
QString	clientSecret

QString	email
	The email address to validate. More...

int	sendAttempt

QString	nextLink {}

QString	idServer {}

QString	idAccessToken {}

Detailed Description

Definition at line 9 of file request_email_validation.h.

Member Data Documentation

◆ clientSecret

QString Quotient::EmailValidationData::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.

Definition at line 14 of file request_email_validation.h.

◆ email

QString Quotient::EmailValidationData::email

The email address to validate.

Definition at line 17 of file request_email_validation.h.

◆ idAccessToken

QString Quotient::EmailValidationData::idAccessToken {}

An access token previously registered with the identity server. Servers can treat this as optional to distinguish between r0.5-compatible clients and this specification version.

Required if an id_server is supplied.

Definition at line 47 of file request_email_validation.h.

◆ idServer

QString Quotient::EmailValidationData::idServer {}

The hostname of the identity server to communicate with. May optionally include a port. This parameter is ignored when the homeserver handles 3PID verification.

This parameter is deprecated with a plan to be removed in a future specification version for /account/password and /register requests.

Definition at line 40 of file request_email_validation.h.

◆ nextLink

QString Quotient::EmailValidationData::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.

Definition at line 32 of file request_email_validation.h.

◆ sendAttempt

int Quotient::EmailValidationData::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.

Definition at line 27 of file request_email_validation.h.

The documentation for this struct was generated from the following file:

Quotient/csapi/definitions/request_email_validation.h

Public Attributes