Définition de l'objet

Email

Mail

Les propriétés d'une fiche « Email », ses énumérations et ses liaisons avec les autres fiches.

48 propriétés 4 énumérations 12 liaisons

5 min de lecture Mise à jour le 11 novembre 2026

Une fiche « Email », telle que l'API la lit et l'écrit (Mail dans la référence). Sa liste et sa création : https://staging-api.docage.com/Mails ; une fiche : https://staging-api.docage.com/Mails/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.

11 fiches liées · survolez une fiche pour lire son nom et son rôle

Ses propriétés

BodyHtmltexte
Le corps de l'email en HTML. Pour un email au format MJML, le serveur le compose depuis le corps MJML (BodyMjml).
BodyMjmltexte
Corps en MJML
BodyStyleMailStyle
Charte de l'email : palette, largeur, police, et valeurs par défaut par type de bloc. Pendant de Form.DesktopStyle, sur le seul principe qui se transpose à la messagerie — choisir un rôle de palette plutôt qu'une couleur. Cf. MailStyle pour ce qui n'a PAS été repris.
BodyTexttexte
Le corps de l'email en texte. Quand le format du corps (BodyType) n'est pas « Texte », le serveur le dérive du corps HTML : envoyez alors BodyHtml.
BodyTypeMailBodyType
Le format du corps : texte, éditeur HTML (par défaut), code HTML, éditeur MJML ou code MJML.
ClickCountentierÉcrite par le serveur
Nombre de clics sur un lien
ConversationIdidentifiantÉcrite par le serveur
Identifiant de la conversation
CreationSubFormIdidentifiant
Identifiant du sous-formulaire de création
DefaultMailTypeDefaultMailType
Type d'email par défaut
DirectionMessageDirectionÉcrite par le serveur
Le sens de l'email : envoyé par l'organisation, ou reçu par l'un de ses comptes email — un email reçu est conservé, une fiche comme une autre, dont la conversation porte le message. Écrit par le serveur (à l'envoi, à la relève des comptes email), jamais par un corps de requête.
Fieldsliste de Field
Champs
FirstClickedDatedate et heure (UTC)Écrite par le serveur
Premier clic sur un lien
FirstOpenedDatedate et heure (UTC)Écrite par le serveur
Première ouverture
HeaderSendertexte
Expéditeur dans l'en-tête
Instancesliste de Mail
Instances d'email
IsMarketingoui ou non
Email commercial
IsTrackedoui ou non
Est suivi
LastClickedDatedate et heure (UTC)Écrite par le serveur
Dernier clic sur un lien
LastOpenedDatedate et heure (UTC)Écrite par le serveur
Dernière ouverture
MailFilesliste de MailFile
Fichiers d'email
MailInReplyTotexte, 450 caractères au plusÉcrite par le serveur
En réponse à
MailMessageIdtexte, 450 caractères au plusÉcrite par le serveur
Identifiant RFC
MailRecipientsliste de MailRecipient
Destinataires d'email
MailRecipientsBccliste de MailRecipient
Destinataires en copie cachée
MailRecipientsCcliste de MailRecipient
Destinataires en copie
MailRecipientsToliste de MailRecipient
Destinataires principaux
MailReferencestexteÉcrite par le serveur
Références
MailboxIdidentifiant
Identifiant du compte email
MainRecipientMailRecipient
Destinataire principal
MergeCalculatedFieldsoui ou non
Fusion des champs calculés
MergeDynamicFieldsoui ou non
Fusion des champs dynamiques
MergeFormatFieldsoui ou non
Fusion des champs formatés
OpenCountentierÉcrite par le serveur
Nombre d'ouvertures
PaymentIdidentifiant
Identifiant du paiement
PersonIdentityVerificationIdidentifiant
Identifiant de la vérification d'identité
PrivateToDocageUserIdidentifiantÉcrite par le serveur
Visible de ce seul utilisateur
ReceivedDatedate et heure (UTC)Écrite par le serveur
Date de réception
SenderDocageUser
Expéditeur
SenderIdidentifiant
Identifiant de l'expéditeur
SendingDatedate et heure (UTC)
La date d'envoi, écrite par le serveur au départ de l'email. La poser sur un brouillon ne programme pas l'envoi.
StatusMailStatusÉcrite par le serveur
Statut
StatusDatedate et heure (UTC)Écrite par le serveur
Date du statut
StatusDetailstexteÉcrite par le serveur
Détails du statut
Subjecttexte
Sujet
TemplateMail
Modèle d'email
TransactionActionIdidentifiant
Identifiant de l'action de parcours
TransactionIdidentifiant
Identifiant du parcours
TransferIdidentifiantÉcrite par le serveur
Identifiant du transfert
AddToBoxIdsliste d'identifiants
Identifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentier
Durée d'archivage en années
BoxIdsliste d'identifiantsLecture seule
Identifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveur
Date de création
CreationUserDocageUserÉcrite par le serveur
Créateur
CreationUserIdidentifiantÉcrite par le serveur
Identifiant du créateur
CultureInfotexte
Culture
CustomFieldsliste de Field
Les champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste de Field
Champs personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste de Field
Champs personnalisés de l'organisation
CustomFieldsFromTemplateliste de Field
Champs personnalisés du modèle
CustomFieldsUserDataliste de FieldUserData
Valeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveur
Date de suppression
DeletionUserDocageUserÉcrite par le serveur
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveur
Identifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusion
Si une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seule
Etat de l'entité
ExternalIdtexte, 128 caractères au plus
Identifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveur
Campagne ayant généré l'entité
GeneratedByFormIdidentifiant
Identifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveur
Identifiant
IsArchivedoui ou non
Archivé
IsSystemoui ou nonÉcrite par le serveur
Est système
IsTemplateoui ou nonLecture seule
Est un modèle
LanguageLanguage
Langue
LastModificationDatedate et heure (UTC)Écrite par le serveur
Date de modification
LastModificationUserDocageUserÉcrite par le serveur
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveur
Identifiant du dernier modificateur
MergeEntitiesliste de MergeEntity
Objets participant à la fusion
MergeFieldsliste de MergeField
Champs de fusion
MustBeArchivedoui ou non
Date de début d'archivage
Nametexte, 255 caractères au plus
Nom
Notestexte
Notes
ParentOrganizationIdidentifiantLecture seule
Organisation parente
ParentRightsDTOliste de RightDTO
Les nouveaux droits de la fiche, à sa création ou à sa mise à jour : la liste REMPLACE ses droits, elle doit donc contenir tous les nouveaux droits. Réservé à qui administre la fiche : pouvoir la modifier ne suffit pas.
RelationDefinitionsForInstancesliste de RelationDefinition
Les relations déclarées sur ce modèle : une extrémité est imposée (le modèle lui-même), et la relation ne vaut que pour ses instances — en plus de celles déclarées au niveau de l'organisation dont une extrémité est du même type. Elles se propagent comme CustomFieldsForInstances : une instance les lit dans RelationDefinitionsFromTemplate.
RelationDefinitionsFromTemplateliste de RelationDefinition
Les relations qu'une instance tient de son modèle. Elles ne sont pas recopiées : elles se relisent sur le modèle à chaque lecture. Ajouter une relation sur un modèle la fait donc apparaître sur toutes ses instances existantes, y compris celles créées avant, comme un champ personnalisé (CustomFieldsFromTemplate).
RemoveFromBoxIdsliste d'identifiants
Identifiants des classeurs à délier de l'entité
TemplateIdidentifiant
Identifiant de Modèle utilisé

Ses énumérations

`MailBodyType`

0Texte
1Éditeur HTML
2Code HTML
3Éditeur MJML
4Code MJML

`DefaultMailType`

0Aucun
1Invitation à faire une action (participant)
2Démarrage d'une action (participant)
3Finalisation d'une action (participant)
4Rappel à faire une action (participant)
5Démarrage du parcours (participant)
6Finalisation du parcours (participant)
7Parcours refusé (participant)
8Parcours annulé (participant)
9Parcours expiré (participant)
10Erreur dans le parcours (participant)
101Notification d'une invitation à faire une action (observateur)
102Notification du démarrage d'une action (observateur)
103Notification de la finalisation d'une action (observateur)
104Notification du rappel à faire une action (observateur)
105Notification du démarrage du parcours (observateur)
106Notification de la finalisation du parcours (observateur)
107Notification du refus du parcours (observateur)
108Notification de l'annulation du parcours (observateur)
109Notification de l'expiration du parcours (observateur)
110Notification d'erreur (observateur)
201Invitation à remplir un formulaire
202Notification de soumission de formulaire (observateur)
301Alerte d'échec d'une automatisation
400Invitation à un portail
401Nouveaux documents dans un portail
500Vérification d'une adresse email
501Transfert de fichiers (destinataire)
502Fichiers téléchargés (expéditeur)
503Transfert expiré (expéditeur)
504Secret ouvert (expéditeur)
505Secret détruit sans lecture (expéditeur)
510Webhook en panne (auteur et administrateurs)
520Connexion par l'authentification unique
521Bienvenue sous l'authentification unique
522Authentification unique exigée
523Authentification unique en échec (administrateurs)

`MessageDirection`

0Envoyé
1Reçu

`MailStatus`

-100Erreur
-8En attente du relais
-7Désabonné
-6Bloqué
-5Spam
-4Email invalide
-3Rejet définitif
-2Rejet temporaire
-1Différé
0Brouillon
1Programmé
2Envoyé
3Remis
4Ouvert
5Lien ouvert

Ses liaisons

Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans une liste (voir Lire des listes).