Aller au contenu
Documentation

Définition de l'objet

Compte email

Mailbox

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

36 propriétés 5 énumérations 5 liaisons
4 min de lecture Mise à jour le 11 novembre 2026

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

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

Ses propriétés

  • AuthenticationModeMailboxAuthenticationModeÉcrite par le serveur

    Comment la plateforme s'authentifie auprès de la messagerie : mot de passe en SMTP et IMAP (Password, par défaut), Microsoft 365 ou Amazon SES (compte email de campagne). Écrit par le serveur seulement : le mode Microsoft 365 s'obtient par le consentement d'un administrateur du locataire Microsoft (GET Mailboxes/{id}/MicrosoftConsentUrl) et se quitte par PUT Mailboxes/{id}/UsePassword ; un compte email de campagne naît en mode Amazon SES (POST CampaignMailboxes).

  • CampaignCheckedAtUtcdate et heure (UTC)Écrite par le serveur

    Dernière vérification du compte email de campagne

  • CampaignDailyLimitentier

    Plafond des campagnes sur 24 heures

  • CampaignDnsRecordsliste de BrandDnsRecordÉcrite par le serveur

    Enregistrements DNS du domaine de campagne

  • CampaignDomainModeCampaignDomainModeÉcrite par le serveur

    Pour un domaine de l'organisation : délégué à la plateforme, ou ses enregistrements posés par elle.

  • CampaignDomainSourceCampaignDomainSourceÉcrite par le serveur

    D'où vient le domaine d'envoi : la plateforme, la marque de l'organisation, ou l'organisation elle-même.

  • CampaignHostedZoneIdtexte, 64 caractères au plusÉcrite par le serveur

    Zone DNS du domaine de campagne

  • CampaignIdentityArntexte, 300 caractères au plusÉcrite par le serveur

    Identité SES du compte email de campagne

  • CampaignParentDomaintexte, 253 caractères au plusÉcrite par le serveur

    Domaine parent de campagne

  • CampaignProvisioningErrortexte, 1000 caractères au plusÉcrite par le serveur

    Motif de l'approvisionnement du compte email de campagne

  • CampaignProvisioningStatusCampaignProvisioningStatusÉcrite par le serveur

    Où en est l'approvisionnement : rien ne part d'un compte email qui n'est pas prêt.

  • CampaignSendingDomaintexte, 253 caractères au plusÉcrite par le serveur

    Domaine d'envoi de campagne

  • CampaignSubdomaintexte, 63 caractères au plusÉcrite par le serveur

    Sous-domaine de campagne

  • CopyToSentFolderoui ou non

    Copier les envois dans les éléments envoyés

  • CreatesTicketsoui ou non

    Ouvrir un ticket depuis ce compte email

  • ImapEncryptionMethodEncryptionMethod

    Méthode de chiffrement IMAP

  • ImapPortentier

    Port IMAP

  • ImapServertexte

    Serveur IMAP

  • Instancesliste de Mailbox

    Instances de compte email

  • IsInboundEnabledoui ou non

    Relever le courrier entrant

  • IsMarketingoui ou non

    Sert aux campagnes

  • IsPersonaloui ou non

    Compte personnel

  • IsTransactionaloui ou non

    Sert aux emails ordinaires et de parcours

  • MicrosoftApplicationIdtexte, 100 caractères au plusÉcrite par le serveur

    Application Microsoft consentie

  • MicrosoftConsentDatedate et heure (UTC)Écrite par le serveur

    Date du consentement Microsoft

  • MicrosoftTenantIdtexteÉcrite par le serveur

    Identifiant du locataire Microsoft

  • PasswordtexteObligatoire

    Mot de passe

  • PersonalOwnerIdidentifiantÉcrite par le serveur

    Titulaire du compte personnel

  • PipelineIdidentifiant

    Identifiant du pipeline des cartes

  • Sendertexte

    Nom d'expéditeur

  • SentFolderPathtexte

    Dossier des éléments envoyés

  • SmtpPortentierObligatoire

    Port SMTP

  • SmtpServertexteObligatoire

    Serveur SMTP

  • TemplateMailbox

    Modèle de compte email

  • TicketPipelineIdidentifiant

    Identifiant du pipeline des tickets

  • UserNametexteObligatoire

    Nom d'utilisateur

Ses énumérations

MailboxAuthenticationMode

  • 0Mot de passe (SMTP / IMAP)
  • 1Microsoft 365
  • 2Compte email de campagne (Amazon SES)

CampaignDomainMode

  • 0Tenu par la plateforme
  • 1Délégué
  • 2Enregistrements à poser

CampaignDomainSource

  • 0Aucune
  • 1Domaine de la plateforme
  • 2Domaine de la marque
  • 3Domaine de l'organisation

CampaignProvisioningStatus

  • -100En erreur
  • 0Aucun
  • 1À déclarer
  • 2Enregistrements à poser
  • 3Enregistrements publiés
  • 4Signature vérifiée
  • 5Domaine de retour vérifié
  • 6Suivi prêt
  • 7Prêt

EncryptionMethod

  • 0Aucun
  • 1SSL/TLS
  • 2STARTTLS

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).