Envoyer un message

Post /messages/send

Paramètres :

Nom

Description

Type

Obligatoire

Tableau de destinataires

Nom	Description	Type	Obligatoire
address		String	Oui
personalName		String	Non

Array

Oui

msg

Nom

Description

Type

Obligatoire

from

Nom	Description	Type	Obligatoire
address		String	Oui
personalName		String	Non

Struct

Non

subject

String

Non

replyTo

Nom	Description	Type	Obligatoire
address		String	Oui
personalName		String	Non

Struct

Non

html

String

Non

text

String

Non

attachments

Nom	Description	Type	Obligatoire
content	Encodé en base 64	String	Non
filename		String	Non
type	Type Mime	String	Non

Array

Non

images

Nom	Description	Type	Obligatoire
contentType	Encodé en base 64	String	Non
filename		String	Non
type	Type Mime	String	Non
contentId	Id du contenu où placer l'image	String	Non

Array

Non

Struct

Oui

headers

Header au format JSON

Struct

Non

apiKey

Id de la clé API utilisée pour envoyer les emails. Si vide nous utilisons la clé servant à l'authentification.

String

Non

Réponse :

Nom	Description	Type
status	success / failure	String

PHP : Avec une librairie dédiée

Attention : le code PHP suivant nécessite d'installer la librairie Tipimail. Pour cela téléchargez d'abord 'Composer' et ensuite dans le répertoire où est enregistré votre script, exécutez dans votre Invite de commandes la ligne suivante : composer require tipimail/tipimail

Langage de programmation :

Exemple de requête :

{
    "to": [
        {
            "address":"to1@example.com",
            "personalName":"Nameto1"
        },
        {
            "address":"to2@example.com",
            "personalName":"Nameto2"
        }
    ],
    "msg": {
        "from": {
            "personalName": "Fromname",
            "address": "from@example.com"
        },
        "replyTo": {
            "personalName": "Replytoname",
            "address": "reply@example.com"
        },
        "subject": "Subject",
        "text": "Text content",
        "html": "<p>Html content</p>",
        "images": [
            {
                "contentType": "image/png",
                "filename": "IMAGECID",
                "content": "azerty"
            }
        ],
        "attachments": [
            {
                "contentType": "text/plain",
                "filename": "myfile.txt",
                "content": "azerty"
            }
        ],
    },
    "headers": {
        "X-TM-META":
        {
            "orderId": 123456789,
            "shipmentId": 123456789
        },
        "X-TM-SUB":
        [
            {
                "email":"email1@example.com",
                "values":
                {
                    "firstName": "Name1",
                    "uniqueId": 132456798
                }
            },
            {
                "email":"email2@example.com",
                "values":
                {
                    "subject": "mon mail numero 2",
                    "firstName": "Name2",
                    "meta":
                    {
                        "uniqueId": 987654321,
                        "orderId": 132456798,
                        "shipmentId": 1237498798
                    }
                }
            }
        ],
        "X-TM-TAGS": ["welcome", "website1"]
    }
}

Exemple de réponse :

{
    "status": "success"
}