Aller au contenu principal

Les configurations d'envoi

Une configuration d'envoi, c'est quoi?​

La configuration d'un envoi est un aspect essentiel et indispensable pour le bon fonctionnement de vos campagnes emailing.

On y retrouve notamment:

  • L’adresse email de l’expéditeur (ex : newslette@news.mindbaz.com)
  • L’alias de l’expéditeur (ex : Mindbaz)
  • Le mail de réponse (ex : contact@mindbaz.com)
  • Le header HTML, qui contient généralement le lien de la page miroir de votre email
  • Le footer HTML, qui contient généralement le lien de désabonnement.
attention

Il est obligatoire de sélectionner une configuration d'envoi pour envoyer une campagne email.

Le type Config​

L'api utilise un objet de type Config pour faire des GET/POST/PUT.

PARAMÈTRES GENERAUX​

  • name : Le nom de la configuration d’envoi
    255 caractères max.
    C’est un élément obligatoire. Pensez à choisir un nom unique de manière à ne pas confondre les configurations d’envoi disponibles sur votre BDD MINDBAZ.
  • objectPrefixBAT : Identifier vos envois tests en ajoutant “[BAT]” dans l'objet.
    Cette option vous permet d’ajouter le suffixe [BAT] au début de l'objet de vos envois de BAT (ex: "[BAT] Objet de mon email")
  • senderAliasPrefixBAT : Identifier vos envois tests en ajoutant “[BAT]” dans l'expéditeur.
    Cette option vous permet d’ajouter le préfixe [BAT] au début l’alias du mail de l’expéditeur (Ex > [BAT] MINDBAZ)

PARAMÈTRES D’EN-TÊTES​

  • senderEMail : L’adresse email de l’expéditeur.
    255 caractères max.
    C’est l’adresse email expéditrice de vos emails envoyés avec cette configuration d’envoi. L’adresse email expéditrice utilise le domaine d’envoi que vous avez souhaité utiliser (et dont les délégations DNS ont été effectuées par vos soins. Par exemple, newsletter@news.mindbaz.com est une adresse d’expéditeur.
    Une erreur sera retournée si vous soumettez un email avec un mauvais domaine expéditeur.
    L’adresse email de l’expéditeur est un élément très important pour la délivrabilité de vos messages.

  • senderAlias: L’alias de l’expéditeur (ex: Mindbaz)
    50 caractères maximum.
    C’est le nom de l’entité qui envoie les emails, généralement le nom de votre entreprise. Vous avez la possibilité de personnaliser cet alias en utilisant des tags de personnalisation. Cet élément n’est pas obligatoire. Si vous ne précisez pas d’Alias d’expéditeur, l’adresse email de l’expéditeur sera alors utilisée comme alias de l’expéditeur par défaut.

  • responseEMail: L'email de réponse (ex: contact@mindbaz.com)
    255 caractères maximum.
    Il s’agit de l’adresse email utilisée lorsque vos contacts cliquant sur “Répondre” suite à la réception d’un email. Il est conseillé de saisir une adresse email valide afin de pouvoir prendre connaissance des emails de réponses que vous recevez. Certains abonnés, par exemple, demandent de se désabonner en répondant à un email plutôt qu’en utilisant le lien de désabonnement prévu à cet effet. Nous vous conseillons d’éviter les adresses de type “no-reply@sousdomaine.com”.

  • responseAlias :L’Alias de réponse.
    50 caractères maximum.
    Il s’agit du nom à qui sera envoyé l’email lorsqu’un abonné clique sur “répondre” suite à la réception d’un email. Plutôt que d’afficher l’adresse email de réponse (décrite ci-dessus), l’Alias sera alors affiché. Ex : Service Client Mindbaz sera affiché plutôt que “contact@mindbaz.com” lorsqu’un abonné clique sur “répondre” suite à la réception d’un email

  • recipientAlias : L’Alias du destinataire.
    Cette option a pour but de remplacer l’adresse email "to" par un alias contenant des tags de personnalisation.

CONTENUS PRÉDÉFINIS HTML ET TEXTE​

  • headerHtml : L’en-tête HTML
    L’entête HTML correspond à du contenu HTML qui affiché en header de votre email.
    Par défaut, le code HTML présent dans une nouvelle configuration d’envoi contient un lien vers la page miroir de chaque email utilisant cette configuration d’envoi.
    Vous pouvez personnaliser ce code HTML, voire le supprimer si vous souhaitez ajouter le lien vers la page miroir directement dans le HTML de vos emails.
    Le tag de personnalisation à utiliser pour le lien de page miroir est [[URL.2]].
    Pour créer un lien vers la page miroir de votre email, il vous suffit donc d’ajouter le code suivant au sein du HTML de votre email.
<a href=”[[URL.2]]” target=”_blank”>votre texte</a>

  • headerTxt : L’en-tête texte
    L’en-tête texte fonctionne sur le même principe que l’en-tête HTML, mais il s’agit de texte brut. Cet en-tête est donc affiché uniquement si le destinataire de l’email ne peut afficher du contenu HTML dans sa boite email.

  • unsubHtml : Le HTML du désabonnement
    Le désabonnement HTML correspond à du contenu HTML affiché en footer de votre email. Par défaut, le code HTML présent dans une nouvelle configuration d’envoi contient un lien vers le formulaire de désabonnement propre à MINDBAZ et permettant de prendre en compte les désabonnements de votre BDD MINDBAZ.
    Vous pouvez personnaliser ce code HTML, voire le supprimer si vous souhaitez ajouter le lien vers le formulaire de désabonnement directement dans le HTML de vos emails. Le tag de personnalisation à utiliser pour le lien de désabonnement [[URL.1]]
    Pour créer un lien vers le formulaire de désabonnement, il vous suffit donc d’ajouter le code suivant au sein du HTML de votre email:

<a href=”[[URL.1]]” target=”_blank”>votre texte</a>

  • unsubTxt :La version texte du désabonnement
    Le désabonnement texte fonctionne sur le même principe que le désabonnement HTML, mais il s’agit de texte brut. Cette zone est donc affichée uniquement si le destinataire de l’email ne peut afficher du contenu HTML dans sa boite email.

  • footerHtml : Le HTML du pied de page
    Le pied de page HTML est, comme le désabonnement, du contenu HTML que vous pouvez paramétrer par défaut. Ce contenu est utile pour afficher, par exemple, des mentions légales qui seront présentes sur l’ensemble des emails qui utilisent la configuration d’envoi concernée.

  • footerTxt: La version texte du pied de page
    Le pied de page texte fonctionne sur le même principe que le pied de page HTML, mais il s’agit de texte brut. Cette zone est donc affichée uniquement si le destinataire de l’email ne peut afficher du contenu HTML dans sa boite email.

L'api Configs​

Avec l'api Configs, vous pourrez créer, modifier,dupliquer, supprimer et récupérer les configurations d'envoi de votre base de données.

Créer une configuration d'envoi​

L'api Configs permet de créer une configuration d'envoi en faisant un appel POST /api/{idsite}/Configs.

L'api prend en paramètre d'entrée un objet Config (sans id).

Exemple de création de configuration 

{
  "name": "Ma configuration de test",
  "creationDate": "2022-05-26T16:51:24",
  "lastModifiedDate": "2022-02-21T16:05:55",
  "senderEMail": "newsletter@news.mindbaz.com",
  "senderAlias": "Mindbaz",
  "recipientAlias": "[[FIELD.15]]",
  "responseEMail": "contact@mindbaz.com",
  "responseAlias": "Service Client Mindbaz",
  "headerHtml": "<table style=\"width: 100%;margin:auto;text-align:center;font-family:Lucida Grande,Verdana,sans-serif;\"><tr><td>Pour visualiser cet email dans votre navigateur, <a href=\"[[URL.2]]\" target=\"_blank\">cliquez ici</a></td></tr></table>",
  "headerTxt": "Pour visualiser cet email dans votre navigateur, cliquez ici [[URL.2]]",
  "footerHtml": null,
  "footerTxt": "footer\n",
  "unsubHtml": "<table style=\"width: 100%;margin:auto;text-align:center;font-family:Lucida Grande,Verdana,sans-serif;\"><tr><td>Vous désirez être retiré de nos listes de diffusions, <a href=\"[[URL.1]]\" target=\"_blank\">cliquez-ici</a></td></tr></table>",
  "unsubTxt": "Pour vous désabonner, suivez ce lien [[URL.1]]",
  "unsubiframeurl": "62|42|[[FIELD.1]][[FIELD.4]]",
  "objectPrefixBAT": "[BAT]"
}

En retour, on obtient l'objet créé avec son identifiant.

Consulter une configuration d'envoi​

L'api permet de consulter une configuration d'envoi en faisant un appel GET /api/{idsite}/Configs?filter.idconfig={idConfig}

Exemple : pour récupérer la configuration d'envoi 614: https://api.mindbaz.com/api/101/Configs?filter.idConfig=614

En retour, on obtien l'objet Config trouvé :

{
  "data": {
    "totalCount": 1,
    "count": 1,
    "items": [
      {
        "config": {
          "id": 614,
          "idUser": 13630,
          "name": "Config test 3 insert",
          "creationDate": "2022-03-01T17:55:07.643",
          "lastModifiedDate": "2022-03-01T17:55:07.643",
          "senderEMail": "newsletter@news.mindbaz.com",
          "senderAlias": "Mindbaz",
          "recipientAlias": "[[FIELD.15]]",
          "responseEMail": "contact@mindbaz.com",
          "responseAlias": "Service Client Mindbaz",
          "headerHtml": "<table style=\"width: 100%;margin:auto;text-align:center;font-family:Lucida Grande,Verdana,sans-serif;\"><tr><td>Pour visualiser cet email dans votre navigateur, <a href=\"[[URL.2]]\" target=\"_blank\">cliquez ici</a></td></tr></table>",
          "headerTxt": "Pour visualiser cet email dans votre navigateur, cliquez ici [[URL.2]]",
          "footerHtml": null,
          "footerTxt": "footer\n",
          "unsubHtml": "<table style=\"width: 100%;margin:auto;text-align:center;font-family:Lucida Grande,Verdana,sans-serif;\"><tr><td>Vous désirez être retiré de nos listes de diffusions, <a href=\"[[URL.1]]\" target=\"_blank\">cliquez-ici</a></td></tr></table>",
          "unsubTxt": "Pour vous désabonner, suivez ce lien [[URL.1]]",
          "unsubiframeurl": "62|42|[[FIELD.1]][[FIELD.4]]",
          "objectPrefixBAT": "[BAT]",
          "senderAliasPrefixBAT": null,
          "isArchive": false          
        },
        "author": null,
        "isFavourite": false
      }
    ],
    "start": 0
  },
  "error": null,
  "success": true,
  "typeName": "PagedResultsList`1"
}
info
  • Vous pouvez récupérer toutes les configurations d'envoi avec un GET sans fournir de paramètre : /api/{idsite}/Configs
  • Si vous voulez rechercher une configuration par son nom, il faut ajouter le paramètre filter.name={mot}.
    Par ex "/api/{idsite}/Configs?filter.name=test" retournera toutes les configurations d'envoi contenant le mot "test" dans le nom.

Mettre à jour une configuration d'envoi​

L'api permet de mettre à jour une configuration d'envoi en faisant un appel PUT /api/{idsite}/Configs?filter.idconfig={idConfig}

Exemple : pour mettre à jour la configuration d'envoi 614 avec un nouveau nom et la classer dans un nouveau répertoire on peut passer le Json suivant:

{
  "config": {
    "id": 614,
    "name": "Config test renamed",
    "senderEMail": "newsletter@news.mindbaz.com",
    "senderAlias": "Mindbaz",
    "recipientAlias": "[[FIELD.15]]",
    "responseEMail": "contact@mindbaz.com",
    "responseAlias": "Service Client Mindbaz",
    "headerHtml": "<table style=\"width: 100%;margin:auto;text-align:center;font-family:Lucida Grande,Verdana,sans-serif;\"><tr><td>Pour visualiser cet email dans votre navigateur, <a href=\"[[URL.2]]\" target=\"_blank\">cliquez ici</a></td></tr></table>",
    "headerTxt": "Pour visualiser cet email dans votre navigateur, cliquez ici [[URL.2]]",
    "footerTxt": "footer\n",
    "unsubHtml": "<table style=\"width: 100%;margin:auto;text-align:center;font-family:Lucida Grande,Verdana,sans-serif;\"><tr><td>Vous désirez être retiré de nos listes de diffusions, <a href=\"[[URL.1]]\" target=\"_blank\">cliquez-ici</a></td></tr></table>",
    "unsubTxt": "Pour vous désabonner, suivez ce lien [[URL.1]]",
    "unsubiframeurl": "62|42|[[FIELD.1]][[FIELD.4]]",
    "objectPrefixBAT": "[BAT]"    
  }
}
Attention!

Il est nécessaire de repasser l'objet complet pour mettre à jour tout ou partie des informations.

Supprimer une configuration d'envoi​

Il est possible de supprimer une configuration d'envoi. Cependant si celle-ci est utilisée par une campagne programmée ou en cours d'envoi, la suppression ne sera pas permise.

L'appel se fait avec un DELETE sur /api/{idSite}/Configs/{idConfig}

Exemple pour supprimer la configuration d'envoi 614 sur la base de données 101 : https://api.mindbaz.com/api/101/Configs/614

On obtient en retour:

{
  "data": true,
  "error": null,
  "success": true,
  "typeName": "Boolean"
}

Si la configuration était utilisée, on aurait le code retour suivant:

"code": "configIsProgrammed - Suppression de la config 613 impossible car utilisée dans une campagne programmée ou en cours d'envoi",
Attention

La configuration par défaut (id =1) ne peut pas être supprimée

Dupliquer une configuration d'envoi​

Après avoir créé une configuration d'envoi, il est possible de dupliquer celle-ci.

L'appel se fait en POST sur /api/{idSite}/Configs/{idConfig}/duplicate

info
  • Le nom de celle-ci sera modifié avec " - COPY" ajouté à la fin du nom.
  • Les informations de date seront mise à jour avec la date de la duplication
  • L'identifiant utilisateur sera celui à l'origine de la duplication