Envoyer un message

Envoyer un message chiffré à un ou plusieurs destinataires. Chacun reçoit un lien unique.

Prérequis

Un client configuré et vos identifiants chargés : voir Identifiants et environnements.

Exemple

La méthode à appeler est MultiRecipientMessage. L'exemple complet et exécutable est dans Premier message en 5 minutes.

var args = new MutliRecipientArgs(
    endPointUri: endpoint, serial: serial, user: apiUser, psw: apiPassword,
    recipients: recipients, message: message, subject: subject,
    password: null, filesList: null,
    sendMode: SendMethodEnum.onlyEmail, getBackHtml: false,
    showSubject: true,   // obsolète, sans effet, mais exigé par le constructeur
    getNotify: true, cultureID: "fr-CA",
    maximumOpenTime: 5, minutesExpiration: 1440);

var response = MessageHelper.MultiRecipientMessage(args);

answer = MessageHelper.multi_recipient_message(
    api_client=client, sems_client=sems_client,
    serial=serial, api_user=api_user, api_password=api_password,
    recipients=[RecipientInfo(email="destinataire@example.com")],
    message=message, subject=subject,
    get_back_html=False, culture_id="fr-CA", maximum_open_time=5,
)

$answer = MessageHelper::multiRecipientMessage(
    apiClient: $client, semsClient: $sems,
    serial: $serial, apiUser: $apiUser, apiPassword: $apiPassword,
    recipients: [new RecipientInfo(email: 'destinataire@example.com')],
    message: $message, subject: $subject,
    getBackHtml: false, cultureId: 'fr-CA', maximumOpenTime: 5,
);

Options

Le constructeur de MutliRecipientArgs exige toutes ces valeurs, sauf createMessageCopy ; utilisez les arguments nommés pour garder le code lisible.

Option	Rôle
`recipients`	Destinataires : courriel, et téléphone pour les envois par SMS.
`message`, `subject`	Contenu (HTML permis) et sujet.
`password`	Mot de passe demandé à l'ouverture, ou null. Communiquez-le par un autre moyen que le courriel.
`sendMode`	Courriel seulement, SMS seulement, courriel avec code SMS, ou SMS avec code par courriel.
`getBackHtml`	false : Secure Exchanges envoie le courriel. true : le SDK vous renvoie le courriel en HTML, à envoyer vous-même.
`maximumOpenTime`	Nombre d'ouvertures permises, de 1 à 99.
`minutesExpiration`	Durée de validité du lien, en minutes.
`showSubject`	Obsolète, sans effet : le constructeur l'exige encore, mais sa valeur est ignorée.
`getNotify`	Vous avertit à l'ouverture du message.
`cultureID`	Langue du courriel et de la page de lecture, par exemple `fr-CA`.
`createMessageCopy`	Obsolète : n'est plus pris en charge. Seules certaines surcharges du constructeur l'acceptent : ne les utilisez pas.

Seuls recipients, message et subject sont obligatoires. Attention aux valeurs par défaut de getBackHtml et de maximumOpenTime : ce sont les deux causes les plus fréquentes de questions au soutien.

Option	Défaut	Rôle
`recipients`	obligatoire	Destinataires : courriel, et téléphone pour les envois par SMS.
`message`, `subject`	obligatoires	Contenu (HTML permis) et sujet.
`password`	aucun	Mot de passe demandé à l'ouverture. Communiquez-le par un autre moyen que le courriel.
`sendMode`	courriel seulement	Courriel seulement, SMS seulement, courriel avec code SMS, ou SMS avec code par courriel.
`getBackHtml`	true	false : Secure Exchanges envoie le courriel. true : le SDK vous renvoie le courriel en HTML, à envoyer vous-même.
`maximumOpenTime`	1	Nombre d'ouvertures permises, de 1 à 99.
`minutesExpiration`	10 080 (7 jours)	Durée de validité du lien, en minutes.
`showSubject`	aucun	Obsolète, sans effet : ne le passez pas. Le passer émet un avertissement.
`getNotify`	true	Vous avertit à l'ouverture du message.
`cultureID`	en-US	Langue du courriel et de la page de lecture, par exemple `fr-CA`.
`createMessageCopy`	false	Obsolète : n'est plus pris en charge.

Envoyer le courriel vous-même

Avec getBackHtml à true, Secure Exchanges n'envoie rien. Pour chaque destinataire, la réponse (RecipientsAnswer) contient de quoi envoyer le courriel vous-même :

Champ	Contenu
`HtmlMsg`	Le corps HTML du courriel, avec le lien du message : envoyez-le tel quel au destinataire.
`URL`	Le lien du message seul, si vous le transmettez autrement.
`DefaultOpeningCode`	Le code d'ouverture, rempli seulement si votre organisation impose un code d'ouverture inclus dans le courriel. Il figure déjà dans `HtmlMsg`.

foreach (var ra in response.RecipientsAnswer)
{
    if (ra.Answer?.Status != 200) continue;   // voir Plusieurs destinataires
    // Le HTML contient le lien du message : c'est un secret, ne le journalisez pas
    EnvoyerCourriel(ra.Recipient.Email, subject, ra.Answer.HtmlMsg);   // votre propre fonction d'envoi
}

for ra in answer.recipients_answer:
    if ra.answer and ra.answer.status == 200:
        # Le HTML contient le lien du message : c'est un secret, ne le journalisez pas
        envoyer_courriel(ra.recipient.email, subject, ra.answer.html_msg)  # votre propre fonction d'envoi

foreach ($answer->recipientsAnswer as $ra) {
    if ($ra->answer !== null && $ra->answer->status === 200) {
        // Le HTML contient le lien du message : c'est un secret, ne le journalisez pas
        envoyerCourriel($ra->recipient->email, $subject, $ra->answer->htmlMsg);   // votre propre fonction d'envoi
    }
}

Le lien et le code d'ouverture donnent accès au message : remettez-les au seul destinataire, et ne les copiez ni dans vos journaux ni dans un outil de suivi.

Erreurs fréquentes

Symptôme	Cause probable	Solution
Statut 401	Identifiants incorrects, ou identifiants de production utilisés en préproduction	Vérifiez les trois identifiants et l'environnement.
Statut 403	Licence invalide ou expirée	Voir Licence et quotas.
Statut 400	Paramètre invalide (courriel, taille de fichier)	Vérifiez les paramètres envoyés.
Statut 200, mais aucun courriel reçu	`getBackHtml` à true	Passez-le à false, ou envoyez vous-même `HtmlMsg` : voir Envoyer le courriel vous-même.
Le destinataire ne peut plus ouvrir le message	`maximumOpenTime` atteint	Augmentez le nombre d'ouvertures permises.