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.
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.
Ses propriétés
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 parPUT Mailboxes/{id}/UsePassword; un compte email de campagne naît en mode Amazon SES (POST CampaignMailboxes).CampaignCheckedAtUtcdate et heure (UTC)Écrite par le serveurDernière vérification du compte email de campagne
CampaignDailyLimitentierPlafond des campagnes sur 24 heures
CampaignDnsRecordsliste deBrandDnsRecordÉcrite par le serveurEnregistrements DNS du domaine de campagne
Pour un domaine de l'organisation : délégué à la plateforme, ou ses enregistrements posés par elle.
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 serveurZone DNS du domaine de campagne
CampaignIdentityArntexte, 300 caractères au plusÉcrite par le serveurIdentité SES du compte email de campagne
CampaignParentDomaintexte, 253 caractères au plusÉcrite par le serveurDomaine parent de campagne
CampaignProvisioningErrortexte, 1000 caractères au plusÉcrite par le serveurMotif de l'approvisionnement du compte email de campagne
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 serveurDomaine d'envoi de campagne
CampaignSubdomaintexte, 63 caractères au plusÉcrite par le serveurSous-domaine de campagne
CopyToSentFolderoui ou nonCopier les envois dans les éléments envoyés
CreatesTicketsoui ou nonOuvrir un ticket depuis ce compte email
ImapEncryptionMethodEncryptionMethodMéthode de chiffrement IMAP
ImapPortentierPort IMAP
ImapServertexteServeur IMAP
Instancesliste deMailboxInstances de compte email
IsInboundEnabledoui ou nonRelever le courrier entrant
IsMarketingoui ou nonSert aux campagnes
IsPersonaloui ou nonCompte personnel
IsTransactionaloui ou nonSert aux emails ordinaires et de parcours
MicrosoftApplicationIdtexte, 100 caractères au plusÉcrite par le serveurApplication Microsoft consentie
MicrosoftConsentDatedate et heure (UTC)Écrite par le serveurDate du consentement Microsoft
MicrosoftTenantIdtexteÉcrite par le serveurIdentifiant du locataire Microsoft
PasswordtexteObligatoireMot de passe
PersonalOwnerIdidentifiantÉcrite par le serveurTitulaire du compte personnel
PipelineIdidentifiantIdentifiant du pipeline des cartes
SendertexteNom d'expéditeur
SentFolderPathtexteDossier des éléments envoyés
SmtpPortentierObligatoirePort SMTP
SmtpServertexteObligatoireServeur SMTP
TemplateMailboxModèle de compte email
TicketPipelineIdidentifiantIdentifiant du pipeline des tickets
UserNametexteObligatoireNom d'utilisateur
AddToBoxIdsliste d'identifiantsIdentifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentierDurée d'archivage en années
BoxIdsliste d'identifiantsLecture seuleIdentifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveurDate de création
Créateur
CreationUserIdidentifiantÉcrite par le serveurIdentifiant du créateur
CultureInfotexteCulture
CustomFieldsliste deFieldLes champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste deFieldChamps personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste deFieldChamps personnalisés de l'organisation
CustomFieldsFromTemplateliste deFieldChamps personnalisés du modèle
CustomFieldsUserDataliste deFieldUserDataValeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveurDate de suppression
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveurIdentifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusionSi une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seuleEtat de l'entité
ExternalIdtexte, 128 caractères au plusIdentifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveurCampagne ayant généré l'entité
GeneratedByFormIdidentifiantIdentifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveurIdentifiant
IsArchivedoui ou nonArchivé
IsSystemoui ou nonÉcrite par le serveurEst système
IsTemplateoui ou nonLecture seuleEst un modèle
LanguageLanguageLangue
LastModificationDatedate et heure (UTC)Écrite par le serveurDate de modification
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveurIdentifiant du dernier modificateur
MergeEntitiesliste deMergeEntityObjets participant à la fusion
MergeFieldsliste deMergeFieldChamps de fusion
MustBeArchivedoui ou nonDate de début d'archivage
Nametexte, 255 caractères au plusNom
NotestexteNotes
ParentOrganizationIdidentifiantLecture seuleOrganisation parente
ParentRightsDTOliste deRightDTOLes 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 deRelationDefinitionLes 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 deRelationDefinitionLes 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'identifiantsIdentifiants des classeurs à délier de l'entité
TemplateIdidentifiantIdentifiant de Modèle utilisé
Aucune propriété ne correspond.
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).