Lister les identifiants SMTP

GET /api/email/credentials

Renvoie une liste des identifiants SMTP connus.

Request Headers:

• Authorization – Les identifiants de l’utilisateur

Parameters:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sort ([email+|email-]) – Le paramètre selon lequel les identifiants seront triés (défaut: email+)

Status Codes:

• 200 OK – La liste a été renvoyée avec succès

• 400 Bad Request – Requête invalide

• 401 Unauthorized – Authentification REST invalide

• 403 Forbidden – L’utilisateur REST n’a pas le droit d’effectuer cette action

Response JSON Object:

• credentials (array) – La liste des identifiants SMTP demandés

Response JSON Array of Objects:

• emailAddress (string) – L’adresse email de l’expéditeur.

• serverAddress (string) – L’adresse du serveur SMTP.

• login (string) – Le login de connexion au serveur SMTP.

• password (string) – Le mot de passe de connexion au serveur SMTP.

Exemple de requête

GET https://my_waarp_gateway.net/api/email/credentials?limit=10&sort=email+ HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 160

{
  "credentials": [{
    "emailAddress": "gateway@example.com",
    "serverAddress": "smtp.example.com:587",
    "login": "gateway",
    "password": "secret"
  }]
}