Lister les emails

Post /blacklists/list

Paramètres :

Nom Description Type Obligatoire
type

Type de liste noire.

Valeurs disponibles :

  • bounces
  • unsubscribes
  • complaints
String Oui
list Disponibles pour les désabonnés et les plaintes, si vous avez créée une liste personnalisée. Par défaut, tout les désabonnés ou plaintes seront retournés String Non
pageSize Nombre d'éléments à retourner Int Non
page Numéro de la page Int Non
order Ordre du retour (0 (ASC) ou 1 (DESC) / basé sur la date d'ajout de l'email) Int Non

Réponse :

Nom Description Type
type

Tableau contenant les informations de chaque email dans la liste noire

Nom Description Type
email Adresse email String
date Date d'ajout Int
reason Date d'ajout String
list Nom de la liste personnalisée. Valable uniquement pour les désabonnés String
Array
total Nombre d'élements dans la liste noire Int
Langage de programmation :

Exemple de requête :

							{
								"pageSize": 10,
								"page": 1,
								"order": 1
							}
							

Exemple de réponse :

							{
								"bounces": [
									{
										"email": "email1@example.com",
										"date": 1438765958,
										"reason": ""
									},
									{
										"email": "email2@example.com",
										"date": 1438765958,
										"reason": ""
									}
								],
								"total": 200
							}
							

Exemple de code :

								curl -d '{"page":1,"pageSize":10}' -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/blacklists/list/unsubscribers
							
require 'vendor/autoload.php';

$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');

try {
	
	$list = null;
	$pageSize = 2;
	$page = 1;
	$order =1;
	
	$result = $tipimail->getBlacklistsService()->getBounces($pageSize, $page, $order);
	var_dump($result);
	
	$result = $tipimail->getBlacklistsService()->getComplaints($list, $pageSize, $page, $order);
	var_dump($result);
	
	$result = $tipimail->getBlacklistsService()->getUnsubscribers($list, $pageSize, $page, $order);
	var_dump($result);
		
}
catch(Tipimail\Exceptions\TipimailException $e) {
	echo 'Exception received :', $e->getMessage(), "\n";
	
}