Lecture et recherche dans votre boîte de réception avec une API REST

La documentation complète peut être trouvée ici

Image montrant le code

Authentification

Pour pouvoir utiliser cette API et appeler le service de messagerie, vous devez d'abord vous authentifier et obtenir votre jeton Web JSON (JWT).

curl -X POST "https://api.ijpuk.com/api/v1/authenticate" -H "accept: application/json" -H "authorization: Basic {your base64 encoded username:password}" -d "Content-Length: 0"

Dans l'exemple ci-dessus, {your base64 encoded 'username:password'} , doit être remplacé par le jeton obtenu à partir de cette page

Faire cette demande retourne quelque chose de similaire à ce qui est montré ci-dessous. Le contenu du jeton renvoyé est requis pour les futurs appels au service de messagerie

{
   "token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IlVfSUFOXzQwSUpQVUsuQ09NIiwiY2VydHRodW1icHJpbnQiOiI0cW85WjVaTW1QOC9ibm1iKzMrclFBPT0iLCJzdWIiOiJpYW5AaWpwdWsuY29tIiwianRpIjoiODVkaaa3ODQtMjZhZC00Nzk0LWE1NzItZTQzMjRjMWQ1MzUxIiwiaWF0IjoxNTM4MzMwMTI1LCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9wb3N0YWxjb2RlIjoiOTAuMjQwLjcwLjE0MCIsIm5iZiI6MTUzODMzMDEyNSwiZXhwIjoxNTM4MzMzNzI1LCJpc3MiOiJpanB1ay13ZWIuYXp1cmV3ZWJzaXRlcy5uZXQiLCJhdWQiOiJpanB1ay13ZWIuYXp1cmV3ZWJzaXRlcy5uZXQifQ.KwEq01gWlNSqVSnUM1MJp1Y9pRx6wFPR3Mx8MptC-YI"
}

Pour lister tous les messages dans votre boîte e-mail

Cet appel renvoie une liste de tous les courriers électroniques de votre boîte de réception. Les informations renvoyées sont supposées être brèves. Un message électronique plus détaillé est renvoyé voir "Pour récupérer votre message"

curl -X GET "https://api.ijpuk.com/api/v1/message" -H "accept: application/json" -H "mailServerKey: {your mail server key}" -H "Authorization: bearer {your token here}"

Réponse

[
   {
       "id":"6509",
       "subject":"Life 360 - Ian has Just arrived at \"Ian Home\"",
       "dateSent":"2018-07-29T16:56:36+00:00"
   },
   {
       "id":"6514",
       "subject":"Life 360 - Ian has Just left \"Ian Home\"",
       "dateSent":"2018-07-31T16:53:11+00:00"
   }
]

Pour récupérer votre message électronique

Pour récupérer plus de détails sur un e-mail spécifique, spécifiez simplement l'Id de l'e-mail.

curl -X GET "https://api.ijpuk.com/api/v1/message/{email id}" -H "accept: application/json" -H "mailServerKey: {your mail server key}" -H "Authorization: bearer {your token here}"

Réponse

{
   "isPlainText":true,
   "isHtml":true,
   "text":"Just arrived at Ian Home",
   "id":"6526",
   "subject":"Life 360 - Ian has Just arrived at \"Ian Home\"",
   "dateSent":"2018-09-01T11:40:28+00:00"
}

Pour supprimer un courrier électronique

Cet appel supprimera un e-mail spécifique de votre compte e-mail. Spécifiez simplement l'identifiant de messagerie.

curl -X DELETE "https://api.ijpuk.com/api/v1/message/{email id}" -H "accept: application/json" -H "mailServerKey: {your mail server key}" -H "Authorization: bearer {your token here}"

Pour rechercher vos courriels

Cet appel d'API analysera les notifications par courrier électronique dans votre boîte aux lettres et renverra une liste de correspondances.

curl -X POST "https://api.ijpuk.com/api/v1/message/search" -H "accept: application/json" -H "mailServerKey: {your mail server key}" -H "Authorization: bearer {your token here}" -H "Content-Type: application/json" -d "{ \"matchConditions\": [ { \"regEx\": \"Ian (?'status'.+) Home\", \"type\": \"setPresence\", \"parts\": [ { \"variableName\": \"IanHome\", \"regExGroupName\": \"status\", \"matchConditions\": [ \"left\", \"arrived at\", \"is at\" ] } ] }, { \"regEx\": \"^Weather Report: (?'WeatherCapture'.+) today$\", \"type\": \"setWeather\", \"parts\": [ { \"variableName\": \"Weather\", \"regExGroupName\": \"WeatherCapture\" ] } ]}"